org.opendaylight.mdsal.dom.api

Interface DOMDataBroker

All Superinterfaces:

AsyncDataBroker<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, AsyncDataTransactionFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, DOMExtensibleService<DOMDataBroker,DOMDataBrokerExtension>, DOMService, TransactionChainFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

All Known Implementing Classes:

AbstractDOMDataBroker, ForwardingDOMDataBroker, SerializedDOMDataBroker

public interface DOMDataBroker
extends AsyncDataBroker<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, TransactionChainFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, DOMExtensibleService<DOMDataBroker,DOMDataBrokerExtension>

Data Broker which provides data transaction and data change listener functionality using NormalizedNode data format. This interface is type capture of generic interfaces and returns type captures of results for client-code convenience.

Method Summary

Methods

Modifier and Type	Method and Description
DOMTransactionChain	createTransactionChain(TransactionChainListener listener) Create a new transaction chain.
DOMDataTreeReadTransaction	newReadOnlyTransaction() Allocates a new read-only transaction which provides an immutable snapshot of the data tree.
DOMDataTreeWriteTransaction	newWriteOnlyTransaction() Allocates new write-only transaction based on latest state of data tree.

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

getSupportedExtensions

Method Detail

newReadOnlyTransaction

DOMDataTreeReadTransaction newReadOnlyTransaction()

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<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Specified by:

newReadOnlyTransaction in interface AsyncDataTransactionFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

new read-only transaction

newWriteOnlyTransaction

DOMDataTreeWriteTransaction newWriteOnlyTransaction()

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 AsyncDataBroker<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Specified by:

newWriteOnlyTransaction in interface AsyncDataTransactionFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Returns:

new write-only transaction

createTransactionChain

DOMTransactionChain createTransactionChain(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.

Specified by:

createTransactionChain in interface TransactionChainFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Parameters:

listener - Transaction chain event listener

Returns:

A new transaction chain.