org.opendaylight.mdsal.dom.api

Interface DOMTransactionChain

All Superinterfaces:

AsyncDataTransactionFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, AutoCloseable, TransactionChain<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

All Known Implementing Classes:

ForwardingDOMTransactionChain, PingPongTransactionChain, ShardedDOMTransactionChainAdapter

public interface DOMTransactionChain
extends TransactionChain<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

A chain of DOM Data 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.

This interface is type capture of TransactionChain for DOM Data Contracts.

Method Summary

Modifier and Type	Method and Description
DOMDataTreeReadTransaction	newReadOnlyTransaction() Create a new read only transaction which will continue the chain.
DOMDataTreeReadWriteTransaction	newReadWriteTransaction() Create a new read-write transaction which will continue the chain.
DOMDataTreeWriteTransaction	newWriteOnlyTransaction() Create a new write-only transaction which will continue the chain.

Methods inherited from interface org.opendaylight.mdsal.common.api.TransactionChain

close

Method Detail

newReadOnlyTransaction

DOMDataTreeReadTransaction newReadOnlyTransaction()

Description copied from interface: TransactionChain

Create a new read only transaction which will continue the chain.

The previous write transaction has to be either SUBMITTED (commit was invoked) or CANCELLED (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.

Specified by:

newReadOnlyTransaction in interface AsyncDataTransactionFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Specified by:

newReadOnlyTransaction in interface TransactionChain<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

New transaction in the chain.

newWriteOnlyTransaction

DOMDataTreeWriteTransaction newWriteOnlyTransaction()

Description copied from interface: TransactionChain

Create a new write-only transaction which will continue the chain.

The previous write transaction has to be either SUBMITTED (commit was invoked) or CANCELLED (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 commit will commit the state changes in this transaction to be visible to any subsequent transaction in this chain and also to any transaction outside this chain.

Specified by:

newWriteOnlyTransaction in interface AsyncDataTransactionFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Specified by:

newWriteOnlyTransaction in interface TransactionChain<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

New transaction in the chain.

newReadWriteTransaction

DOMDataTreeReadWriteTransaction newReadWriteTransaction()

Description copied from interface: TransactionChain

Create a new read-write transaction which will continue the chain.

The previous write transaction has to be either SUBMITTED (commit was invoked) or CANCELLED (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 commit will commit the state changes in this transaction to be visible to any subsequent transaction in this chain and also to any transaction outside this chain.

Specified by:

newReadWriteTransaction in interface AsyncDataTransactionFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Specified by:

newReadWriteTransaction in interface TransactionChain<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

New transaction in the chain.