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=cc22bb91ad401a20bfdd06bdc6fd753422df546b;hb=a81d98f692b80c45bce3fe6a87e731abfb012a9f;hp=9aaa77ca61f1c5f16df1650a696899d90c96e5f5;hpb=4386d86231d7c6b84a8a70795ef43b178c0b9996;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 9aaa77ca61..cc22bb91ad 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 @@ -27,15 +27,57 @@ import com.google.common.util.concurrent.ListenableFuture; * change for the data tree and it is not visible to any other concurrently running * transaction. *
- * Applications publish the changes proposed in the transaction by calling {@link #commit} - * on the transaction. This seals the transaction + * Applications make changes to the local data tree in the transaction by via the + * put, merge, and delete operations. + * + *
+ * Performing the following put operations: + * + *
+ * 1) container { list [ a ] } + * 2) container { list [ b ] } + *+ * + * will result in the following data being present: + * + *
+ * container { list [ b ] } + *+ *
+ * Performing the following merge operations: + * + *
+ * 1) container { list [ a ] } + * 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 #commit()} for more concrete commit failure examples. - * - * + * 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. @@ -57,7 +99,7 @@ public interface AsyncWriteTransaction
, D> extends AsyncTransa * {@link TransactionStatus#CANCELED} will have no effect, and transaction * is considered cancelled. * - * Invoking cancel() on finished transaction (future returned by {@link #commit()} + * Invoking cancel() on finished transaction (future returned by {@link #submit()} * already completed with {@link TransactionStatus#COMMITED}) will always * fail (return false). * @@ -69,74 +111,7 @@ public interface AsyncWriteTransaction
, D> extends AsyncTransa boolean cancel(); /** - * Store a piece of data at specified path. This acts as an add / replace - * operation, which is to say that whole subtree will be replaced by - * specified path. Performing the following put operations: - * - *
- * 1) container { list [ a ] } - * 2) container { list [ b ] } - *- * - * will result in the following data being present: - * - *
- * container { list [ b ] } - *- * - * - * If you need to make sure that a parent object exists, but you do not want modify - * its preexisting state by using put, consider using - * {@link #merge(LogicalDatastoreType, Path, Object)} - * - * @param store - * Logical data store which should be modified - * @param path - * Data object path - * @param data - * Data object to be written to specified path - * @throws IllegalStateException - * if the transaction is no longer {@link TransactionStatus#NEW} - */ - void put(LogicalDatastoreType store, P path, D data); - - /** - * Store a piece of data at the specified path. This acts as a merge operation, - * which is to say that 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: - * - *
- * 1) container { list [ a ] } - * 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. - *
- * If you require an explicit replace operation, use - * {@link #put(LogicalDatastoreType, Path, Object)} instead. - * - * @param store - * Logical data store which should be modified - * @param path - * Data object path - * @param data - * Data object to be written to specified path - * @throws IllegalStateException - * if the transaction is no longer {@link TransactionStatus#NEW} - */ - void merge(LogicalDatastoreType store, P path, D data); - - /** - * Remove a piece of data from specified path. This operation does not fail + * Removes a piece of data from specified path. This operation does not fail * if the specified path does not exist. * * @param store @@ -157,8 +132,6 @@ public interface AsyncWriteTransaction
, D> extends AsyncTransa *
* 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}. * @@ -174,24 +147,24 @@ public interface AsyncWriteTransaction
, D> extends AsyncTransa * The effects of a successful commit of data depends on data change listeners * ({@link AsyncDataChangeListener}) and commit participants * ({@link AsyncConfigurationCommitHandler}) that are registered with the data broker. - *
+ * *
* private void doWrite( final int tries ) { * WriteTransaction writeTx = dataBroker.newWriteOnlyTransaction(); * * MyDataObject data = ...; - * InstanceIdentifierpath = ...; + * InstanceIdentifier<MyDataObject> path = ...; * writeTx.put( LogicalDatastoreType.OPERATIONAL, path, data ); * - * Futures.addCallback( writeTx.commit(), new FutureCallback () { + * Futures.addCallback( writeTx.submit(), new FutureCallback<Void>() { * public void onSuccess( Void result ) { * // succeeded * } * * public void onFailure( Throwable t ) { * if( t instanceof OptimisticLockFailedException ) { - * if( ( tries - 1 ) > 0 ) { + * if( ( tries - 1 ) < 0 ) { * // do retry * doWrite( tries - 1 ); * } else { @@ -239,7 +212,7 @@ public interface AsyncWriteTransaction , D> extends AsyncTransa * which are based on same initial state, Tx 1 completes successfully * before Tx 2 is submitted. * - *
+ *
*
* Initial state Tx 1 Tx 2 Result * Empty put(A,1) put(A,2) Tx 2 will fail, state is A=1 @@ -263,7 +236,7 @@ public interface AsyncWriteTransaction Empty put(A,1) merge(A,2) A=2 , D> extends AsyncTransa * which are based on same initial state, Tx 1 completes successfully * before Tx 2 is submitted. * - *
+ *
*
* * Initial state Tx 1 Tx 2 Result @@ -312,8 +285,8 @@ public interface AsyncWriteTransaction Empty put(TOP,[]) put(TOP,[]) Tx 2 will fail, state is TOP=[] , D> extends AsyncTransa * txA.put(CONFIGURATION, PATH, A); // writes to PATH value A * txB.put(CONFIGURATION, PATH, B) // writes to PATH value B * - * ListenableFuture futureA = txA.commit(); // transaction A is sealed and committed - * ListenebleFuture futureB = txB.commit(); // transaction B is sealed and committed + * ListenableFuture futureA = txA.submit(); // transaction A is sealed and submitted + * ListenebleFuture futureB = txB.submit(); // transaction B is sealed and submitted * * * Commit of transaction A will be processed asynchronously and data tree