Fix modernization issues
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / entityownership / EntityOwnershipShardCommitCoordinator.java
index c792cf1dda996370b52002fa952b5689088d73df..eaca661619fad6c63d2a5339c997bd7fc26a171f 100644 (file)
@@ -7,16 +7,18 @@
  */
 package org.opendaylight.controller.cluster.datastore.entityownership;
 
+import static java.util.Objects.requireNonNull;
 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNER_QNAME;
 
 import akka.actor.ActorRef;
 import akka.actor.Cancellable;
 import akka.actor.Status.Failure;
-import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
 import java.util.Iterator;
 import java.util.LinkedList;
+import java.util.List;
 import java.util.Queue;
-import javax.annotation.Nullable;
+import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
 import org.opendaylight.controller.cluster.access.concepts.FrontendIdentifier;
 import org.opendaylight.controller.cluster.access.concepts.FrontendType;
@@ -54,21 +56,21 @@ class EntityOwnershipShardCommitCoordinator {
     private Cancellable retryCommitSchedule;
     private long transactionIDCounter = 0;
 
-    EntityOwnershipShardCommitCoordinator(MemberName localMemberName, Logger log) {
-        this.log = Preconditions.checkNotNull(log);
+    EntityOwnershipShardCommitCoordinator(final MemberName localMemberName, final Logger log) {
+        this.log = requireNonNull(log);
         historyId = new LocalHistoryIdentifier(
                 ClientIdentifier.create(FrontendIdentifier.create(localMemberName, FRONTEND_TYPE), 0), 0);
     }
 
-    boolean handleMessage(Object message, EntityOwnershipShard shard) {
+    boolean handleMessage(final Object message, final EntityOwnershipShard shard) {
         boolean handled = true;
-        if(CommitTransactionReply.isSerializedType(message)) {
+        if (CommitTransactionReply.isSerializedType(message)) {
             // Successful reply from a local commit.
             inflightCommitSucceeded(shard);
-        } else if(message instanceof akka.actor.Status.Failure) {
+        } else if (message instanceof akka.actor.Status.Failure) {
             // Failure reply from a local commit.
-            inflightCommitFailure(((Failure)message).cause(), shard);
-        } else if(COMMIT_RETRY_MESSAGE.equals(message)) {
+            inflightCommitFailure(((Failure) message).cause(), shard);
+        } else if (COMMIT_RETRY_MESSAGE.equals(message)) {
             retryInflightCommit(shard);
         } else {
             handled = false;
@@ -77,14 +79,14 @@ class EntityOwnershipShardCommitCoordinator {
         return handled;
     }
 
-    private void retryInflightCommit(EntityOwnershipShard shard) {
+    private void retryInflightCommit(final EntityOwnershipShard shard) {
         // Shouldn't be null happen but verify anyway
-        if(inflightCommit == null) {
+        if (inflightCommit == null) {
             return;
         }
 
-        if(shard.hasLeader()) {
-            log.debug("Retrying commit for BatchedModifications {}", inflightCommit.getTransactionID());
+        if (shard.hasLeader()) {
+            log.debug("Retrying commit for BatchedModifications {}", inflightCommit.getTransactionId());
 
             shard.tryCommitModifications(inflightCommit);
         } else {
@@ -92,15 +94,15 @@ class EntityOwnershipShardCommitCoordinator {
         }
     }
 
-    void inflightCommitFailure(Throwable cause, EntityOwnershipShard shard) {
+    void inflightCommitFailure(final Throwable cause, final EntityOwnershipShard shard) {
         // This should've originated from a failed inflight commit but verify anyway
-        if(inflightCommit == null) {
+        if (inflightCommit == null) {
             return;
         }
 
-        log.debug("Inflight BatchedModifications {} commit failed", inflightCommit.getTransactionID(), cause);
+        log.debug("Inflight BatchedModifications {} commit failed", inflightCommit.getTransactionId(), cause);
 
-        if(!(cause instanceof NoShardLeaderException)) {
+        if (!(cause instanceof NoShardLeaderException)) {
             // If the failure is other than NoShardLeaderException the commit may have been partially
             // processed so retry with a new transaction ID to be safe.
             newInflightCommitWithDifferentTransactionID();
@@ -109,90 +111,89 @@ class EntityOwnershipShardCommitCoordinator {
         scheduleInflightCommitRetry(shard);
     }
 
-    private void scheduleInflightCommitRetry(EntityOwnershipShard shard) {
+    private void scheduleInflightCommitRetry(final EntityOwnershipShard shard) {
         FiniteDuration duration = shard.getDatastoreContext().getShardRaftConfig().getElectionTimeOutInterval();
 
         log.debug("Scheduling retry for BatchedModifications commit {} in {}",
-                inflightCommit.getTransactionID(), duration);
+                inflightCommit.getTransactionId(), duration);
 
         retryCommitSchedule = shard.getContext().system().scheduler().scheduleOnce(duration, shard.getSelf(),
                 COMMIT_RETRY_MESSAGE, shard.getContext().dispatcher(), ActorRef.noSender());
     }
 
-    void inflightCommitSucceeded(EntityOwnershipShard shard) {
+    void inflightCommitSucceeded(final EntityOwnershipShard shard) {
         // Shouldn't be null but verify anyway
-        if(inflightCommit == null) {
+        if (inflightCommit == null) {
             return;
         }
 
-        if(retryCommitSchedule != null) {
+        if (retryCommitSchedule != null) {
             retryCommitSchedule.cancel();
         }
 
-        log.debug("BatchedModifications commit {} succeeded", inflightCommit.getTransactionID());
+        log.debug("BatchedModifications commit {} succeeded", inflightCommit.getTransactionId());
 
         inflightCommit = null;
         commitNextBatch(shard);
     }
 
-    void commitNextBatch(EntityOwnershipShard shard) {
-        if(inflightCommit != null || pendingModifications.isEmpty() || !shard.hasLeader()) {
+    void commitNextBatch(final EntityOwnershipShard shard) {
+        if (inflightCommit != null || pendingModifications.isEmpty() || !shard.hasLeader()) {
             return;
         }
 
         inflightCommit = newBatchedModifications();
         Iterator<Modification> iter = pendingModifications.iterator();
-        while(iter.hasNext()) {
+        while (iter.hasNext()) {
             inflightCommit.addModification(iter.next());
             iter.remove();
-            if(inflightCommit.getModifications().size() >=
-                    shard.getDatastoreContext().getShardBatchedModificationCount()) {
+            if (inflightCommit.getModifications().size()
+                    >= shard.getDatastoreContext().getShardBatchedModificationCount()) {
                 break;
             }
         }
 
-        log.debug("Committing next BatchedModifications {}, size {}", inflightCommit.getTransactionID(),
+        log.debug("Committing next BatchedModifications {}, size {}", inflightCommit.getTransactionId(),
                 inflightCommit.getModifications().size());
 
         shard.tryCommitModifications(inflightCommit);
     }
 
-    void commitModification(Modification modification, EntityOwnershipShard shard) {
-        BatchedModifications modifications = newBatchedModifications();
-        modifications.addModification(modification);
-        commitModifications(modifications, shard);
+    void commitModification(final Modification modification, final EntityOwnershipShard shard) {
+        commitModifications(ImmutableList.of(modification), shard);
     }
 
-    void commitModifications(BatchedModifications modifications, EntityOwnershipShard shard) {
-        if(modifications.getModifications().isEmpty()) {
+    void commitModifications(final List<Modification> modifications, final EntityOwnershipShard shard) {
+        if (modifications.isEmpty()) {
             return;
         }
 
         boolean hasLeader = shard.hasLeader();
-        if(inflightCommit != null || !hasLeader) {
-            if(log.isDebugEnabled()) {
+        if (inflightCommit != null || !hasLeader) {
+            if (log.isDebugEnabled()) {
                 log.debug("{} - adding modifications to pending",
                         inflightCommit != null ? "A commit is inflight" : "No shard leader");
             }
 
-            pendingModifications.addAll(modifications.getModifications());
+            pendingModifications.addAll(modifications);
         } else {
-            inflightCommit = modifications;
+            inflightCommit = newBatchedModifications();
+            inflightCommit.addModifications(modifications);
             shard.tryCommitModifications(inflightCommit);
         }
     }
 
-    void onStateChanged(EntityOwnershipShard shard, boolean isLeader) {
+    void onStateChanged(final EntityOwnershipShard shard, final boolean isLeader) {
         shard.possiblyRemoveAllInitialCandidates(shard.getLeader());
 
         possiblyPrunePendingCommits(shard, isLeader);
 
-        if(!isLeader && inflightCommit != null) {
+        if (!isLeader && inflightCommit != null) {
             // We're no longer the leader but we have an inflight local commit. This likely means we didn't get
             // consensus for the commit and switched to follower due to another node with a higher term. We
             // can't be sure if the commit was replicated to any node so we retry it here with a new
             // transaction ID.
-            if(retryCommitSchedule != null) {
+            if (retryCommitSchedule != null) {
                 retryCommitSchedule.cancel();
             }
 
@@ -203,7 +204,7 @@ class EntityOwnershipShardCommitCoordinator {
         }
     }
 
-    private void possiblyPrunePendingCommits(EntityOwnershipShard shard, boolean isLeader) {
+    private void possiblyPrunePendingCommits(final EntityOwnershipShard shard, final boolean isLeader) {
         // If we were the leader and transitioned to follower, we'll try to forward pending commits to the new leader.
         // However certain commits, e.g. entity owner changes, should only be committed by a valid leader as the
         // criteria used to determine the commit may be stale. Since we're no longer a valid leader, we should not
@@ -216,29 +217,25 @@ class EntityOwnershipShardCommitCoordinator {
             shard.convertPendingTransactionsToMessages();
 
             // Prune the inflightCommit.
-            if(inflightCommit != null) {
+            if (inflightCommit != null) {
                 inflightCommit = pruneModifications(inflightCommit);
             }
 
             // Prune the subsequent pending modifications.
-            Iterator<Modification> iter = pendingModifications.iterator();
-            while(iter.hasNext()) {
-                Modification mod = iter.next();
-                if(!canForwardModificationToNewLeader(mod)) {
-                    iter.remove();
-                }
-            }
+            pendingModifications.removeIf(mod -> !canForwardModificationToNewLeader(mod));
         }
     }
 
-    @Nullable
-    private BatchedModifications pruneModifications(BatchedModifications toPrune) {
-        BatchedModifications prunedModifications = new BatchedModifications(toPrune.getTransactionID(), toPrune.getVersion());
+    private @Nullable BatchedModifications pruneModifications(final BatchedModifications toPrune) {
+        BatchedModifications prunedModifications = new BatchedModifications(toPrune.getTransactionId(),
+                toPrune.getVersion());
         prunedModifications.setDoCommitOnReady(toPrune.isDoCommitOnReady());
-        prunedModifications.setReady(toPrune.isReady());
+        if (toPrune.isReady()) {
+            prunedModifications.setReady(toPrune.getParticipatingShardNames());
+        }
         prunedModifications.setTotalMessagesSent(toPrune.getTotalMessagesSent());
-        for(Modification mod: toPrune.getModifications()) {
-            if(canForwardModificationToNewLeader(mod)) {
+        for (Modification mod: toPrune.getModifications()) {
+            if (canForwardModificationToNewLeader(mod)) {
                 prunedModifications.addModification(mod);
             }
         }
@@ -246,7 +243,7 @@ class EntityOwnershipShardCommitCoordinator {
         return !prunedModifications.getModifications().isEmpty() ? prunedModifications : null;
     }
 
-    private boolean canForwardModificationToNewLeader(Modification mod) {
+    private boolean canForwardModificationToNewLeader(final Modification mod) {
         // If this is a WRITE of entity owner we don't want to forward it to a new leader since the criteria used
         // to determine the new owner might be stale.
         if (mod instanceof WriteModification) {
@@ -265,15 +262,15 @@ class EntityOwnershipShardCommitCoordinator {
 
     private void newInflightCommitWithDifferentTransactionID() {
         BatchedModifications newBatchedModifications = newBatchedModifications();
-        newBatchedModifications.getModifications().addAll(inflightCommit.getModifications());
+        newBatchedModifications.addModifications(inflightCommit.getModifications());
         inflightCommit = newBatchedModifications;
     }
 
-    BatchedModifications newBatchedModifications() {
+    private BatchedModifications newBatchedModifications() {
         BatchedModifications modifications = new BatchedModifications(
             new TransactionIdentifier(historyId, ++transactionIDCounter), DataStoreVersions.CURRENT_VERSION);
         modifications.setDoCommitOnReady(true);
-        modifications.setReady(true);
+        modifications.setReady();
         modifications.setTotalMessagesSent(1);
         return modifications;
     }