org.opendaylight.controller.md.sal.trace.dom.impl

Class TracingBroker

java.lang.Object

org.opendaylight.controller.md.sal.trace.dom.impl.TracingBroker

All Implemented Interfaces:

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<?,?>>, TransactionChainFactory<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, DOMDataBroker, DOMExtensibleService<DOMDataBroker,DOMDataBrokerExtension>, TracingDOMDataBroker, org.opendaylight.mdsal.dom.api.DOMService

public class TracingBroker
extends Object
implements TracingDOMDataBroker

Constructor Summary

Constructors

Constructor and Description
TracingBroker(String type, DOMDataBroker delegate, Config config, org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer codec)

Method Summary

Modifier and Type	Method and Description
DOMTransactionChain	createTransactionChain(TransactionChainListener transactionChainListener) Create a new transaction chain.
Map<Class<? extends DOMDataBrokerExtension>,DOMDataBrokerExtension>	getSupportedExtensions() Return a map of currently-supported extensions, along with accessor services which provide access to the specific functionality bound to this service.
DOMDataReadOnlyTransaction	newReadOnlyTransaction() Allocates a new read-only transaction which provides an immutable snapshot of the data tree.
DOMDataReadWriteTransaction	newReadWriteTransaction() Allocates new read-write transaction which provides a mutable view of the data tree.
DOMDataWriteTransaction	newWriteOnlyTransaction() Allocates new write-only transaction based on latest state of data tree.
boolean	printOpenTransactions(PrintStream ps, int minOpenTXs) Prints a human-readable "report" of all opened but not closed transactions, including transactions chains and transactions opened by them, onto the printStream.
void	watchRegistrations(String iidString, LogicalDatastoreType store) Log registrations to this subtree of the md-sal.
void	watchWrites(String iidString, LogicalDatastoreType store) Log writes to this subtree of the md-sal.

Methods inherited from class java.lang.Object

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

Constructor Detail

TracingBroker

public TracingBroker(String type,
                     DOMDataBroker delegate,
                     Config config,
                     org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer codec)

Method Detail

watchRegistrations

public void watchRegistrations(String iidString,
                               LogicalDatastoreType store)

Log registrations to this subtree of the md-sal.

Parameters:

iidString - the iid path of the root of the subtree

store - Which LogicalDataStore? or null for both

watchWrites

public void watchWrites(String iidString,
                        LogicalDatastoreType store)

Log writes to this subtree of the md-sal.

Parameters:

iidString - the iid path of the root of the subtree

store - Which LogicalDataStore? or null for both

newReadWriteTransaction

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

Specified by:

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

Specified by:

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

Specified by:

newReadWriteTransaction in interface DOMDataBroker

Returns:

new read-write transaction

newWriteOnlyTransaction

public DOMDataWriteTransaction 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 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<?,?>>

Specified by:

newWriteOnlyTransaction in interface DOMDataBroker

Returns:

new write-only transaction

createTransactionChain

public DOMTransactionChain createTransactionChain(TransactionChainListener transactionChainListener)

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

Specified by:

createTransactionChain in interface DOMDataBroker

Parameters:

transactionChainListener - Transaction chain event listener

Returns:

A new transaction chain.

newReadOnlyTransaction

public DOMDataReadOnlyTransaction 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<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<?,?>>

Specified by:

newReadOnlyTransaction in interface DOMDataBroker

Returns:

new read-only transaction

getSupportedExtensions

@Nonnull
public Map<Class<? extends DOMDataBrokerExtension>,DOMDataBrokerExtension> getSupportedExtensions()

Description copied from interface: DOMExtensibleService

Return a map of currently-supported extensions, along with accessor services which provide access to the specific functionality bound to this service.

Specified by:

getSupportedExtensions in interface DOMExtensibleService<DOMDataBroker,DOMDataBrokerExtension>

Returns:

A map of supported functionality.

printOpenTransactions

public boolean printOpenTransactions(PrintStream ps,
                                     int minOpenTXs)

Description copied from interface: TracingDOMDataBroker

Prints a human-readable "report" of all opened but not closed transactions, including transactions chains and transactions opened by them, onto the printStream.

Specified by:

printOpenTransactions in interface TracingDOMDataBroker

minOpenTXs - minimum open number of transactions (leaks with fewer are not printed)

Returns:

true if there were any open transactions, false if none