opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.md.sal.common.api.data;
   9
  10 import com.google.common.util.concurrent.CheckedFuture;
  11 import com.google.common.util.concurrent.FluentFuture;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import com.google.common.util.concurrent.MoreExecutors;
  14 import javax.annotation.CheckReturnValue;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.mdsal.common.api.CommitInfo;
  17 import org.opendaylight.mdsal.common.api.MappingCheckedFuture;
  18 import org.opendaylight.yangtools.concepts.Path;
  19 import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
  20
  21 /**
  22  * Write transaction provides mutation capabilities for a data tree.
  23  *
  24  * <p>
  25  * Initial state of write transaction is a stable snapshot of the current data tree.
  26  * The state is captured when the transaction is created and its state and underlying
  27  * data tree are not affected by other concurrently running transactions.
  28  *
  29  * <p>
  30  * Write transactions are isolated from other concurrent write transactions. All
  31  * writes are local to the transaction and represent only a proposal of state
  32  * change for the data tree and it is not visible to any other concurrently running
  33  * transaction.
  34  *
  35  * <p>
  36  * Applications make changes to the local data tree in the transaction by via the
  37  * <b>put</b>, <b>merge</b>, and <b>delete</b> operations.
  38  *
  39  * <h2>Put operation</h2>
  40  * Stores a piece of data at a specified path. This acts as an add / replace
  41  * operation, which is to say that whole subtree will be replaced by the
  42  * specified data.
  43  *
  44  * <p>
  45  * Performing the following put operations:
  46  *
  47  * <pre>
  48  * 1) container { list [ a ] }
  49  * 2) container { list [ b ] }
  50  * </pre>
  51  *
  52  * <p>
  53  * will result in the following data being present:
  54  *
  55  * <pre>
  56  * container { list [ b ] }
  57  * </pre>
  58  * <h2>Merge operation</h2>
  59  * Merges a piece of data with the existing data at a specified path. Any pre-existing data
  60  * which is not explicitly overwritten will be preserved. This means that if you store a container,
  61  * its child lists will be merged.
  62  *
  63  * <p>
  64  * Performing the following merge operations:
  65  *
  66  * <pre>
  67  * 1) container { list [ a ] }
  68  * 2) container { list [ b ] }
  69  * </pre>
  70  *
  71  * <p>
  72  * will result in the following data being present:
  73  *
  74  * <pre>
  75  * container { list [ a, b ] }
  76  * </pre>
  77  *
  78  * <p>
  79  * This also means that storing the container will preserve any
  80  * augmentations which have been attached to it.
  81  *
  82  * <h2>Delete operation</h2>
  83  * Removes a piece of data from a specified path.
  84  *
  85  * <p>
  86  * After applying changes to the local data tree, applications publish the changes proposed in the
  87  * transaction by calling {@link #submit} on the transaction. This seals the transaction
  88  * (preventing any further writes using this transaction) and submits it to be
  89  * processed and applied to global conceptual data tree.
  90  *
  91  * <p>
  92  * The transaction commit may fail due to a concurrent transaction modifying and committing data in
  93  * an incompatible way. See {@link #submit} for more concrete commit failure examples.
  94  *
  95  * <p>
  96  * <b>Implementation Note:</b> This interface is not intended to be implemented
  97  * by users of MD-SAL, but only to be consumed by them.
  98  *
  99  * @param <P>
 100  *            Type of path (subtree identifier), which represents location in
 101  *            tree
 102  * @param <D>
 103  *            Type of data (payload), which represents data payload
 104  */
 105 public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransaction<P, D> {
 106     /**
 107      * Cancels the transaction.
 108      *
 109      * <p>
 110      * Transactions can only be cancelled if it's state is new or submitted.
 111      *
 112      * <p>
 113      * Invoking cancel() on a failed or cancelled transaction will have no effect, and transaction
 114      * is considered cancelled.
 115      *
 116      * <p>
 117      * Invoking cancel() on a finished transaction (future returned by {@link #submit()} already completed will always
 118      * fail (return false).
 119      *
 120      * @return <tt>false</tt> if the task could not be cancelled, typically because it has already completed normally
 121      * <tt>true</tt> otherwise
 122      *
 123      */
 124     boolean cancel();
 125
 126     /**
 127      * Removes a piece of data from specified path. This operation does not fail
 128      * if the specified path does not exist.
 129      *
 130      * @param store
 131      *            Logical data store which should be modified
 132      * @param path
 133      *            Data object path
 134      * @throws IllegalStateException
 135      *             if the transaction as already been submitted or cancelled
 136      */
 137     void delete(LogicalDatastoreType store, P path);
 138
 139     /**
 140      * Submits this transaction to be asynchronously applied to update the logical data tree.
 141      * The returned CheckedFuture conveys the result of applying the data changes.
 142      *
 143      * <p>
 144      * <b>Note:</b> It is strongly recommended to process the CheckedFuture result in an asynchronous
 145      * manner rather than using the blocking get() method. See example usage below.
 146      *
 147      * <p>
 148      * This call logically seals the transaction, which prevents the client from
 149      * further changing data tree using this transaction. Any subsequent calls to
 150      * {@link #delete(LogicalDatastoreType, Path)} will fail with
 151      * {@link IllegalStateException}.
 152      *
 153      * <p>
 154      * The transaction is marked as submitted and enqueued into the data store back-end for processing.
 155      *
 156      * <p>
 157      * Whether or not the commit is successful is determined by versioning
 158      * of the data tree and validation of registered commit participants
 159      * ({@link AsyncConfigurationCommitHandler}) if the transaction changes the data tree.
 160      *
 161      * <p>
 162      * The effects of a successful commit of data depends on data tree change listeners and commit participants
 163      * ({@link AsyncConfigurationCommitHandler}) that are registered with the data broker.
 164      *
 165      * <h3>Example usage:</h3>
 166      * <pre>
 167      *  private void doWrite( final int tries ) {
 168      *      WriteTransaction writeTx = dataBroker.newWriteOnlyTransaction();
 169      *
 170      *      MyDataObject data = ...;
 171      *      InstanceIdentifier&lt;MyDataObject&gt; path = ...;
 172      *      writeTx.put( LogicalDatastoreType.OPERATIONAL, path, data );
 173      *
 174      *      Futures.addCallback( writeTx.submit(), new FutureCallback&lt;Void&gt;() {
 175      *          public void onSuccess( Void result ) {
 176      *              // succeeded
 177      *          }
 178      *
 179      *          public void onFailure( Throwable t ) {
 180      *              if( t instanceof OptimisticLockFailedException ) {
 181      *                  if( ( tries - 1 ) &gt; 0 ) {
 182      *                      // do retry
 183      *                      doWrite( tries - 1 );
 184      *                  } else {
 185      *                      // out of retries
 186      *                  }
 187      *              } else {
 188      *                  // failed due to another type of TransactionCommitFailedException.
 189      *              }
 190      *          } );
 191      * }
 192      * ...
 193      * doWrite( 2 );
 194      * </pre>
 195      * <h2>Failure scenarios</h2>
 196      *
 197      * <p>
 198      * Transaction may fail because of multiple reasons, such as
 199      * <ul>
 200      * <li>Another transaction finished earlier and modified the same node in a
 201      * non-compatible way (see below). In this case the returned future will fail with an
 202      * {@link OptimisticLockFailedException}. It is the responsibility of the
 203      * caller to create a new transaction and submit the same modification again in
 204      * order to update data tree. <i><b>Warning</b>: In most cases, retrying after an
 205      * OptimisticLockFailedException will result in a high probability of success.
 206      * However, there are scenarios, albeit unusual, where any number of retries will
 207      * not succeed. Therefore it is strongly recommended to limit the number of retries (2 or 3)
 208      * to avoid an endless loop.</i>
 209      * </li>
 210      * <li>Data change introduced by this transaction did not pass validation by
 211      * commit handlers or data was incorrectly structured. Returned future will
 212      * fail with a {@link DataValidationFailedException}. User should not retry to
 213      * create new transaction with same data, since it probably will fail again.
 214      * </li>
 215      * </ul>
 216      *
 217      * <h3>Change compatibility</h3>
 218      *
 219      * <p>
 220      * There are several sets of changes which could be considered incompatible
 221      * between two transactions which are derived from same initial state.
 222      * Rules for conflict detection applies recursively for each subtree
 223      * level.
 224      *
 225      * <h4>Change compatibility of leafs, leaf-list items</h4>
 226      *
 227      * <p>
 228      * Following table shows  state changes and failures between two concurrent transactions,
 229      * which are based on same initial state, Tx 1 completes successfully
 230      * before Tx 2 is submitted.
 231      *
 232      * <table summary="">
 233      * <tr><th>Initial state</th><th>Tx 1</th><th>Tx 2</th><th>Result</th></tr>
 234      * <tr><td>Empty</td><td>put(A,1)</td><td>put(A,2)</td><td>Tx 2 will fail, state is A=1</td></tr>
 235      * <tr><td>Empty</td><td>put(A,1)</td><td>merge(A,2)</td><td>A=2</td></tr>
 236      *
 237      * <tr><td>Empty</td><td>merge(A,1)</td><td>put(A,2)</td><td>Tx 2 will fail, state is A=1</td></tr>
 238      * <tr><td>Empty</td><td>merge(A,1)</td><td>merge(A,2)</td><td>A=2</td></tr>
 239      *
 240      *
 241      * <tr><td>A=0</td><td>put(A,1)</td><td>put(A,2)</td><td>Tx 2 will fail, A=1</td></tr>
 242      * <tr><td>A=0</td><td>put(A,1)</td><td>merge(A,2)</td><td>A=2</td></tr>
 243      * <tr><td>A=0</td><td>merge(A,1)</td><td>put(A,2)</td><td>Tx 2 will fail, A=1</td></tr>
 244      * <tr><td>A=0</td><td>merge(A,1)</td><td>merge(A,2)</td><td>A=2</td></tr>
 245      *
 246      * <tr><td>A=0</td><td>delete(A)</td><td>put(A,2)</td><td>Tx 2 will fail, A does not exists</td></tr>
 247      * <tr><td>A=0</td><td>delete(A)</td><td>merge(A,2)</td><td>A=2</td></tr>
 248      * </table>
 249      *
 250      * <h4>Change compatibility of subtrees</h4>
 251      *
 252      * <p>
 253      * Following table shows  state changes and failures between two concurrent transactions,
 254      * which are based on same initial state, Tx 1 completes successfully
 255      * before Tx 2 is submitted.
 256      *
 257      * <table summary="">
 258      * <tr><th>Initial state</th><th>Tx 1</th><th>Tx 2</th><th>Result</th></tr>
 259      *
 260      * <tr><td>Empty</td><td>put(TOP,[])</td><td>put(TOP,[])</td><td>Tx 2 will fail, state is TOP=[]</td></tr>
 261      * <tr><td>Empty</td><td>put(TOP,[])</td><td>merge(TOP,[])</td><td>TOP=[]</td></tr>
 262      *
 263      * <tr><td>Empty</td><td>put(TOP,[FOO=1])</td><td>put(TOP,[BAR=1])</td><td>Tx 2 will fail, state is TOP=[FOO=1]
 264      * </td></tr>
 265      * <tr><td>Empty</td><td>put(TOP,[FOO=1])</td><td>merge(TOP,[BAR=1])</td><td>TOP=[FOO=1,BAR=1]</td></tr>
 266      *
 267      * <tr><td>Empty</td><td>merge(TOP,[FOO=1])</td><td>put(TOP,[BAR=1])</td><td>Tx 2 will fail, state is TOP=[FOO=1]
 268      * </td></tr>
 269      * <tr><td>Empty</td><td>merge(TOP,[FOO=1])</td><td>merge(TOP,[BAR=1])</td><td>TOP=[FOO=1,BAR=1]</td></tr>
 270      *
 271      * <tr><td>TOP=[]</td><td>put(TOP,[FOO=1])</td><td>put(TOP,[BAR=1])</td><td>Tx 2 will fail, state is TOP=[FOO=1]
 272      * </td></tr>
 273      * <tr><td>TOP=[]</td><td>put(TOP,[FOO=1])</td><td>merge(TOP,[BAR=1])</td><td>state is TOP=[FOO=1,BAR=1]</td></tr>
 274      * <tr><td>TOP=[]</td><td>merge(TOP,[FOO=1])</td><td>put(TOP,[BAR=1])</td><td>Tx 2 will fail, state is TOP=[FOO=1]
 275      * </td></tr>
 276      * <tr><td>TOP=[]</td><td>merge(TOP,[FOO=1])</td><td>merge(TOP,[BAR=1])</td><td>state is TOP=[FOO=1,BAR=1]</td></tr>
 277      * <tr><td>TOP=[]</td><td>delete(TOP)</td><td>put(TOP,[BAR=1])</td><td>Tx 2 will fail, state is empty store
 278      * </td></tr>
 279      * <tr><td>TOP=[]</td><td>delete(TOP)</td><td>merge(TOP,[BAR=1])</td><td>state is TOP=[BAR=1]</td></tr>
 280      *
 281      * <tr><td>TOP=[]</td><td>put(TOP/FOO,1)</td><td>put(TOP/BAR,1])</td><td>state is TOP=[FOO=1,BAR=1]</td></tr>
 282      * <tr><td>TOP=[]</td><td>put(TOP/FOO,1)</td><td>merge(TOP/BAR,1)</td><td>state is TOP=[FOO=1,BAR=1]</td></tr>
 283      * <tr><td>TOP=[]</td><td>merge(TOP/FOO,1)</td><td>put(TOP/BAR,1)</td><td>state is TOP=[FOO=1,BAR=1]</td></tr>
 284      * <tr><td>TOP=[]</td><td>merge(TOP/FOO,1)</td><td>merge(TOP/BAR,1)</td><td>state is TOP=[FOO=1,BAR=1]</td></tr>
 285      * <tr><td>TOP=[]</td><td>delete(TOP)</td><td>put(TOP/BAR,1)</td><td>Tx 2 will fail, state is empty store</td></tr>
 286      * <tr><td>TOP=[]</td><td>delete(TOP)</td><td>merge(TOP/BAR,1]</td><td>Tx 2 will fail, state is empty store
 287      * </td></tr>
 288      *
 289      * <tr><td>TOP=[FOO=1]</td><td>put(TOP/FOO,2)</td><td>put(TOP/BAR,1)</td><td>state is TOP=[FOO=2,BAR=1]</td></tr>
 290      * <tr><td>TOP=[FOO=1]</td><td>put(TOP/FOO,2)</td><td>merge(TOP/BAR,1)</td><td>state is TOP=[FOO=2,BAR=1]</td></tr>
 291      * <tr><td>TOP=[FOO=1]</td><td>merge(TOP/FOO,2)</td><td>put(TOP/BAR,1)</td><td>state is TOP=[FOO=2,BAR=1]</td></tr>
 292      * <tr><td>TOP=[FOO=1]</td><td>merge(TOP/FOO,2)</td><td>merge(TOP/BAR,1)</td><td>state is TOP=[FOO=2,BAR=1]
 293      * </td></tr>
 294      * <tr><td>TOP=[FOO=1]</td><td>delete(TOP/FOO)</td><td>put(TOP/BAR,1)</td><td>state is TOP=[BAR=1]</td></tr>
 295      * <tr><td>TOP=[FOO=1]</td><td>delete(TOP/FOO)</td><td>merge(TOP/BAR,1]</td><td>state is TOP=[BAR=1]</td></tr>
 296      * </table>
 297      *
 298      *
 299      * <h3>Examples of failure scenarios</h3>
 300      *
 301      * <h4>Conflict of two transactions</h4>
 302      *
 303      * <p>
 304      * This example illustrates two concurrent transactions, which derived from
 305      * same initial state of data tree and proposes conflicting modifications.
 306      *
 307      * <pre>
 308      * txA = broker.newWriteTransaction(); // allocates new transaction, data tree is empty
 309      * txB = broker.newWriteTransaction(); // allocates new transaction, data tree is empty
 310      *
 311      * txA.put(CONFIGURATION, PATH, A);    // writes to PATH value A
 312      * txB.put(CONFIGURATION, PATH, B)     // writes to PATH value B
 313      *
 314      * ListenableFuture futureA = txA.submit(); // transaction A is sealed and submitted
 315      * ListenebleFuture futureB = txB.submit(); // transaction B is sealed and submitted
 316      * </pre>
 317      *
 318      * <p>
 319      * Commit of transaction A will be processed asynchronously and data tree
 320      * will be updated to contain value <code>A</code> for <code>PATH</code>.
 321      * Returned {@link ListenableFuture} will successfully complete once
 322      * state is applied to data tree.
 323      *
 324      * <p>
 325      * Commit of Transaction B will fail, because previous transaction also
 326      * modified path in a concurrent way. The state introduced by transaction B
 327      * will not be applied. Returned {@link ListenableFuture} object will fail
 328      * with {@link OptimisticLockFailedException} exception, which indicates to
 329      * client that concurrent transaction prevented the submitted transaction from being
 330      * applied.
 331      * <br>
 332      * @return a CheckFuture containing the result of the commit. The Future blocks until the
 333      *         commit operation is complete. A successful commit returns nothing. On failure,
 334      *         the Future will fail with a {@link TransactionCommitFailedException} or an exception
 335      *         derived from TransactionCommitFailedException.
 336      *
 337      * @throws IllegalStateException
 338      *             if the transaction is not new
 339      * @deprecated Use {@link #commit()} instead.
 340      */
 341     @Deprecated
 342     @CheckReturnValue
 343     default CheckedFuture<Void, TransactionCommitFailedException> submit() {
 344         return MappingCheckedFuture.create(commit().transform(ignored -> null, MoreExecutors.directExecutor()),
 345                 SUBMIT_EXCEPTION_MAPPER);
 346     }
 347
 348     /**
 349      * Submits this transaction to be asynchronously applied to update the logical data tree. The returned
 350      * {@link FluentFuture} conveys the result of applying the data changes.
 351      *
 352      * <p>
 353      * This call logically seals the transaction, which prevents the client from further changing the data tree using
 354      * this transaction. Any subsequent calls to <code>put(LogicalDatastoreType, Path, Object)</code>,
 355      * <code>merge(LogicalDatastoreType, Path, Object)</code>, <code>delete(LogicalDatastoreType, Path)</code> will fail
 356      * with {@link IllegalStateException}. The transaction is marked as submitted and enqueued into the data store
 357      * back-end for processing.
 358      *
 359      * <p>
 360      * Whether or not the commit is successful is determined by versioning of the data tree and validation of registered
 361      * commit participants if the transaction changes the data tree.
 362      *
 363      * <p>
 364      * The effects of a successful commit of data depends on listeners and commit participants that are registered with
 365      * the data broker.
 366      *
 367      * <p>
 368      * A successful commit produces implementation-specific {@link CommitInfo} structure, which is used to communicate
 369      * post-condition information to the caller. Such information can contain commit-id, timing information or any
 370      * other information the implementation wishes to share.
 371      *
 372      * @return a FluentFuture containing the result of the commit information. The Future blocks until the commit
 373      *         operation is complete. A successful commit returns nothing. On failure, the Future will fail with a
 374      *         {@link TransactionCommitFailedException} or an exception derived from TransactionCommitFailedException.
 375      * @throws IllegalStateException if the transaction is already committed or was canceled.
 376      */
 377     @CheckReturnValue
 378     @NonNull FluentFuture<? extends @NonNull CommitInfo> commit();
 379
 380     /**
 381      * This only exists for reuse by the deprecated {@link #submit} method and is not intended for general use.
 382      */
 383     @Deprecated
 384     ExceptionMapper<TransactionCommitFailedException> SUBMIT_EXCEPTION_MAPPER =
 385         new ExceptionMapper<TransactionCommitFailedException>("submit", TransactionCommitFailedException.class) {
 386             @Override
 387             protected TransactionCommitFailedException newWithCause(String message, Throwable cause) {
 388                 return new TransactionCommitFailedException(message, cause);
 389             }
 390         };
 391 }