org.opendaylight.mdsal.dom.spi.store

Interface DOMStoreTransactionChain

All Superinterfaces:

AutoCloseable, DOMStoreTransactionFactory

All Known Implementing Classes:

AbstractSnapshotBackedTransactionChain

public interface DOMStoreTransactionChain
extends DOMStoreTransactionFactory, AutoCloseable

A chain of transactions. Transactions in a chain need to be committed in sequence and each transaction must 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.

Method Summary

Modifier and Type	Method and Description
void	close() Closes Transaction Chain.
DOMStoreReadTransaction	newReadOnlyTransaction() Create a new read only transaction which will continue the chain.
DOMStoreReadWriteTransaction	newReadWriteTransaction() Create a new read write transaction which will continue the chain.
DOMStoreWriteTransaction	newWriteOnlyTransaction() Create a new write-only transaction which will continue the chain.

Method Detail

newReadOnlyTransaction

DOMStoreReadTransaction newReadOnlyTransaction()

Create a new read only transaction which will continue the chain. The previous write transaction has to be either READY or CANCELLED. If previous write transaction was already commited to data store, new read-only transaction is same as obtained via DOMStoreTransactionFactory.newReadOnlyTransaction() and contains merged result of previous one and current state of data store. Otherwise read-only transaction presents isolated view as if previous read-write transaction was successful. State which was introduced by other transactions outside this transaction chain after creation of previous transaction is not visible.

Specified by:

newReadOnlyTransaction in interface DOMStoreTransactionFactory

Returns:

New transaction in the chain.

Throws:

IllegalStateException - if the previous transaction was not READY or CANCELLED, or if the chain has been closed.

newReadWriteTransaction

DOMStoreReadWriteTransaction newReadWriteTransaction()

Create a new read write transaction which will continue the chain. The previous read-write transaction has to be either COMMITED or CANCELLED.

If previous write transaction was already commited to data store, new read-write transaction is same as obtained via DOMStoreTransactionFactory.newReadWriteTransaction() and contains merged result of previous one and current state of data store.

Otherwise read-write transaction presents isolated view as if previous read-write transaction was successful. State which was introduced by other transactions outside this transaction chain after creation of previous transaction is not visible.

Specified by:

newReadWriteTransaction in interface DOMStoreTransactionFactory

Returns:

New transaction in the chain.

Throws:

IllegalStateException - if the previous transaction was not READY or CANCELLED, or if the chain has been closed.

newWriteOnlyTransaction

DOMStoreWriteTransaction newWriteOnlyTransaction()

Create a new write-only transaction which will continue the chain. The previous read-write transaction has to be either READY or CANCELLED.

Specified by:

newWriteOnlyTransaction in interface DOMStoreTransactionFactory

Returns:

New transaction in the chain.

Throws:

IllegalStateException - if the previous transaction was not READY or CANCELLED, or if the chain has been closed.

close

void close()

Closes Transaction Chain.

Close method of transaction chain does not guarantee that last alocated transaction is ready or was submitted.

Specified by:

close in interface AutoCloseable

Throws:

IllegalStateException - If any of the outstanding created transactions was not canceled or ready.