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=70789ccb1481c36e8179999d341a0bdddecd47b8;hb=refs%2Fchanges%2F11%2F80211%2F6;hp=f12cb88a18860d3fed150d255687b73e115fde82;hpb=2e4ffc89f2d46950dbfdd8259f817ae4c336e3ef;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 f12cb88a18..70789ccb14 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 @@ -8,10 +8,14 @@ package org.opendaylight.controller.md.sal.common.api.data; import com.google.common.util.concurrent.CheckedFuture; +import com.google.common.util.concurrent.FluentFuture; import com.google.common.util.concurrent.ListenableFuture; -import org.opendaylight.controller.md.sal.common.api.TransactionStatus; +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.yang.common.RpcResult; +import org.opendaylight.yangtools.util.concurrent.ExceptionMapper; /** * Write transaction provides mutation capabilities for a data tree. @@ -102,17 +106,14 @@ public interface AsyncWriteTransaction
, D> extends AsyncTransa * 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 @@ -130,7 +131,7 @@ 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); @@ -149,8 +150,7 @@ public interface AsyncWriteTransaction
, D> extends AsyncTransa * {@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 @@ -158,8 +158,7 @@ public interface AsyncWriteTransaction
, D> extends AsyncTransa * ({@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
* 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.
*
- * @deprecated Use {@link #submit()} instead.
+ *
+ * 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
- ListenableFutureput(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.
+ *
+ *