X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FShardCommitCoordinator.java;h=53f27061ae527404730d97224ae15651ea803b97;hp=8b95404c4e6bdd06e2f4bb9d234eeab4465dd81f;hb=340a2d4c979ac6f8d5adff8bd9e1c9f724e7a164;hpb=4b207b5356775c4b4d231ae979f9f2134f617dd1 diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardCommitCoordinator.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardCommitCoordinator.java index 8b95404c4e..53f27061ae 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardCommitCoordinator.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardCommitCoordinator.java @@ -9,16 +9,27 @@ package org.opendaylight.controller.cluster.datastore; import akka.actor.ActorRef; import akka.actor.Status; -import com.google.common.cache.Cache; -import com.google.common.cache.CacheBuilder; +import akka.serialization.Serialization; +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import com.google.common.base.Stopwatch; +import java.util.HashMap; +import java.util.Iterator; import java.util.LinkedList; +import java.util.Map; import java.util.Queue; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeUnit; -import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransaction; +import org.opendaylight.controller.cluster.datastore.compat.BackwardsCompatibleThreePhaseCommitCohort; +import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications; +import org.opendaylight.controller.cluster.datastore.messages.BatchedModificationsReply; import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransactionReply; +import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction; +import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction; +import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply; import org.opendaylight.controller.cluster.datastore.modification.Modification; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort; +import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification; +import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; import org.slf4j.Logger; /** @@ -26,130 +37,372 @@ import org.slf4j.Logger; * * @author Thomas Pantelis */ -public class ShardCommitCoordinator { +class ShardCommitCoordinator { - private final Cache cohortCache; + // Interface hook for unit tests to replace or decorate the DOMStoreThreePhaseCommitCohorts. + public interface CohortDecorator { + ShardDataTreeCohort decorate(String transactionID, ShardDataTreeCohort actual); + } + + private final Map cohortCache = new HashMap<>(); private CohortEntry currentCohortEntry; - private final Queue queuedCohortEntries; + private final ShardDataTree dataTree; + + // We use a LinkedList here to avoid synchronization overhead with concurrent queue impls + // since this should only be accessed on the shard's dispatcher. + private final Queue queuedCohortEntries = new LinkedList<>(); - private final int queueCapacity; + private int queueCapacity; private final Logger log; private final String name; - public ShardCommitCoordinator(long cacheExpiryTimeoutInSec, int queueCapacity, Logger log, - String name) { - cohortCache = CacheBuilder.newBuilder().expireAfterAccess( - cacheExpiryTimeoutInSec, TimeUnit.SECONDS).build(); + private final long cacheExpiryTimeoutInMillis; + + // This is a hook for unit tests to replace or decorate the DOMStoreThreePhaseCommitCohorts. + private CohortDecorator cohortDecorator; + + private ReadyTransactionReply readyTransactionReply; + + ShardCommitCoordinator(ShardDataTree dataTree, + long cacheExpiryTimeoutInMillis, int queueCapacity, ActorRef shardActor, Logger log, String name) { this.queueCapacity = queueCapacity; this.log = log; this.name = name; + this.dataTree = Preconditions.checkNotNull(dataTree); + this.cacheExpiryTimeoutInMillis = cacheExpiryTimeoutInMillis; + } + + void setQueueCapacity(int queueCapacity) { + this.queueCapacity = queueCapacity; + } - // We use a LinkedList here to avoid synchronization overhead with concurrent queue impls - // since this should only be accessed on the shard's dispatcher. - queuedCohortEntries = new LinkedList<>(); + private ReadyTransactionReply readyTransactionReply(Shard shard) { + if(readyTransactionReply == null) { + readyTransactionReply = new ReadyTransactionReply(Serialization.serializedActorPath(shard.self())); + } + + return readyTransactionReply; + } + + private boolean queueCohortEntry(CohortEntry cohortEntry, ActorRef sender, Shard shard) { + if(queuedCohortEntries.size() < queueCapacity) { + queuedCohortEntries.offer(cohortEntry); + return true; + } else { + cohortCache.remove(cohortEntry.getTransactionID()); + + RuntimeException ex = new RuntimeException( + String.format("%s: Could not enqueue transaction %s - the maximum commit queue"+ + " capacity %d has been reached.", + name, cohortEntry.getTransactionID(), queueCapacity)); + log.error(ex.getMessage()); + sender.tell(new Status.Failure(ex), shard.self()); + return false; + } } /** - * This method caches a cohort entry for the given transactions ID in preparation for the - * subsequent 3-phase commit. + * This method is called to ready a transaction that was prepared by ShardTransaction actor. It caches + * the prepared cohort entry for the given transactions ID in preparation for the subsequent 3-phase commit. * - * @param transactionID the ID of the transaction - * @param cohort the cohort to participate in the transaction commit - * @param modification the modification made by the transaction + * @param ready the ForwardedReadyTransaction message to process + * @param sender the sender of the message + * @param shard the transaction's shard actor */ - public void transactionReady(String transactionID, DOMStoreThreePhaseCommitCohort cohort, - Modification modification) { + void handleForwardedReadyTransaction(ForwardedReadyTransaction ready, ActorRef sender, Shard shard) { + log.debug("{}: Readying transaction {}, client version {}", name, + ready.getTransactionID(), ready.getTxnClientVersion()); - cohortCache.put(transactionID, new CohortEntry(transactionID, cohort, modification)); + CohortEntry cohortEntry = new CohortEntry(ready.getTransactionID(), ready.getCohort(), + (MutableCompositeModification) ready.getModification()); + cohortCache.put(ready.getTransactionID(), cohortEntry); + + if(!queueCohortEntry(cohortEntry, sender, shard)) { + return; + } + + if(ready.getTxnClientVersion() < DataStoreVersions.LITHIUM_VERSION) { + // Return our actor path as we'll handle the three phase commit except if the Tx client + // version < Helium-1 version which means the Tx was initiated by a base Helium version node. + // In that case, the subsequent 3-phase commit messages won't contain the transactionId so to + // maintain backwards compatibility, we create a separate cohort actor to provide the compatible behavior. + ActorRef replyActorPath = shard.self(); + if(ready.getTxnClientVersion() < DataStoreVersions.HELIUM_1_VERSION) { + log.debug("{}: Creating BackwardsCompatibleThreePhaseCommitCohort", name); + replyActorPath = shard.getContext().actorOf(BackwardsCompatibleThreePhaseCommitCohort.props( + ready.getTransactionID())); + } + + ReadyTransactionReply readyTransactionReply = + new ReadyTransactionReply(Serialization.serializedActorPath(replyActorPath), + ready.getTxnClientVersion()); + sender.tell(ready.isReturnSerialized() ? readyTransactionReply.toSerializable() : + readyTransactionReply, shard.self()); + } else { + if(ready.isDoImmediateCommit()) { + cohortEntry.setDoImmediateCommit(true); + cohortEntry.setReplySender(sender); + cohortEntry.setShard(shard); + handleCanCommit(cohortEntry); + } else { + // The caller does not want immediate commit - the 3-phase commit will be coordinated by the + // front-end so send back a ReadyTransactionReply with our actor path. + sender.tell(readyTransactionReply(shard), shard.self()); + } + } } /** - * This method handles the canCommit phase for a transaction. + * This method handles a BatchedModifications message for a transaction being prepared directly on the + * Shard actor instead of via a ShardTransaction actor. If there's no currently cached + * DOMStoreWriteTransaction, one is created. The batched modifications are applied to the write Tx. If + * the BatchedModifications is ready to commit then a DOMStoreThreePhaseCommitCohort is created. * - * @param canCommit the CanCommitTransaction message - * @param sender the actor that sent the message + * @param batched the BatchedModifications message to process + * @param sender the sender of the message * @param shard the transaction's shard actor */ - public void handleCanCommit(CanCommitTransaction canCommit, final ActorRef sender, - final ActorRef shard) { - String transactionID = canCommit.getTransactionID(); + void handleBatchedModifications(BatchedModifications batched, ActorRef sender, Shard shard) { + CohortEntry cohortEntry = cohortCache.get(batched.getTransactionID()); + if(cohortEntry == null) { + cohortEntry = new CohortEntry(batched.getTransactionID(), + dataTree.newReadWriteTransaction(batched.getTransactionID(), + batched.getTransactionChainID())); + cohortCache.put(batched.getTransactionID(), cohortEntry); + } + if(log.isDebugEnabled()) { - log.debug("{}: Processing canCommit for transaction {} for shard {}", - name, transactionID, shard.path()); + log.debug("{}: Applying {} batched modifications for Tx {}", name, + batched.getModifications().size(), batched.getTransactionID()); } + cohortEntry.applyModifications(batched.getModifications()); + + if(batched.isReady()) { + if(cohortEntry.getLastBatchedModificationsException() != null) { + cohortCache.remove(cohortEntry.getTransactionID()); + throw cohortEntry.getLastBatchedModificationsException(); + } + + if(cohortEntry.getTotalBatchedModificationsReceived() != batched.getTotalMessagesSent()) { + cohortCache.remove(cohortEntry.getTransactionID()); + throw new IllegalStateException(String.format( + "The total number of batched messages received %d does not match the number sent %d", + cohortEntry.getTotalBatchedModificationsReceived(), batched.getTotalMessagesSent())); + } + + if(!queueCohortEntry(cohortEntry, sender, shard)) { + return; + } + + if(log.isDebugEnabled()) { + log.debug("{}: Readying Tx {}, client version {}", name, + batched.getTransactionID(), batched.getVersion()); + } + + cohortEntry.ready(cohortDecorator, batched.isDoCommitOnReady()); + + if(batched.isDoCommitOnReady()) { + cohortEntry.setReplySender(sender); + cohortEntry.setShard(shard); + handleCanCommit(cohortEntry); + } else { + sender.tell(readyTransactionReply(shard), shard.self()); + } + } else { + sender.tell(new BatchedModificationsReply(batched.getModifications().size()), shard.self()); + } + } + + /** + * This method handles {@link ReadyLocalTransaction} message. All transaction modifications have + * been prepared beforehand by the sender and we just need to drive them through into the dataTree. + * + * @param message the ReadyLocalTransaction message to process + * @param sender the sender of the message + * @param shard the transaction's shard actor + */ + void handleReadyLocalTransaction(ReadyLocalTransaction message, ActorRef sender, Shard shard) { + final ShardDataTreeCohort cohort = new SimpleShardDataTreeCohort(dataTree, message.getModification(), + message.getTransactionID()); + final CohortEntry cohortEntry = new CohortEntry(message.getTransactionID(), cohort); + cohortCache.put(message.getTransactionID(), cohortEntry); + cohortEntry.setDoImmediateCommit(message.isDoCommitOnReady()); + + if(!queueCohortEntry(cohortEntry, sender, shard)) { + return; + } + + log.debug("{}: Applying local modifications for Tx {}", name, message.getTransactionID()); + + if (message.isDoCommitOnReady()) { + cohortEntry.setReplySender(sender); + cohortEntry.setShard(shard); + handleCanCommit(cohortEntry); + } else { + sender.tell(readyTransactionReply(shard), shard.self()); + } + } + + private void handleCanCommit(CohortEntry cohortEntry) { + String transactionID = cohortEntry.getTransactionID(); + + cohortEntry.updateLastAccessTime(); + + if(currentCohortEntry != null) { + // There's already a Tx commit in progress so we can't process this entry yet - but it's in the + // queue and will get processed after all prior entries complete. + + if(log.isDebugEnabled()) { + log.debug("{}: Commit for Tx {} already in progress - skipping canCommit for {} for now", + name, currentCohortEntry.getTransactionID(), transactionID); + } + + return; + } + + // No Tx commit currently in progress - check if this entry is the next one in the queue, If so make + // it the current entry and proceed with canCommit. + // Purposely checking reference equality here. + if(queuedCohortEntries.peek() == cohortEntry) { + currentCohortEntry = queuedCohortEntries.poll(); + doCanCommit(currentCohortEntry); + } else { + if(log.isDebugEnabled()) { + log.debug("{}: Tx {} is the next pending canCommit - skipping {} for now", + name, queuedCohortEntries.peek().getTransactionID(), transactionID); + } + } + } + + /** + * This method handles the canCommit phase for a transaction. + * + * @param transactionID the ID of the transaction to canCommit + * @param sender the actor to which to send the response + * @param shard the transaction's shard actor + */ + void handleCanCommit(String transactionID, final ActorRef sender, final Shard shard) { // Lookup the cohort entry that was cached previously (or should have been) by // transactionReady (via the ForwardedReadyTransaction message). - final CohortEntry cohortEntry = cohortCache.getIfPresent(transactionID); + final CohortEntry cohortEntry = cohortCache.get(transactionID); if(cohortEntry == null) { // Either canCommit was invoked before ready(shouldn't happen) or a long time passed // between canCommit and ready and the entry was expired from the cache. IllegalStateException ex = new IllegalStateException( String.format("%s: No cohort entry found for transaction %s", name, transactionID)); log.error(ex.getMessage()); - sender.tell(new Status.Failure(ex), shard); + sender.tell(new Status.Failure(ex), shard.self()); return; } - cohortEntry.setCanCommitSender(sender); + cohortEntry.setReplySender(sender); cohortEntry.setShard(shard); - if(currentCohortEntry != null) { - // There's already a Tx commit in progress - attempt to queue this entry to be - // committed after the current Tx completes. - log.debug("{}: Transaction {} is already in progress - queueing transaction {}", - name, currentCohortEntry.getTransactionID(), transactionID); + handleCanCommit(cohortEntry); + } + + private void doCanCommit(final CohortEntry cohortEntry) { + boolean canCommit = false; + try { + // We block on the future here so we don't have to worry about possibly accessing our + // state on a different thread outside of our dispatcher. Also, the data store + // currently uses a same thread executor anyway. + canCommit = cohortEntry.getCohort().canCommit().get(); + + log.debug("{}: canCommit for {}: {}", name, cohortEntry.getTransactionID(), canCommit); - if(queuedCohortEntries.size() < queueCapacity) { - queuedCohortEntries.offer(cohortEntry); + if(cohortEntry.isDoImmediateCommit()) { + if(canCommit) { + doCommit(cohortEntry); + } else { + cohortEntry.getReplySender().tell(new Status.Failure(new TransactionCommitFailedException( + "Can Commit failed, no detailed cause available.")), cohortEntry.getShard().self()); + } } else { - removeCohortEntry(transactionID); - - RuntimeException ex = new RuntimeException( - String.format("%s: Could not enqueue transaction %s - the maximum commit queue"+ - " capacity %d has been reached.", - name, transactionID, queueCapacity)); - log.error(ex.getMessage()); - sender.tell(new Status.Failure(ex), shard); + cohortEntry.getReplySender().tell( + canCommit ? CanCommitTransactionReply.YES.toSerializable() : + CanCommitTransactionReply.NO.toSerializable(), cohortEntry.getShard().self()); + } + } catch (Exception e) { + log.debug("{}: An exception occurred during canCommit", name, e); + + Throwable failure = e; + if(e instanceof ExecutionException) { + failure = e.getCause(); } - } else { - // No Tx commit currently in progress - make this the current entry and proceed with - // canCommit. - cohortEntry.updateLastAccessTime(); - currentCohortEntry = cohortEntry; - doCanCommit(cohortEntry); + cohortEntry.getReplySender().tell(new Status.Failure(failure), cohortEntry.getShard().self()); + } finally { + if(!canCommit) { + // Remove the entry from the cache now. + currentTransactionComplete(cohortEntry.getTransactionID(), true); + } } } - private void doCanCommit(final CohortEntry cohortEntry) { + private boolean doCommit(CohortEntry cohortEntry) { + log.debug("{}: Committing transaction {}", name, cohortEntry.getTransactionID()); + + boolean success = false; + + // We perform the preCommit phase here atomically with the commit phase. This is an + // optimization to eliminate the overhead of an extra preCommit message. We lose front-end + // coordination of preCommit across shards in case of failure but preCommit should not + // normally fail since we ensure only one concurrent 3-phase commit. try { // We block on the future here so we don't have to worry about possibly accessing our // state on a different thread outside of our dispatcher. Also, the data store // currently uses a same thread executor anyway. - Boolean canCommit = cohortEntry.getCohort().canCommit().get(); + cohortEntry.getCohort().preCommit().get(); - cohortEntry.getCanCommitSender().tell( - canCommit ? CanCommitTransactionReply.YES.toSerializable() : - CanCommitTransactionReply.NO.toSerializable(), cohortEntry.getShard()); + cohortEntry.getShard().continueCommit(cohortEntry); - if(!canCommit) { - // Remove the entry from the cache now since the Tx will be aborted. - removeCohortEntry(cohortEntry.getTransactionID()); - } - } catch (InterruptedException | ExecutionException e) { - log.debug("{}: An exception occurred during canCommit: {}", name, e); + cohortEntry.updateLastAccessTime(); + + success = true; + } catch (Exception e) { + log.error("{} An exception occurred while preCommitting transaction {}", + name, cohortEntry.getTransactionID(), e); + cohortEntry.getReplySender().tell(new akka.actor.Status.Failure(e), cohortEntry.getShard().self()); - // Remove the entry from the cache now since the Tx will be aborted. - removeCohortEntry(cohortEntry.getTransactionID()); - cohortEntry.getCanCommitSender().tell(new Status.Failure(e), cohortEntry.getShard()); + currentTransactionComplete(cohortEntry.getTransactionID(), true); } + + return success; + } + + /** + * This method handles the preCommit and commit phases for a transaction. + * + * @param transactionID the ID of the transaction to commit + * @param sender the actor to which to send the response + * @param shard the transaction's shard actor + * @return true if the transaction was successfully prepared, false otherwise. + */ + boolean handleCommit(final String transactionID, final ActorRef sender, final Shard shard) { + // Get the current in-progress cohort entry in the commitCoordinator if it corresponds to + // this transaction. + final CohortEntry cohortEntry = getCohortEntryIfCurrent(transactionID); + if(cohortEntry == null) { + // We're not the current Tx - the Tx was likely expired b/c it took too long in + // between the canCommit and commit messages. + IllegalStateException ex = new IllegalStateException( + String.format("%s: Cannot commit transaction %s - it is not the current transaction", + name, transactionID)); + log.error(ex.getMessage()); + sender.tell(new akka.actor.Status.Failure(ex), shard.self()); + return false; + } + + cohortEntry.setReplySender(sender); + return doCommit(cohortEntry); } /** @@ -173,13 +426,7 @@ public class ShardCommitCoordinator { } public CohortEntry getAndRemoveCohortEntry(String transactionID) { - CohortEntry cohortEntry = cohortCache.getIfPresent(transactionID); - cohortCache.invalidate(transactionID); - return cohortEntry; - } - - public void removeCohortEntry(String transactionID) { - cohortCache.invalidate(transactionID); + return cohortCache.remove(transactionID); } public boolean isCurrentTransaction(String transactionID) { @@ -198,68 +445,173 @@ public class ShardCommitCoordinator { */ public void currentTransactionComplete(String transactionID, boolean removeCohortEntry) { if(removeCohortEntry) { - removeCohortEntry(transactionID); + cohortCache.remove(transactionID); } if(isCurrentTransaction(transactionID)) { - // Dequeue the next cohort entry waiting in the queue. - currentCohortEntry = queuedCohortEntries.poll(); - if(currentCohortEntry != null) { - currentCohortEntry.updateLastAccessTime(); - doCanCommit(currentCohortEntry); + currentCohortEntry = null; + + log.debug("{}: currentTransactionComplete: {}", name, transactionID); + + maybeProcessNextCohortEntry(); + } + } + + private void maybeProcessNextCohortEntry() { + // Check if there's a next cohort entry waiting in the queue and if it is ready to commit. Also + // clean out expired entries. + Iterator iter = queuedCohortEntries.iterator(); + while(iter.hasNext()) { + CohortEntry next = iter.next(); + if(next.isReadyToCommit()) { + if(currentCohortEntry == null) { + if(log.isDebugEnabled()) { + log.debug("{}: Next entry to canCommit {}", name, next); + } + + iter.remove(); + currentCohortEntry = next; + currentCohortEntry.updateLastAccessTime(); + doCanCommit(currentCohortEntry); + } + + break; + } else if(next.isExpired(cacheExpiryTimeoutInMillis)) { + log.warn("{}: canCommit for transaction {} was not received within {} ms - entry removed from cache", + name, next.getTransactionID(), cacheExpiryTimeoutInMillis); + + iter.remove(); + cohortCache.remove(next.getTransactionID()); + } else { + break; } } } + void cleanupExpiredCohortEntries() { + maybeProcessNextCohortEntry(); + } + + @VisibleForTesting + void setCohortDecorator(CohortDecorator cohortDecorator) { + this.cohortDecorator = cohortDecorator; + } + static class CohortEntry { private final String transactionID; - private final DOMStoreThreePhaseCommitCohort cohort; - private final Modification modification; - private ActorRef canCommitSender; - private ActorRef shard; - private long lastAccessTime; - - CohortEntry(String transactionID, DOMStoreThreePhaseCommitCohort cohort, - Modification modification) { + private ShardDataTreeCohort cohort; + private final ReadWriteShardDataTreeTransaction transaction; + private RuntimeException lastBatchedModificationsException; + private ActorRef replySender; + private Shard shard; + private boolean doImmediateCommit; + private final Stopwatch lastAccessTimer = Stopwatch.createStarted(); + private int totalBatchedModificationsReceived; + + CohortEntry(String transactionID, ReadWriteShardDataTreeTransaction transaction) { + this.transaction = Preconditions.checkNotNull(transaction); + this.transactionID = transactionID; + } + + CohortEntry(String transactionID, ShardDataTreeCohort cohort, + MutableCompositeModification compositeModification) { this.transactionID = transactionID; this.cohort = cohort; - this.modification = modification; + this.transaction = null; } - void updateLastAccessTime() { - lastAccessTime = System.currentTimeMillis(); + CohortEntry(String transactionID, ShardDataTreeCohort cohort) { + this.transactionID = transactionID; + this.cohort = cohort; + this.transaction = null; } - long getLastAccessTime() { - return lastAccessTime; + void updateLastAccessTime() { + lastAccessTimer.reset(); + lastAccessTimer.start(); } String getTransactionID() { return transactionID; } - DOMStoreThreePhaseCommitCohort getCohort() { + ShardDataTreeCohort getCohort() { return cohort; } - Modification getModification() { - return modification; + int getTotalBatchedModificationsReceived() { + return totalBatchedModificationsReceived; } - ActorRef getCanCommitSender() { - return canCommitSender; + RuntimeException getLastBatchedModificationsException() { + return lastBatchedModificationsException; } - void setCanCommitSender(ActorRef canCommitSender) { - this.canCommitSender = canCommitSender; + void applyModifications(Iterable modifications) { + totalBatchedModificationsReceived++; + if(lastBatchedModificationsException == null) { + for (Modification modification : modifications) { + try { + modification.apply(transaction.getSnapshot()); + } catch (RuntimeException e) { + lastBatchedModificationsException = e; + throw e; + } + } + } } - ActorRef getShard() { + void ready(CohortDecorator cohortDecorator, boolean doImmediateCommit) { + Preconditions.checkState(cohort == null, "cohort was already set"); + + setDoImmediateCommit(doImmediateCommit); + + cohort = transaction.ready(); + + if(cohortDecorator != null) { + // Call the hook for unit tests. + cohort = cohortDecorator.decorate(transactionID, cohort); + } + } + + boolean isReadyToCommit() { + return replySender != null; + } + + boolean isExpired(long expireTimeInMillis) { + return lastAccessTimer.elapsed(TimeUnit.MILLISECONDS) >= expireTimeInMillis; + } + + boolean isDoImmediateCommit() { + return doImmediateCommit; + } + + void setDoImmediateCommit(boolean doImmediateCommit) { + this.doImmediateCommit = doImmediateCommit; + } + + ActorRef getReplySender() { + return replySender; + } + + void setReplySender(ActorRef replySender) { + this.replySender = replySender; + } + + Shard getShard() { return shard; } - void setShard(ActorRef shard) { + void setShard(Shard shard) { this.shard = shard; } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append("CohortEntry [transactionID=").append(transactionID).append(", doImmediateCommit=") + .append(doImmediateCommit).append("]"); + return builder.toString(); + } } }