X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-common-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fcommon%2Fapi%2Fdata%2FAsyncWriteTransaction.java;h=725e364525a5acaf5681fe955569ffde5b3ba134;hb=aaea3e9a92ae9d6fac04c4a065db4b35cbca9ed0;hp=e47b54a0a1e6e138292530994a57b539501fc1bb;hpb=26cd54f2cbe0737db6e82aa96cd31671c6f6bf7e;p=controller.git diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java index e47b54a0a1..725e364525 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java @@ -7,12 +7,15 @@ */ package org.opendaylight.controller.md.sal.common.api.data; -import org.opendaylight.controller.md.sal.common.api.TransactionStatus; -import org.opendaylight.yangtools.concepts.Path; -import org.opendaylight.yangtools.yang.common.RpcResult; - import com.google.common.util.concurrent.CheckedFuture; +import com.google.common.util.concurrent.FluentFuture; import com.google.common.util.concurrent.ListenableFuture; +import com.google.common.util.concurrent.MoreExecutors; +import org.eclipse.jdt.annotation.NonNull; +import org.opendaylight.controller.md.sal.common.api.MappingCheckedFuture; +import org.opendaylight.mdsal.common.api.CommitInfo; +import org.opendaylight.yangtools.concepts.Path; +import org.opendaylight.yangtools.util.concurrent.ExceptionMapper; /** * Write transaction provides mutation capabilities for a data tree. @@ -21,11 +24,13 @@ import com.google.common.util.concurrent.ListenableFuture; * Initial state of write transaction is a stable snapshot of the current data tree. * The state is captured when the transaction is created and its state and underlying * data tree are not affected by other concurrently running transactions. + * *
* Write transactions are isolated from other concurrent write transactions. All * writes are local to the transaction and represent only a proposal of state * change for the data tree and it is not visible to any other concurrently running * transaction. + * *
* Applications make changes to the local data tree in the transaction by via the * put, merge, and delete operations. @@ -34,6 +39,7 @@ import com.google.common.util.concurrent.ListenableFuture; * Stores a piece of data at a specified path. This acts as an add / replace * operation, which is to say that whole subtree will be replaced by the * specified data. + * *
* Performing the following put operations: * @@ -42,6 +48,7 @@ import com.google.common.util.concurrent.ListenableFuture; * 2) container { list [ b ] } * * + *
* will result in the following data being present: * *
@@ -51,6 +58,7 @@ import com.google.common.util.concurrent.ListenableFuture; * Merges a piece of data with the existing data at a specified path. Any pre-existing data * which is not explicitly overwritten will be preserved. This means that if you store a container, * its child lists will be merged. + * ** + ** Performing the following merge operations: * @@ -59,25 +67,30 @@ import com.google.common.util.concurrent.ListenableFuture; * 2) container { list [ b ] } *
* will result in the following data being present: * *
* container { list [ a, b ] } ** + *
* This also means that storing the container will preserve any * augmentations which have been attached to it. * *
* After applying changes to the local data tree, applications publish the changes proposed in the * transaction by calling {@link #submit} on the transaction. This seals the transaction * (preventing any further writes using this transaction) and submits it to be * processed and applied to global conceptual data tree. + * *
* The transaction commit may fail due to a concurrent transaction modifying and committing data in * an incompatible way. See {@link #submit} for more concrete commit failure examples. + * *
* Implementation Note: This interface is not intended to be implemented
* by users of MD-SAL, but only to be consumed by them.
@@ -88,24 +101,24 @@ import com.google.common.util.concurrent.ListenableFuture;
* @param , D> extends AsyncTransaction {
/**
* Cancels the transaction.
*
- * Transactions can only be cancelled if it's status is
- * {@link TransactionStatus#NEW} or {@link TransactionStatus#SUBMITED}
+ *
+ * Transactions can only be cancelled if it's state is new or submitted.
*
- * Invoking cancel() on {@link TransactionStatus#FAILED} or
- * {@link TransactionStatus#CANCELED} will have no effect, and transaction
+ *
+ * Invoking cancel() on a failed or cancelled transaction will have no effect, and transaction
* is considered cancelled.
*
- * Invoking cancel() on finished transaction (future returned by {@link #submit()}
- * already completed with {@link TransactionStatus#COMMITED}) will always
+ *
+ * Invoking cancel() on a finished transaction (future returned by {@link #submit()} already completed will always
* fail (return false).
*
- * @return false if the task could not be cancelled,
- * typically because it has already completed normally;
- * true otherwise
+ * @return {@code false} if the task could not be cancelled, typically because it has already completed normally
+ * {@code true} otherwise
*
*/
boolean cancel();
@@ -119,54 +132,53 @@ public interface AsyncWriteTransaction , D> extends AsyncTransa
* @param path
* Data object path
* @throws IllegalStateException
- * if the transaction is no longer {@link TransactionStatus#NEW}
+ * if the transaction as already been submitted or cancelled
*/
void delete(LogicalDatastoreType store, P path);
/**
* Submits this transaction to be asynchronously applied to update the logical data tree.
* The returned CheckedFuture conveys the result of applying the data changes.
+ *
*
* Note: It is strongly recommended to process the CheckedFuture result in an asynchronous
* manner rather than using the blocking get() method. See example usage below.
+ *
*
* This call logically seals the transaction, which prevents the client from
* further changing data tree using this transaction. Any subsequent calls to
- * {@link #put(LogicalDatastoreType, Path, Object)},
- * {@link #merge(LogicalDatastoreType, Path, Object)} or
* {@link #delete(LogicalDatastoreType, Path)} will fail with
* {@link IllegalStateException}.
*
- * The transaction is marked as {@link TransactionStatus#SUBMITED} and
- * enqueued into the data store back-end for processing.
+ *
+ * The transaction is marked as submitted and enqueued into the data store back-end for processing.
*
*
* Whether or not the commit is successful is determined by versioning
* of the data tree and validation of registered commit participants
- * ({@link AsyncConfigurationCommitHandler})
- * if the transaction changes the data tree.
+ * ({@link AsyncConfigurationCommitHandler}) if the transaction changes the data tree.
+ *
*
- * The effects of a successful commit of data depends on data change listeners
- * ({@link AsyncDataChangeListener}) and commit participants
+ * The effects of a successful commit of data depends on data tree change listeners and commit participants
* ({@link AsyncConfigurationCommitHandler}) that are registered with the data broker.
- *
+ *
* , D> extends AsyncTransa
* doWrite( 2 );
*
* Transaction may fail because of multiple reasons, such as
* , D> extends AsyncTransa
*
*
* There are several sets of changes which could be considered incompatible
* between two transactions which are derived from same initial state.
* Rules for conflict detection applies recursively for each subtree
@@ -210,11 +224,13 @@ public interface AsyncWriteTransaction , D> extends AsyncTransa
*
*
* Following table shows state changes and failures between two concurrent transactions,
* which are based on same initial state, Tx 1 completes successfully
* before Tx 2 is submitted.
*
* , D> extends AsyncTransa
*
*
* Following table shows state changes and failures between two concurrent transactions,
* which are based on same initial state, Tx 1 completes successfully
* before Tx 2 is submitted.
*
* , D> extends AsyncTransa
* , D> extends AsyncTransa
*
*
* This example illustrates two concurrent transactions, which derived from
* same initial state of data tree and proposes conflicting modifications.
*
@@ -291,11 +317,13 @@ public interface AsyncWriteTransaction , D> extends AsyncTransa
* ListenebleFuture futureB = txB.submit(); // transaction B is sealed and submitted
*
*
+ *
* Commit of transaction A will be processed asynchronously and data tree
* will be updated to contain value
* Commit of Transaction B will fail, because previous transaction also
* modified path in a concurrent way. The state introduced by transaction B
* will not be applied. Returned {@link ListenableFuture} object will fail
@@ -309,14 +337,55 @@ public interface AsyncWriteTransaction , D> extends AsyncTransa
* derived from TransactionCommitFailedException.
*
* @throws IllegalStateException
- * if the transaction is not {@link TransactionStatus#NEW}
+ * if the transaction is not new
+ * @deprecated Use {@link #commit()} instead.
*/
- CheckedFuture
+ * This call logically seals the transaction, which prevents the client from further changing the data tree using
+ * this transaction. Any subsequent calls to
+ * Whether or not the commit is successful is determined by versioning of the data tree and validation of registered
+ * commit participants if the transaction changes the data tree.
+ *
+ *
+ * The effects of a successful commit of data depends on listeners and commit participants that are registered with
+ * the data broker.
+ *
+ *
+ * A successful commit produces implementation-specific {@link CommitInfo} structure, which is used to communicate
+ * post-condition information to the caller. Such information can contain commit-id, timing information or any
+ * other information the implementation wishes to share.
+ *
+ * @return a FluentFuture containing the result of the commit information. The Future blocks until the commit
+ * operation is complete. A successful commit returns nothing. On failure, the Future will fail with a
+ * {@link TransactionCommitFailedException} or an exception derived from TransactionCommitFailedException.
+ * @throws IllegalStateException if the transaction is already committed or was canceled.
*/
- @Deprecated
- ListenableFutureExample usage:
*
* private void doWrite( final int tries ) {
* WriteTransaction writeTx = dataBroker.newWriteOnlyTransaction();
*
* MyDataObject data = ...;
- * InstanceIdentifier
* Failure scenarios
+ *
*
@@ -203,6 +216,7 @@ public interface AsyncWriteTransaction
Change compatibility
*
+ * Change compatibility of leafs, leaf-list items
*
+ *
+ *
* Initial state Tx 1 Tx 2 Result
* Empty put(A,1) put(A,2) Tx 2 will fail, state is A=1
@@ -234,27 +250,34 @@ public interface AsyncWriteTransactionEmpty put(A,1) merge(A,2) A=2 Change compatibility of subtrees
*
+ *
+ *
@@ -277,6 +302,7 @@ public interface AsyncWriteTransaction
*
* Initial state Tx 1 Tx 2 Result
* Empty put(TOP,[]) put(TOP,[]) Tx 2 will fail, state is TOP=[]
*
- * Empty put(TOP,[]) merge(TOP,[]) TOP=[]
+ * Empty put(TOP,[FOO=1]) put(TOP,[BAR=1]) Tx 2 will fail, state is TOP=[FOO=1]
* Empty put(TOP,[FOO=1]) put(TOP,[BAR=1]) Tx 2 will fail, state is TOP=[FOO=1]
+ *
*
- * Empty put(TOP,[FOO=1]) merge(TOP,[BAR=1]) TOP=[FOO=1,BAR=1]
+ * Empty merge(TOP,[FOO=1]) put(TOP,[BAR=1]) Tx 2 will fail, state is TOP=[FOO=1]
* Empty merge(TOP,[FOO=1]) put(TOP,[BAR=1]) Tx 2 will fail, state is TOP=[FOO=1]
+ *
*
- * Empty merge(TOP,[FOO=1]) merge(TOP,[BAR=1]) TOP=[FOO=1,BAR=1]
+ * TOP=[] put(TOP,[FOO=1]) put(TOP,[BAR=1]) Tx 2 will fail, state is TOP=[FOO=1]
* TOP=[] put(TOP,[FOO=1]) put(TOP,[BAR=1]) Tx 2 will fail, state is TOP=[FOO=1]
+ *
- * TOP=[] put(TOP,[FOO=1]) merge(TOP,[BAR=1]) state is TOP=[FOO=1,BAR=1]
+ * TOP=[] merge(TOP,[FOO=1]) put(TOP,[BAR=1]) Tx 2 will fail, state is TOP=[FOO=1]
* TOP=[] merge(TOP,[FOO=1]) put(TOP,[BAR=1]) Tx 2 will fail, state is TOP=[FOO=1]
+ *
- * TOP=[] merge(TOP,[FOO=1]) merge(TOP,[BAR=1]) state is TOP=[FOO=1,BAR=1]
+ * TOP=[] delete(TOP) put(TOP,[BAR=1]) Tx 2 will fail, state is empty store
* TOP=[] delete(TOP) put(TOP,[BAR=1]) Tx 2 will fail, state is empty store
+ *
*
* TOP=[] delete(TOP) merge(TOP,[BAR=1]) state is TOP=[BAR=1]
@@ -262,12 +285,14 @@ public interface AsyncWriteTransactionTOP=[] put(TOP/FOO,1) put(TOP/BAR,1]) state is TOP=[FOO=1,BAR=1]
* TOP=[] merge(TOP/FOO,1) put(TOP/BAR,1) state is TOP=[FOO=1,BAR=1]
* TOP=[] merge(TOP/FOO,1) merge(TOP/BAR,1) state is TOP=[FOO=1,BAR=1]
- * TOP=[] delete(TOP) put(TOP/BAR,1) Tx 2 will fail, state is empty store
+ * TOP=[] delete(TOP) merge(TOP/BAR,1] Tx 2 will fail, state is empty store
*
* TOP=[] delete(TOP) merge(TOP/BAR,1] Tx 2 will fail, state is empty store
+ *
* TOP=[FOO=1] put(TOP/FOO,2) put(TOP/BAR,1) state is TOP=[FOO=2,BAR=1]
* TOP=[FOO=1] put(TOP/FOO,2) merge(TOP/BAR,1) state is TOP=[FOO=2,BAR=1]
- * TOP=[FOO=1] merge(TOP/FOO,2) put(TOP/BAR,1) state is TOP=[FOO=2,BAR=1]
+ * TOP=[FOO=1] merge(TOP/FOO,2) merge(TOP/BAR,1) state is TOP=[FOO=2,BAR=1]
* TOP=[FOO=1] merge(TOP/FOO,2) merge(TOP/BAR,1) state is TOP=[FOO=2,BAR=1]
+ *
* TOP=[FOO=1] delete(TOP/FOO) put(TOP/BAR,1) state is TOP=[BAR=1]
* TOP=[FOO=1] delete(TOP/FOO) merge(TOP/BAR,1] state is TOP=[BAR=1] Conflict of two transactions
*
+ * A
for PATH
.
* Returned {@link ListenableFuture} will successfully complete once
* state is applied to data tree.
*
+ * put(LogicalDatastoreType, Path, Object)
,
+ * merge(LogicalDatastoreType, Path, Object)
, delete(LogicalDatastoreType, Path)
will fail
+ * with {@link IllegalStateException}. The transaction is marked as submitted and enqueued into the data store
+ * back-end for processing.
+ *
+ *