org.opendaylight.mdsal.binding.api

Interface DataBroker

All Superinterfaces:

BindingService, DataTreeChangeService, TransactionFactory

All Known Implementing Classes:

BindingDOMDataBrokerAdapter, DataBrokerFailuresImpl, ForwardingDataBroker

public interface DataBroker
extends BindingService, TransactionFactory, 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.

All operations on the data tree are performed via one of the transactions:

• Read-Only - allocated using TransactionFactory.newReadOnlyTransaction()
• Write-Only - allocated using TransactionFactory.newWriteOnlyTransaction()

These transactions provide a stable isolated view of data tree, which is guaranteed to be not affected by other concurrent transactions, until transaction is committed.

For a detailed explanation of how transaction are isolated and how transaction-local changes are committed to global data tree, see ReadTransaction, WriteTransaction and WriteTransaction.commit().

It is strongly recommended to use the type of transaction, which provides only the minimal capabilities you need. This allows for optimizations at the data broker / data store level. For example, implementations may optimize the transaction for reading if they know ahead of time that you only need to read data - such as not keeping additional meta-data, which may be required for write transactions.

Implementation Note: This interface is not intended to be implemented by users of MD-SAL, but only to be consumed by them.

Method Summary

Modifier and Type	Method and Description
@NonNull TransactionChain	createTransactionChain(@NonNull TransactionChainListener listener) Create a new transaction chain.

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

newReadOnlyTransaction, newReadWriteTransaction, newWriteOnlyTransaction

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

registerDataTreeChangeListener

Method Detail

createTransactionChain

@NonNull TransactionChain createTransactionChain(@NonNull TransactionChainListener listener)

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.

Parameters:

listener - Transaction chain event listener

Returns:

A new transaction chain.