X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-common-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fcommon%2Fapi%2Fdata%2FTransactionChain.java;h=f30472fe3d43a613d1d8fbf1893d277c325f03bb;hp=ff3aa2e325af0146d5cd878ea9aed88c350d4a6c;hb=3ec97cd0a86ad1b79f6854dc6924eb7b06e359a3;hpb=94d0d20b41d64bb6696c2a573ec367fcfddc44e9 diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/TransactionChain.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/TransactionChain.java index ff3aa2e325..f30472fe3d 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/TransactionChain.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/TransactionChain.java @@ -7,23 +7,127 @@ */ package org.opendaylight.controller.md.sal.common.api.data; +import org.opendaylight.yangtools.concepts.Path; + /** - * A chain of transactions. Transactions in a chain need to be committed in sequence and each - * transaction should see the effects of previous transactions as if they happened. A chain - * makes no guarantees of atomicity, in fact transactions are committed as soon as possible. + * A chain of transactions. Transactions in a chain need to be committed in + * sequence and each transaction should see the effects of previous committed transactions + * as they occurred. A chain makes no guarantees of atomicity across the chained transactions - + * the transactions are committed as soon as possible in the order that they were submitted. + * + *

+ * This behaviour is different from the default AsyncDataBroker, where a + * transaction is always created from the current global state, not taking into + * account any transactions previously committed by the calling thread. Due to + * the asynchronous nature of transaction submission this can lead to surprising + * results. If a thread executes the following sequence sufficiently quickly: + * + *

+ * AsyncWriteTransaction t1 = broker.newWriteOnlyTransaction(); + * t1.put(id, data); + * t1.submit(); + * + *

+ * AsyncReadTransaction t2 = broker.newReadOnlyTransaction(); + * Optional<?> maybeData = t2.read(id).get(); + * + *

+ * it may happen, that it sees maybeData.isPresent() == false, simply because + * t1 has not completed the processes of being applied and t2 is actually + * allocated from the previous state. This is obviously bad for users who create + * incremental state in the datastore and actually read what they write in + * subsequent transactions. + * + *

+ * Using a TransactionChain instead of a broker solves this particular problem, + * and leads to expected behavior: t2 will always see the data written in t1 + * present. */ -public interface TransactionChain

*/, D> extends AutoCloseable { +@Deprecated +public interface TransactionChain

, D> extends AutoCloseable, AsyncDataTransactionFactory { + /** - * Create a new transaction which will continue the chain. The previous transaction - * has to be either COMMITTED or CANCELLED. + * Create a new read only transaction which will continue the chain. + * + *

+ * The previous write transaction has to be either SUBMITTED + * ({@link AsyncWriteTransaction#submit submit} was invoked) or CANCELLED + * ({@link #close close} was invoked). + * + *

+ * The returned read-only transaction presents an isolated view of the data if the previous + * write transaction was successful - in other words, this read-only transaction will see the + * state changes made by the previous write transaction in the chain. However, state which + * was introduced by other transactions outside this transaction chain after creation of + * the previous transaction is not visible. * * @return New transaction in the chain. - * @throws IllegalStateException if the previous transaction was not COMMITTED or CANCELLED. - * @throws TransactionChainClosedException if the chain has been closed. + * @throws IllegalStateException + * if the previous transaction was not SUBMITTED or CANCELLED. + * @throws TransactionChainClosedException + * if the chain has been closed. */ - DataModification newTransaction(); + @Override + AsyncReadOnlyTransaction newReadOnlyTransaction(); + + /** + * Create a new read-write transaction which will continue the chain. + * + *

+ * The previous write transaction has to be either SUBMITTED + * ({@link AsyncWriteTransaction#submit submit} was invoked) or CANCELLED + * ({@link #close close} was invoked). + * + *

+ * The returned read-write transaction presents an isolated view of the data if the previous + * write transaction was successful - in other words, this read-write transaction will see the + * state changes made by the previous write transaction in the chain. However, state which + * was introduced by other transactions outside this transaction chain after creation of + * the previous transaction is not visible. + * + *

+ * Committing this read-write transaction using {@link AsyncWriteTransaction#submit submit} + * will submit the state changes in this transaction to be visible to any subsequent + * transaction in this chain and also to any transaction outside this chain. + * + * @return New transaction in the chain. + * @throws IllegalStateException + * if the previous transaction was not SUBMITTED or CANCELLED. + * @throws TransactionChainClosedException + * if the chain has been closed. + */ + @Override + AsyncReadWriteTransaction newReadWriteTransaction(); + + /** + * Create a new write-only transaction which will continue the chain. + * + *

+ * The previous write transaction has to be either SUBMITTED + * ({@link AsyncWriteTransaction#submit submit} was invoked) or CANCELLED + * ({@link #close close} was invoked). + * + *

+ * The returned write-only transaction presents an isolated view of the data if the previous + * write transaction was successful - in other words, this write-only transaction will see the + * state changes made by the previous write transaction in the chain. However, state which + * was introduced by other transactions outside this transaction chain after creation of + * the previous transaction is not visible. + * + *

+ * Committing this write-only transaction using {@link AsyncWriteTransaction#submit submit} + * will submit the state changes in this transaction to be visible to any subsequent + * transaction in this chain and also to any transaction outside this chain. + * + * @return New transaction in the chain. + * @throws IllegalStateException + * if the previous transaction was not SUBMITTED or CANCELLED. + * @throws TransactionChainClosedException + * if the chain has been closed. + */ + @Override + AsyncWriteTransaction newWriteOnlyTransaction(); @Override void close(); } -