2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.md.sal.common.api.data;
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;
22 * Write transaction provides mutation capabilities for a data tree.
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.
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
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.
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
45 * Performing the following put operations:
48 * 1) container { list [ a ] }
49 * 2) container { list [ b ] }
53 * will result in the following data being present:
56 * container { list [ b ] }
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.
64 * Performing the following merge operations:
67 * 1) container { list [ a ] }
68 * 2) container { list [ b ] }
72 * will result in the following data being present:
75 * container { list [ a, b ] }
79 * This also means that storing the container will preserve any
80 * augmentations which have been attached to it.
82 * <h2>Delete operation</h2>
83 * Removes a piece of data from a specified path.
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.
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.
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.
100 * Type of path (subtree identifier), which represents location in
103 * Type of data (payload), which represents data payload
105 public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransaction<P, D> {
107 * Cancels the transaction.
110 * Transactions can only be cancelled if it's state is new or submitted.
113 * Invoking cancel() on a failed or cancelled transaction will have no effect, and transaction
114 * is considered cancelled.
117 * Invoking cancel() on a finished transaction (future returned by {@link #submit()} already completed will always
118 * fail (return false).
120 * @return <tt>false</tt> if the task could not be cancelled, typically because it has already completed normally
121 * <tt>true</tt> otherwise
127 * Removes a piece of data from specified path. This operation does not fail
128 * if the specified path does not exist.
131 * Logical data store which should be modified
134 * @throws IllegalStateException
135 * if the transaction as already been submitted or cancelled
137 void delete(LogicalDatastoreType store, P path);
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.
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.
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}.
154 * The transaction is marked as submitted and enqueued into the data store back-end for processing.
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.
162 * The effects of a successful commit of data depends on data change listeners
163 * ({@link AsyncDataChangeListener}) and commit participants
164 * ({@link AsyncConfigurationCommitHandler}) that are registered with the data broker.
166 * <h3>Example usage:</h3>
168 * private void doWrite( final int tries ) {
169 * WriteTransaction writeTx = dataBroker.newWriteOnlyTransaction();
171 * MyDataObject data = ...;
172 * InstanceIdentifier<MyDataObject> path = ...;
173 * writeTx.put( LogicalDatastoreType.OPERATIONAL, path, data );
175 * Futures.addCallback( writeTx.submit(), new FutureCallback<Void>() {
176 * public void onSuccess( Void result ) {
180 * public void onFailure( Throwable t ) {
181 * if( t instanceof OptimisticLockFailedException ) {
182 * if( ( tries - 1 ) > 0 ) {
184 * doWrite( tries - 1 );
189 * // failed due to another type of TransactionCommitFailedException.
196 * <h2>Failure scenarios</h2>
199 * Transaction may fail because of multiple reasons, such as
201 * <li>Another transaction finished earlier and modified the same node in a
202 * non-compatible way (see below). In this case the returned future will fail with an
203 * {@link OptimisticLockFailedException}. It is the responsibility of the
204 * caller to create a new transaction and submit the same modification again in
205 * order to update data tree. <i><b>Warning</b>: In most cases, retrying after an
206 * OptimisticLockFailedException will result in a high probability of success.
207 * However, there are scenarios, albeit unusual, where any number of retries will
208 * not succeed. Therefore it is strongly recommended to limit the number of retries (2 or 3)
209 * to avoid an endless loop.</i>
211 * <li>Data change introduced by this transaction did not pass validation by
212 * commit handlers or data was incorrectly structured. Returned future will
213 * fail with a {@link DataValidationFailedException}. User should not retry to
214 * create new transaction with same data, since it probably will fail again.
218 * <h3>Change compatibility</h3>
221 * There are several sets of changes which could be considered incompatible
222 * between two transactions which are derived from same initial state.
223 * Rules for conflict detection applies recursively for each subtree
226 * <h4>Change compatibility of leafs, leaf-list items</h4>
229 * Following table shows state changes and failures between two concurrent transactions,
230 * which are based on same initial state, Tx 1 completes successfully
231 * before Tx 2 is submitted.
234 * <tr><th>Initial state</th><th>Tx 1</th><th>Tx 2</th><th>Result</th></tr>
235 * <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>
236 * <tr><td>Empty</td><td>put(A,1)</td><td>merge(A,2)</td><td>A=2</td></tr>
238 * <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>
239 * <tr><td>Empty</td><td>merge(A,1)</td><td>merge(A,2)</td><td>A=2</td></tr>
242 * <tr><td>A=0</td><td>put(A,1)</td><td>put(A,2)</td><td>Tx 2 will fail, A=1</td></tr>
243 * <tr><td>A=0</td><td>put(A,1)</td><td>merge(A,2)</td><td>A=2</td></tr>
244 * <tr><td>A=0</td><td>merge(A,1)</td><td>put(A,2)</td><td>Tx 2 will fail, A=1</td></tr>
245 * <tr><td>A=0</td><td>merge(A,1)</td><td>merge(A,2)</td><td>A=2</td></tr>
247 * <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>
248 * <tr><td>A=0</td><td>delete(A)</td><td>merge(A,2)</td><td>A=2</td></tr>
251 * <h4>Change compatibility of subtrees</h4>
254 * Following table shows state changes and failures between two concurrent transactions,
255 * which are based on same initial state, Tx 1 completes successfully
256 * before Tx 2 is submitted.
259 * <tr><th>Initial state</th><th>Tx 1</th><th>Tx 2</th><th>Result</th></tr>
261 * <tr><td>Empty</td><td>put(TOP,[])</td><td>put(TOP,[])</td><td>Tx 2 will fail, state is TOP=[]</td></tr>
262 * <tr><td>Empty</td><td>put(TOP,[])</td><td>merge(TOP,[])</td><td>TOP=[]</td></tr>
264 * <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]
266 * <tr><td>Empty</td><td>put(TOP,[FOO=1])</td><td>merge(TOP,[BAR=1])</td><td>TOP=[FOO=1,BAR=1]</td></tr>
268 * <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]
270 * <tr><td>Empty</td><td>merge(TOP,[FOO=1])</td><td>merge(TOP,[BAR=1])</td><td>TOP=[FOO=1,BAR=1]</td></tr>
272 * <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]
274 * <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>
275 * <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]
277 * <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>
278 * <tr><td>TOP=[]</td><td>delete(TOP)</td><td>put(TOP,[BAR=1])</td><td>Tx 2 will fail, state is empty store
280 * <tr><td>TOP=[]</td><td>delete(TOP)</td><td>merge(TOP,[BAR=1])</td><td>state is TOP=[BAR=1]</td></tr>
282 * <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>
283 * <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>
284 * <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>
285 * <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>
286 * <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>
287 * <tr><td>TOP=[]</td><td>delete(TOP)</td><td>merge(TOP/BAR,1]</td><td>Tx 2 will fail, state is empty store
290 * <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>
291 * <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>
292 * <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>
293 * <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]
295 * <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>
296 * <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>
300 * <h3>Examples of failure scenarios</h3>
302 * <h4>Conflict of two transactions</h4>
305 * This example illustrates two concurrent transactions, which derived from
306 * same initial state of data tree and proposes conflicting modifications.
309 * txA = broker.newWriteTransaction(); // allocates new transaction, data tree is empty
310 * txB = broker.newWriteTransaction(); // allocates new transaction, data tree is empty
312 * txA.put(CONFIGURATION, PATH, A); // writes to PATH value A
313 * txB.put(CONFIGURATION, PATH, B) // writes to PATH value B
315 * ListenableFuture futureA = txA.submit(); // transaction A is sealed and submitted
316 * ListenebleFuture futureB = txB.submit(); // transaction B is sealed and submitted
320 * Commit of transaction A will be processed asynchronously and data tree
321 * will be updated to contain value <code>A</code> for <code>PATH</code>.
322 * Returned {@link ListenableFuture} will successfully complete once
323 * state is applied to data tree.
326 * Commit of Transaction B will fail, because previous transaction also
327 * modified path in a concurrent way. The state introduced by transaction B
328 * will not be applied. Returned {@link ListenableFuture} object will fail
329 * with {@link OptimisticLockFailedException} exception, which indicates to
330 * client that concurrent transaction prevented the submitted transaction from being
333 * @return a CheckFuture containing the result of the commit. The Future blocks until the
334 * commit operation is complete. A successful commit returns nothing. On failure,
335 * the Future will fail with a {@link TransactionCommitFailedException} or an exception
336 * derived from TransactionCommitFailedException.
338 * @throws IllegalStateException
339 * if the transaction is not new
340 * @deprecated Use {@link #commit()} instead.
344 default CheckedFuture<Void, TransactionCommitFailedException> submit() {
345 return MappingCheckedFuture.create(commit().transform(ignored -> null, MoreExecutors.directExecutor()),
346 SUBMIT_EXCEPTION_MAPPER);
350 * Submits this transaction to be asynchronously applied to update the logical data tree. The returned
351 * {@link FluentFuture} conveys the result of applying the data changes.
354 * This call logically seals the transaction, which prevents the client from further changing the data tree using
355 * this transaction. Any subsequent calls to <code>put(LogicalDatastoreType, Path, Object)</code>,
356 * <code>merge(LogicalDatastoreType, Path, Object)</code>, <code>delete(LogicalDatastoreType, Path)</code> will fail
357 * with {@link IllegalStateException}. The transaction is marked as submitted and enqueued into the data store
358 * back-end for processing.
361 * Whether or not the commit is successful is determined by versioning of the data tree and validation of registered
362 * commit participants if the transaction changes the data tree.
365 * The effects of a successful commit of data depends on listeners and commit participants that are registered with
369 * A successful commit produces implementation-specific {@link CommitInfo} structure, which is used to communicate
370 * post-condition information to the caller. Such information can contain commit-id, timing information or any
371 * other information the implementation wishes to share.
373 * @return a FluentFuture containing the result of the commit information. The Future blocks until the commit
374 * operation is complete. A successful commit returns nothing. On failure, the Future will fail with a
375 * {@link TransactionCommitFailedException} or an exception derived from TransactionCommitFailedException.
376 * @throws IllegalStateException if the transaction is already committed or was canceled.
379 @NonNull FluentFuture<? extends @NonNull CommitInfo> commit();
382 * This only exists for reuse by the deprecated {@link #submit} method and is not intended for general use.
385 ExceptionMapper<TransactionCommitFailedException> SUBMIT_EXCEPTION_MAPPER =
386 new ExceptionMapper<TransactionCommitFailedException>("submit", TransactionCommitFailedException.class) {
388 protected TransactionCommitFailedException newWithCause(String message, Throwable cause) {
389 return new TransactionCommitFailedException(message, cause);