org.opendaylight.mdsal.binding.api

Interface DataBroker

All Superinterfaces:

AsyncDataBroker<InstanceIdentifier<?>,DataObject>, AsyncDataTransactionFactory<InstanceIdentifier<?>,DataObject>, BindingService, DataTreeChangeService, TransactionChainFactory<InstanceIdentifier<?>,DataObject>, TransactionFactory

All Known Implementing Classes:

BindingDOMDataBrokerAdapter, ForwardingDataBroker

public interface DataBroker
extends AsyncDataBroker<InstanceIdentifier<?>,DataObject>, TransactionChainFactory<InstanceIdentifier<?>,DataObject>, TransactionFactory, BindingService, DataTreeChangeService

Provides access to a conceptual data tree store and also provides the ability to subscribe for changes to data under a given branch of the tree.

For more information on usage, please see the documentation in AsyncDataBroker.

See Also:

AsyncDataBroker, TransactionChainFactory

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.
ReadWriteTransaction	newReadWriteTransaction() Allocates new read-write transaction which provides a mutable view of the data tree.
WriteTransaction	newWriteOnlyTransaction() Allocates new write-only transaction based on latest state of data tree.

Methods inherited from interface org.opendaylight.mdsal.binding.api.DataTreeChangeService

registerDataTreeChangeListener

Method Detail

newReadOnlyTransaction

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 AsyncDataBroker<InstanceIdentifier<?>,DataObject>

Specified by:

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

Specified by:

newReadOnlyTransaction in interface TransactionFactory

Returns:

new read-only transaction

newWriteOnlyTransaction

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.commit() 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.commit().

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

Specified by:

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

Specified by:

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

Specified by:

newWriteOnlyTransaction in interface TransactionFactory

Returns:

new write-only transaction

newReadWriteTransaction

ReadWriteTransaction newReadWriteTransaction()

Description copied from interface: AsyncDataTransactionFactory

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 AsyncWriteTransaction.commit() for more details about conflicting and not-conflicting changes and failure scenarios.

Specified by:

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

Specified by:

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

Returns:

new read-write transaction

createTransactionChain

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 TransactionChainFactory<InstanceIdentifier<?>,DataObject>

Parameters:

listener - Transaction chain event listener

Returns:

A new transaction chain.