Package org.opendaylight.controller.md.sal.dom.api

Interface DOMDataBroker

All Superinterfaces:

AsyncDataBroker<YangInstanceIdentifier,NormalizedNode<?,?>>, AsyncDataTransactionFactory<YangInstanceIdentifier,NormalizedNode<?,?>>, DOMExtensibleService<DOMDataBroker,DOMDataBrokerExtension>, DOMService, DOMService, TransactionChainFactory<YangInstanceIdentifier,NormalizedNode<?,?>>

All Known Subinterfaces:

TracingDOMDataBroker

All Known Implementing Classes:

AbstractDOMDataBroker, AbstractLegacyDOMDataBrokerAdapter, ForwardingDOMDataBroker, LegacyDOMDataBrokerAdapter, LegacyPingPongDOMDataBrokerAdapter, LegacyShardedDOMDataBrokerAdapter, PingPongDataBroker, SerializedDOMDataBroker, TracingBroker

@Deprecated(forRemoval=true)
public interface DOMDataBroker
extends AsyncDataBroker<YangInstanceIdentifier,NormalizedNode<?,?>>, TransactionChainFactory<YangInstanceIdentifier,NormalizedNode<?,?>>, DOMExtensibleService<DOMDataBroker,DOMDataBrokerExtension>

Deprecated, for removal: This API element is subject to removal in a future version.

Use DOMDataBroker instead

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

Modifier and Type	Method	Description
DOMTransactionChain	createTransactionChain(TransactionChainListener listener)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new transaction chain.
DOMDataReadOnlyTransaction	newReadOnlyTransaction()	Deprecated, for removal: This API element is subject to removal in a future version. Allocates a new read-only transaction which provides an immutable snapshot of the data tree.
DOMDataReadWriteTransaction	newReadWriteTransaction()	Deprecated, for removal: This API element is subject to removal in a future version. Allocates new read-write transaction which provides a mutable view of the data tree.
DOMDataWriteTransaction	newWriteOnlyTransaction()	Deprecated, for removal: This API element is subject to removal in a future version. Allocates new write-only transaction based on latest state of data tree.

Methods inherited from interface org.opendaylight.controller.md.sal.dom.api.DOMExtensibleService

getSupportedExtensions

Method Detail

newReadOnlyTransaction

DOMDataReadOnlyTransaction newReadOnlyTransaction()

Deprecated, for removal: This API element is subject to removal in a future version.

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<YangInstanceIdentifier,NormalizedNode<?,?>>

Specified by:

newReadOnlyTransaction in interface AsyncDataTransactionFactory<YangInstanceIdentifier,NormalizedNode<?,?>>

Returns:

new read-only transaction

newReadWriteTransaction

DOMDataReadWriteTransaction newReadWriteTransaction()

Deprecated, for removal: This API element is subject to removal in a future version.

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

Specified by:

newReadWriteTransaction in interface AsyncDataBroker<YangInstanceIdentifier,NormalizedNode<?,?>>

Specified by:

newReadWriteTransaction in interface AsyncDataTransactionFactory<YangInstanceIdentifier,NormalizedNode<?,?>>

Returns:

new read-write transaction

newWriteOnlyTransaction

DOMDataWriteTransaction newWriteOnlyTransaction()

Deprecated, for removal: This API element is subject to removal in a future version.

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 AsyncDataBroker<YangInstanceIdentifier,NormalizedNode<?,?>>

Specified by:

newWriteOnlyTransaction in interface AsyncDataTransactionFactory<YangInstanceIdentifier,NormalizedNode<?,?>>

Returns:

new write-only transaction

createTransactionChain

DOMTransactionChain createTransactionChain(TransactionChainListener listener)

Deprecated, for removal: This API element is subject to removal in a future version.

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<YangInstanceIdentifier,NormalizedNode<?,?>>

Parameters:

listener - Transaction chain event listener

Returns:

A new transaction chain.