org.opendaylight.mdsal.dom.broker

Class AbstractDOMDataBroker

java.lang.Object

org.opendaylight.mdsal.dom.broker.AbstractDOMDataBroker

All Implemented Interfaces:

AutoCloseable, DOMDataBroker, DOMExtensibleService<DOMDataBroker,DOMDataBrokerExtension>, DOMService, DOMTransactionFactory

Direct Known Subclasses:

SerializedDOMDataBroker

public abstract class AbstractDOMDataBroker
extends Object
implements DOMDataBroker

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDOMDataBroker(Map<LogicalDatastoreType,DOMStore> datastores)

Method Summary

Modifier and Type	Method and Description
protected void	checkNotClosed() Checks if instance is not closed.
void	close()
protected abstract com.google.common.util.concurrent.FluentFuture<? extends CommitInfo>	commit(DOMDataTreeWriteTransaction transaction, Collection<DOMStoreThreePhaseCommitCohort> cohorts) User-supplied implementation of DOMDataTreeWriteTransaction.commit() for transaction.
DOMTransactionChain	createTransactionChain(DOMTransactionChainListener listener) Create a new transaction chain.
com.google.common.collect.ClassToInstanceMap<DOMDataBrokerExtension>	getExtensions() Return a map of currently-supported extensions, along with accessor services which provide access to the specific functionality bound to this service.
protected Map<LogicalDatastoreType,T>	getTxFactories() Convenience accessor of backing factories intended to be used only by finalization of this class.
DOMDataTreeReadTransaction	newReadOnlyTransaction() Creates a new composite read-only transaction.
DOMDataTreeReadWriteTransaction	newReadWriteTransaction() Creates a new composite read-write transaction.
protected Object	newTransactionIdentifier() Implementations must return unique identifier for each and every call of this method.
DOMDataTreeWriteTransaction	newWriteOnlyTransaction() Creates a new composite write-only transaction
void	setCloseable(AutoCloseable closeable)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.mdsal.dom.api.DOMTransactionFactory

newReadOnlyTransaction, newReadWriteTransaction, newWriteOnlyTransaction

Constructor Detail

AbstractDOMDataBroker

protected AbstractDOMDataBroker(Map<LogicalDatastoreType,DOMStore> datastores)

Method Detail

setCloseable

public void setCloseable(AutoCloseable closeable)

close

public void close()

Specified by:

close in interface AutoCloseable

newTransactionIdentifier

protected Object newTransactionIdentifier()

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

Returns:

new Unique transaction identifier.

getExtensions

public com.google.common.collect.ClassToInstanceMap<DOMDataBrokerExtension> getExtensions()

Description copied from interface: DOMExtensibleService

Return a map of currently-supported extensions, along with accessor services which provide access to the specific functionality bound to this service.

Specified by:

getExtensions in interface DOMExtensibleService<DOMDataBroker,DOMDataBrokerExtension>

Returns:

A map of supported functionality.

createTransactionChain

public DOMTransactionChain createTransactionChain(DOMTransactionChainListener listener)

Description copied from interface: DOMDataBroker

Create a new transaction chain. The chain will be initialized to read from its backing datastore, with no outstanding transaction. Listener will be registered to handle chain-level events.

Specified by:

createTransactionChain in interface DOMDataBroker

Parameters:

listener - Transaction chain event listener

Returns:

A new transaction chain.

commit

protected abstract com.google.common.util.concurrent.FluentFuture<? extends CommitInfo> commit(DOMDataTreeWriteTransaction transaction,
                                                                                               Collection<DOMStoreThreePhaseCommitCohort> cohorts)

User-supplied implementation of DOMDataTreeWriteTransaction.commit() for transaction.

Callback invoked when DOMDataTreeWriteTransaction.commit() is invoked on transaction created by this factory.

Parameters:

transaction - Transaction on which DOMDataTreeWriteTransaction.commit() was invoked.

cohorts - Iteratable of cohorts for subtransactions associated with the transaction being committed.

Returns:

a FluentFuture. if commit coordination on cohorts finished successfully, a CommitInfo is returned from the Future, On failure, the Future fails with a TransactionCommitFailedException.

newReadOnlyTransaction

public final DOMDataTreeReadTransaction newReadOnlyTransaction()

Creates a new composite read-only transaction.

Creates a new composite read-only transaction backed by one transaction per factory in getTxFactories().

Subtransaction for reading is selected by supplied LogicalDatastoreType as parameter for DOMDataTreeReadOperations.read(LogicalDatastoreType, YangInstanceIdentifier)

Id of returned transaction is retrieved via newTransactionIdentifier().

Returns:

New composite read-only transaction.

newWriteOnlyTransaction

public final DOMDataTreeWriteTransaction newWriteOnlyTransaction()

Creates a new composite write-only transaction

Creates a new composite write-only transaction backed by one write-only transaction per factory in getTxFactories().

Implementation of composite Write-only transaction is following:

• DOMDataTreeWriteOperations.put(LogicalDatastoreType, YangInstanceIdentifier, NormalizedNode) - backing subtransaction is selected by LogicalDatastoreType, DOMStoreWriteTransaction.write(YangInstanceIdentifier, NormalizedNode) is invoked on selected subtransaction.
• DOMDataTreeWriteOperations.merge(LogicalDatastoreType, YangInstanceIdentifier, NormalizedNode) - backing subtransaction is selected by LogicalDatastoreType, DOMStoreWriteTransaction.merge(YangInstanceIdentifier, NormalizedNode) is invoked on selected subtransaction.
• DOMDataTreeWriteOperations.delete(LogicalDatastoreType, YangInstanceIdentifier) - backing subtransaction is selected by LogicalDatastoreType, DOMStoreWriteTransaction.delete(YangInstanceIdentifier) is invoked on selected subtransaction.
• DOMDataTreeWriteTransaction.commit() - results in invoking DOMStoreWriteTransaction.ready(), gathering all resulting cohorts and then invoking finalized implementation callback commit(DOMDataTreeWriteTransaction, Collection) with transaction which was committed and gathered results.

Id of returned transaction is generated via newTransactionIdentifier().

Returns:

New composite write-only transaction associated with this factory.

newReadWriteTransaction

public final DOMDataTreeReadWriteTransaction newReadWriteTransaction()

Creates a new composite read-write transaction.

Returns:

New composite read-write transaction associated with this factory.

getTxFactories

protected final Map<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.