org.opendaylight.mdsal.binding.dom.adapter

Class BindingDOMDataBrokerAdapter

java.lang.Object

org.opendaylight.mdsal.binding.dom.adapter.AbstractForwardedDataBroker

org.opendaylight.mdsal.binding.dom.adapter.BindingDOMDataBrokerAdapter

All Implemented Interfaces:

AutoCloseable, BindingService, DataBroker, DataTreeChangeService, TransactionFactory, AsyncDataBroker<InstanceIdentifier<?>,DataObject>, AsyncDataTransactionFactory<InstanceIdentifier<?>,DataObject>, TransactionChainFactory<InstanceIdentifier<?>,DataObject>, org.opendaylight.yangtools.concepts.Delegator<DOMDataBroker>

public class BindingDOMDataBrokerAdapter
extends AbstractForwardedDataBroker
implements DataBroker, DataTreeChangeService

The DataBrokerImpl simply defers to the DOMDataBroker for all its operations. All transactions and listener registrations are wrapped by the DataBrokerImpl to allow binding aware components to use the DataBroker transparently.

Besides this the DataBrokerImpl and it's collaborators also cache data that is already transformed from the binding independent to binding aware format

Constructor Summary

Constructors

Constructor and Description
BindingDOMDataBrokerAdapter(DOMDataBroker domDataBroker, BindingToNormalizedNodeCodec codec)

Method Summary

Modifier and Type	Method and Description
BindingTransactionChain	createTransactionChain(TransactionChainListener listener) Create a new transaction chain.
ReadTransaction	newReadOnlyTransaction() Allocates a new read-only transaction which provides an immutable snapshot of the data tree.
WriteTransaction	newWriteOnlyTransaction() Allocates new write-only transaction based on latest state of data tree.
<T extends DataObject,L extends DataTreeChangeListener<T>> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerDataTreeChangeListener(DataTreeIdentifier<T> treeId, L listener) Registers a DataTreeChangeListener to receive notifications when data changes under a given path in the conceptual data tree.

Methods inherited from class org.opendaylight.mdsal.binding.dom.adapter.AbstractForwardedDataBroker

close, getCodec, getDelegate, toBinding, toBinding, toBindingData

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingDOMDataBrokerAdapter

public BindingDOMDataBrokerAdapter(DOMDataBroker domDataBroker,
                                   BindingToNormalizedNodeCodec codec)

Method Detail

newReadOnlyTransaction

public ReadTransaction newReadOnlyTransaction()

Description copied from interface: AsyncDataTransactionFactory

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 DataBroker

Specified by:

newReadOnlyTransaction in interface TransactionFactory

Specified by:

newReadOnlyTransaction in interface AsyncDataBroker<InstanceIdentifier<?>,DataObject>

Specified by:

newReadOnlyTransaction in interface AsyncDataTransactionFactory<InstanceIdentifier<?>,DataObject>

Returns:

new read-only transaction

newWriteOnlyTransaction

public WriteTransaction newWriteOnlyTransaction()

Description copied from interface: AsyncDataTransactionFactory

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 AsyncWriteTransaction.submit() for more details about conflicting and not-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 AsyncWriteTransaction.submit().

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

Specified by:

newWriteOnlyTransaction in interface DataBroker

Specified by:

newWriteOnlyTransaction in interface TransactionFactory

Specified by:

newWriteOnlyTransaction in interface AsyncDataBroker<InstanceIdentifier<?>,DataObject>

Specified by:

newWriteOnlyTransaction in interface AsyncDataTransactionFactory<InstanceIdentifier<?>,DataObject>

Returns:

new write-only transaction

createTransactionChain

public BindingTransactionChain createTransactionChain(TransactionChainListener listener)

Description copied from interface: TransactionChainFactory

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 DataBroker

Specified by:

createTransactionChain in interface TransactionChainFactory<InstanceIdentifier<?>,DataObject>

Parameters:

listener - Transaction chain event listener

Returns:

A new transaction chain.

registerDataTreeChangeListener

public <T extends DataObject,L extends DataTreeChangeListener<T>> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerDataTreeChangeListener(DataTreeIdentifier<T> treeId,
                                                                                                                                                             L listener)

Description copied from interface: DataTreeChangeService

Registers a DataTreeChangeListener to receive notifications when data changes under a given path in the conceptual data tree.

You are able to register for notifications for any node or subtree which can be represented using DataTreeIdentifier.

You are able to register for data change notifications for a subtree or leaf even if it does not exist. You will receive notification once that node is created.

If there is any pre-existing data in the data tree for the path for which you are registering, you will receive an initial data change event, which will contain all pre-existing data, marked as created.

This method returns a ListenerRegistration object. To "unregister" your listener for changes call the ListenerRegistration.close() method on the returned object.

You MUST explicitly unregister your listener when you no longer want to receive notifications. This is especially true in OSGi environments, where failure to do so during bundle shutdown can lead to stale listeners being still registered.

Specified by:

registerDataTreeChangeListener in interface DataTreeChangeService

Parameters:

treeId - Data tree identifier of the subtree which should be watched for changes.

listener - Listener instance which is being registered

Returns:

Listener registration object, which may be used to unregister your listener using ListenerRegistration.close() to stop delivery of change events.