org.opendaylight.mdsal.dom.spi

Class ForwardingDOMDataBroker

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.mdsal.dom.spi.ForwardingDOMDataBroker

All Implemented Interfaces:

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

Direct Known Subclasses:

PingPongDataBroker

public abstract class ForwardingDOMDataBroker
extends com.google.common.collect.ForwardingObject
implements DOMDataBroker

Utility DOMDataBroker implementation which forwards all interface method invocation to a delegate instance.

Constructor Summary

Constructors

Constructor and Description
ForwardingDOMDataBroker()

Method Summary

Modifier and Type	Method and Description
DOMTransactionChain	createTransactionChain(DOMTransactionChainListener listener) Create a new transaction chain.
protected abstract @NonNull DOMDataBroker	delegate()
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.
DOMDataTreeReadTransaction	newReadOnlyTransaction() Allocates a new read-only transaction which provides an immutable snapshot of the data tree.
DOMDataTreeReadWriteTransaction	newReadWriteTransaction() Allocates new read-write transaction which provides a mutable view of the data tree.
DOMDataTreeWriteTransaction	newWriteOnlyTransaction() Allocates new write-only transaction based on latest state of data tree.

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingDOMDataBroker

public ForwardingDOMDataBroker()

Method Detail

delegate

protected abstract @NonNull DOMDataBroker delegate()

Specified by:

delegate in class com.google.common.collect.ForwardingObject

newReadOnlyTransaction

public DOMDataTreeReadTransaction newReadOnlyTransaction()

Description copied from interface: DOMTransactionFactory

Allocates a new read-only transaction which provides an immutable snapshot of the data tree. The view of data tree is an immutable snapshot of current data tree state when transaction was allocated.

Specified by:

newReadOnlyTransaction in interface DOMTransactionFactory

Returns:

A new read-only transaction

newWriteOnlyTransaction

public DOMDataTreeWriteTransaction newWriteOnlyTransaction()

Description copied from interface: DOMTransactionFactory

Allocates new write-only transaction based on latest state of data tree.

Preconditions for mutation of data tree are captured from the snapshot of data tree state, when the transaction is allocated. If data was changed during transaction in an incompatible way then the commit of this transaction will fail. See DOMDataTreeWriteTransaction.commit() for more details about conflicting and non-conflicting changes and failure scenarios.

Since this transaction does not provide a view of the data it SHOULD BE used only by callers which are exclusive writers (exporters of data) to the subtree they modify. This prevents optimistic lock failures as described in DOMDataTreeWriteTransaction.commit().

Exclusivity of writers to particular subtree SHOULD BE enforced by external locking mechanism.

Specified by:

newWriteOnlyTransaction in interface DOMTransactionFactory

Returns:

new write-only transaction

newReadWriteTransaction

public DOMDataTreeReadWriteTransaction newReadWriteTransaction()

Description copied from interface: DOMTransactionFactory

Allocates new read-write transaction which provides a mutable view of the data tree.

Preconditions for mutation of data tree are captured from the snapshot of data tree state, when the transaction is allocated. If data was changed during transaction in an incompatible way then the commit of this transaction will fail. See DOMDataTreeWriteTransaction.commit() for more details about conflicting and non-conflicting changes and failure scenarios.

Specified by:

newReadWriteTransaction in interface DOMTransactionFactory

Returns:

new read-write transaction

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.

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.