Refactor TransactionContext.executeModification()
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / TransactionContext.java
index 1b8e65e02d6d1bad037a02beaa77310088b6e67d..fe36661e671032d82caf8579967efa92e84b9513 100644 (file)
@@ -8,9 +8,10 @@
 package org.opendaylight.controller.cluster.datastore;
 
 import akka.actor.ActorSelection;
-import com.google.common.base.Optional;
 import com.google.common.util.concurrent.SettableFuture;
-import java.util.List;
+import java.util.Optional;
+import java.util.SortedSet;
+import org.opendaylight.controller.cluster.datastore.messages.AbstractRead;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import scala.concurrent.Future;
@@ -22,17 +23,35 @@ import scala.concurrent.Future;
 interface TransactionContext {
     void closeTransaction();
 
-    Future<ActorSelection> readyTransaction();
+    Future<ActorSelection> readyTransaction(Boolean havePermit, Optional<SortedSet<String>> participatingShardNames);
 
-    void writeData(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
+    <T> void executeRead(AbstractRead<T> readCmd, SettableFuture<T> promise, Boolean havePermit);
 
-    void deleteData(YangInstanceIdentifier path);
+    void executeDelete(YangInstanceIdentifier path, Boolean havePermit);
 
-    void mergeData(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
+    void executeMerge(YangInstanceIdentifier path, NormalizedNode<?, ?> data, Boolean havePermit);
 
-    void readData(final YangInstanceIdentifier path, SettableFuture<Optional<NormalizedNode<?, ?>>> proxyFuture);
+    void executeWrite(YangInstanceIdentifier path, NormalizedNode<?, ?> data, Boolean havePermit);
 
-    void dataExists(YangInstanceIdentifier path, SettableFuture<Boolean> proxyFuture);
+    Future<Object> directCommit(Boolean havePermit);
 
-    List<Future<Object>> getRecordedOperationFutures();
+    /**
+     * Invoked by {@link TransactionContextWrapper} when it has finished handing
+     * off operations to this context. From this point on, the context is responsible
+     * for throttling operations.
+     *
+     * <p>
+     * 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.
+     */
+    void operationHandOffComplete();
+
+    /**
+     * A TransactionContext that uses operation limiting should return true else false.
+     *
+     * @return true if operation limiting is used, false otherwise
+     */
+    boolean usesOperationLimiting();
+
+    short getTransactionVersion();
 }