org.opendaylight.mdsal.dom.spi.store

Class AbstractSnapshotBackedTransactionChain<T>

java.lang.Object

org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction.TransactionReadyPrototype<T>

org.opendaylight.mdsal.dom.spi.store.AbstractSnapshotBackedTransactionChain<T>

Type Parameters:

T - transaction identifier type

All Implemented Interfaces:

AutoCloseable, DOMStoreTransactionChain, DOMStoreTransactionFactory

@Beta
public abstract class AbstractSnapshotBackedTransactionChain<T>
extends SnapshotBackedWriteTransaction.TransactionReadyPrototype<T>
implements DOMStoreTransactionChain

Abstract implementation of the DOMStoreTransactionChain interface relying on DataTreeSnapshot supplier and backend commit coordinator.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSnapshotBackedTransactionChain()

Method Summary

Modifier and Type	Method and Description
void	close() Closes Transaction Chain.
protected abstract DOMStoreThreePhaseCommitCohort	createCohort(SnapshotBackedWriteTransaction<T> transaction, org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification modification) Create a cohort for driving the transaction through the commit process.
protected abstract boolean	getDebugTransactions() Inquire as to whether transactions should record their allocation context.
DOMStoreReadTransaction	newReadOnlyTransaction() Create a new read only transaction which will continue the chain.
protected DOMStoreReadTransaction	newReadOnlyTransaction(T transactionId)
DOMStoreReadWriteTransaction	newReadWriteTransaction() Create a new read write transaction which will continue the chain.
protected DOMStoreReadWriteTransaction	newReadWriteTransaction(T transactionId)
DOMStoreWriteTransaction	newWriteOnlyTransaction() Create a new write-only transaction which will continue the chain.
protected DOMStoreWriteTransaction	newWriteOnlyTransaction(T transactionId)
protected abstract T	nextTransactionIdentifier() Return the next transaction identifier.
protected void	onTransactionCommited(SnapshotBackedWriteTransaction<T> transaction) Notify the base logic that a previously-submitted transaction has been committed successfully.
protected void	onTransactionFailed(SnapshotBackedWriteTransaction<T> transaction, Throwable cause) Notify the base logic that a previously-submitted transaction has failed.
protected abstract org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot	takeSnapshot() Take a fresh DataTreeSnapshot from the backend.
protected void	transactionAborted(SnapshotBackedWriteTransaction<T> tx) Called when a transaction is closed without being readied.
protected DOMStoreThreePhaseCommitCohort	transactionReady(SnapshotBackedWriteTransaction<T> tx, org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification tree) Returns a commit coordinator associated with supplied transactions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSnapshotBackedTransactionChain

protected AbstractSnapshotBackedTransactionChain()

Method Detail

newReadOnlyTransaction

public final DOMStoreReadTransaction newReadOnlyTransaction()

Description copied from interface: DOMStoreTransactionChain

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 DOMStoreTransactionChain

Specified by:

newReadOnlyTransaction in interface DOMStoreTransactionFactory

Returns:

New transaction in the chain.

newReadOnlyTransaction

protected DOMStoreReadTransaction newReadOnlyTransaction(T transactionId)

newReadWriteTransaction

public final DOMStoreReadWriteTransaction newReadWriteTransaction()

Description copied from interface: DOMStoreTransactionChain

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 DOMStoreTransactionChain

Specified by:

newReadWriteTransaction in interface DOMStoreTransactionFactory

Returns:

New transaction in the chain.

newReadWriteTransaction

protected DOMStoreReadWriteTransaction newReadWriteTransaction(T transactionId)

newWriteOnlyTransaction

public final DOMStoreWriteTransaction newWriteOnlyTransaction()

Description copied from interface: DOMStoreTransactionChain

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 DOMStoreTransactionChain

Specified by:

newWriteOnlyTransaction in interface DOMStoreTransactionFactory

Returns:

New transaction in the chain.

newWriteOnlyTransaction

protected DOMStoreWriteTransaction newWriteOnlyTransaction(T transactionId)

transactionAborted

protected final void transactionAborted(SnapshotBackedWriteTransaction<T> tx)

Description copied from class: SnapshotBackedWriteTransaction.TransactionReadyPrototype

Called when a transaction is closed without being readied. This is not invoked for transactions which are ready.

Specified by:

transactionAborted in class SnapshotBackedWriteTransaction.TransactionReadyPrototype<T>

Parameters:

tx - Transaction which got aborted.

transactionReady

protected final DOMStoreThreePhaseCommitCohort transactionReady(SnapshotBackedWriteTransaction<T> tx,
                                                                org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification tree)

Description copied from class: SnapshotBackedWriteTransaction.TransactionReadyPrototype

Returns a commit coordinator associated with supplied transactions. This call must not fail.

Specified by:

transactionReady in class SnapshotBackedWriteTransaction.TransactionReadyPrototype<T>

Parameters:

tx - Transaction on which ready was invoked.

tree - Modified data tree which has been constructed.

Returns:

DOMStoreThreePhaseCommitCohort associated with transaction

close

public final void close()

Description copied from interface: DOMStoreTransactionChain

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

Specified by:

close in interface DOMStoreTransactionChain

onTransactionCommited

protected final void onTransactionCommited(SnapshotBackedWriteTransaction<T> transaction)

Notify the base logic that a previously-submitted transaction has been committed successfully.

Parameters:

transaction - Transaction which completed successfully.

onTransactionFailed

protected final void onTransactionFailed(SnapshotBackedWriteTransaction<T> transaction,
                                         Throwable cause)

Notify the base logic that a previously-submitted transaction has failed.

Parameters:

transaction - Transaction which failed.

cause - Failure cause

nextTransactionIdentifier

protected abstract T nextTransactionIdentifier()

Return the next transaction identifier.

Returns:

transaction identifier.

getDebugTransactions

protected abstract boolean getDebugTransactions()

Inquire as to whether transactions should record their allocation context.

Returns:

True if allocation context should be recorded.

takeSnapshot

protected abstract org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot takeSnapshot()

Take a fresh DataTreeSnapshot from the backend.

Returns:

A new snapshot.

createCohort

protected abstract DOMStoreThreePhaseCommitCohort createCohort(SnapshotBackedWriteTransaction<T> transaction,
                                                               org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification modification)

Create a cohort for driving the transaction through the commit process.

Parameters:

transaction - Transaction handle

modification - DataTreeModification which needs to be applied to the backend

Returns:

A DOMStoreThreePhaseCommitCohort cohort.