org.opendaylight.controller.cluster.databroker

Class AbstractDOMTransactionFactory<T extends org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory>

java.lang.Object

org.opendaylight.controller.cluster.databroker.AbstractDOMTransactionFactory<T>

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ConcurrentDOMDataBroker

public abstract class AbstractDOMTransactionFactory<T extends org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory>
extends Object
implements AutoCloseable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDOMTransactionFactory(Map<org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,T> txFactories)

Method Summary

Modifier and Type	Method and Description
protected void	checkNotClosed() Checks if instance is not closed.
void	close()
protected Map<org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,T>	getTxFactories() Convenience accessor of backing factories intended to be used only by finalization of this class.
org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction	newReadOnlyTransaction() Creates a new read-only transaction.
org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction	newReadWriteTransaction() Creates a new read-write transaction.
protected abstract Object	newTransactionIdentifier() Implementations must return unique identifier for each and every call of this method.
org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction	newWriteOnlyTransaction() Creates a new write-only transaction.
protected abstract com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException>	submit(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction transaction, Collection<org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort> cohorts) Submits a transaction asynchronously for commit.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDOMTransactionFactory

protected AbstractDOMTransactionFactory(Map<org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,T> txFactories)

Method Detail

newTransactionIdentifier

protected abstract Object newTransactionIdentifier()

Implementations must return unique identifier for each and every call of this method.

Returns:

new Unique transaction identifier.

submit

protected abstract com.google.common.util.concurrent.CheckedFuture<Void,org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException> submit(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction transaction,
                                                                                                                                                                    Collection<org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort> cohorts)

Submits a transaction asynchronously for commit.

Parameters:

transaction - the transaction to submit

cohorts - the associated cohorts

Returns:

a resulting Future

newReadOnlyTransaction

public final org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction newReadOnlyTransaction()

Creates a new read-only transaction.

Returns:

the transaction instance

newWriteOnlyTransaction

public final org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction newWriteOnlyTransaction()

Creates a new write-only transaction.

Returns:

the transaction instance

newReadWriteTransaction

public final org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction newReadWriteTransaction()

Creates a new read-write transaction.

Returns:

the transaction instance

getTxFactories

protected final Map<org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,T> getTxFactories()

Convenience accessor of backing factories intended to be used only by finalization of this class. Note: Finalization of this class may want to access other functionality of supplied Transaction factories.

Returns:

Map of backing transaction factories.

checkNotClosed

protected final void checkNotClosed()

Checks if instance is not closed.

Throws:

IllegalStateException - If instance of this class was closed.

close

public void close()

Specified by:

close in interface AutoCloseable