org.opendaylight.controller.cluster.datastore

Class RemoteTransactionContext

java.lang.Object

org.opendaylight.controller.cluster.datastore.RemoteTransactionContext

public class RemoteTransactionContext
extends Object

Redirects front-end transaction operations to a shard for processing. Instances of this class are used when the destination shard is remote to the caller.

Author:

Thomas Pantelis

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteTransactionContext(TransactionIdentifier identifier, akka.actor.ActorSelection actor, ActorContext actorContext, short remoteTransactionVersion, OperationLimiter limiter)

Method Summary

Modifier and Type	Method and Description
void	closeTransaction()
scala.concurrent.Future<Object>	directCommit(Boolean havePermit)
void	executeModification(AbstractModification modification, Boolean havePermit)
<T> void	executeRead(AbstractRead<T> readCmd, com.google.common.util.concurrent.SettableFuture<T> returnFuture, Boolean havePermit)
protected ActorContext	getActorContext()
protected TransactionIdentifier	getIdentifier() Get the transaction identifier associated with this context.
short	getTransactionVersion()
protected void	incrementModificationCount()
protected boolean	isOperationHandOffComplete()
protected void	logModificationCount()
void	operationHandOffComplete() Invoked by TransactionContextWrapper when it has finished handing off operations to this context.
scala.concurrent.Future<akka.actor.ActorSelection>	readyTransaction(Boolean havePermit, Optional<SortedSet<String>> participatingShardNames)
protected scala.concurrent.Future<Object>	sendBatchedModifications()
protected scala.concurrent.Future<Object>	sendBatchedModifications(boolean ready, boolean doCommitOnReady, Optional<SortedSet<String>> participatingShardNames)
protected scala.concurrent.Future<akka.actor.ActorSelection>	transformReadyReply(scala.concurrent.Future<Object> readyReplyFuture)
boolean	usesOperationLimiting() A TransactionContext that uses operation limiting should return true else false.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteTransactionContext

protected RemoteTransactionContext(TransactionIdentifier identifier,
                                   akka.actor.ActorSelection actor,
                                   ActorContext actorContext,
                                   short remoteTransactionVersion,
                                   OperationLimiter limiter)

Method Detail

getActorContext

protected ActorContext getActorContext()

closeTransaction

public void closeTransaction()

directCommit

public scala.concurrent.Future<Object> directCommit(Boolean havePermit)

readyTransaction

public scala.concurrent.Future<akka.actor.ActorSelection> readyTransaction(Boolean havePermit,
                                                                           Optional<SortedSet<String>> participatingShardNames)

transformReadyReply

protected scala.concurrent.Future<akka.actor.ActorSelection> transformReadyReply(scala.concurrent.Future<Object> readyReplyFuture)

sendBatchedModifications

protected scala.concurrent.Future<Object> sendBatchedModifications()

sendBatchedModifications

protected scala.concurrent.Future<Object> sendBatchedModifications(boolean ready,
                                                                   boolean doCommitOnReady,
                                                                   Optional<SortedSet<String>> participatingShardNames)

executeModification

public void executeModification(AbstractModification modification,
                                Boolean havePermit)

executeRead

public <T> void executeRead(AbstractRead<T> readCmd,
                            com.google.common.util.concurrent.SettableFuture<T> returnFuture,
                            Boolean havePermit)

usesOperationLimiting

public boolean usesOperationLimiting()

A TransactionContext that uses operation limiting should return true else false.

Returns:

true if operation limiting is used, false otherwise

getIdentifier

@Nonnull
protected final TransactionIdentifier getIdentifier()

Get the transaction identifier associated with this context.

Returns:

Transaction identifier.

incrementModificationCount

protected final void incrementModificationCount()

logModificationCount

protected final void logModificationCount()

operationHandOffComplete

public final void operationHandOffComplete()

Invoked by TransactionContextWrapper when it has finished handing off operations to this context. From this point on, the context is responsible for throttling operations.

Implementations can rely on the wrapper calling this operation in a synchronized block, so they do not need to ensure visibility of this state transition themselves.

isOperationHandOffComplete

protected boolean isOperationHandOffComplete()

getTransactionVersion

public short getTransactionVersion()