org.opendaylight.mdsal.dom.broker.pingpong

Class PingPongDataBroker

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.mdsal.dom.spi.ForwardingDOMDataBroker

org.opendaylight.mdsal.dom.broker.pingpong.PingPongDataBroker

All Implemented Interfaces:

AutoCloseable, DOMDataBroker, DOMDataBrokerExtension, DOMDataTreeChangeService, DOMExtensibleService<DOMDataBroker,DOMDataBrokerExtension>, DOMService, DOMServiceExtension<DOMDataBroker,DOMDataBrokerExtension>, DOMTransactionFactory

public final class PingPongDataBroker
extends ForwardingDOMDataBroker
implements AutoCloseable, DOMDataTreeChangeService

An implementation of a DOMDataBroker, which forwards most requests to a delegate.

Its interpretation of the API contract is somewhat looser, specifically it does not guarantee transaction ordering between transactions allocated directly from the broker and its transaction chains.

Constructor Summary

Constructors

Constructor and Description
PingPongDataBroker(@NonNull DOMDataBroker delegate) Instantiate a new broker, backed by the the specified delegate DOMDataBroker.

Method Summary

Modifier and Type	Method and Description
void	close()
PingPongTransactionChain	createTransactionChain(DOMTransactionChainListener listener) Create a new transaction chain.
protected DOMDataBroker	delegate()
<L extends DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerDataTreeChangeListener(DOMDataTreeIdentifier treeId, L listener) Registers a DOMDataTreeChangeListener to receive notifications when data changes under a given path in the conceptual data tree.
String	toString()

Methods inherited from class org.opendaylight.mdsal.dom.spi.ForwardingDOMDataBroker

getExtensions, newReadOnlyTransaction, newReadWriteTransaction, newWriteOnlyTransaction

Methods inherited from class java.lang.Object

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

Constructor Detail

PingPongDataBroker

public PingPongDataBroker(@NonNull DOMDataBroker delegate)

Instantiate a new broker, backed by the the specified delegate DOMDataBroker.

Parameters:

delegate - Backend broker, may not be null.

Method Detail

delegate

protected DOMDataBroker delegate()

Specified by:

delegate in class ForwardingDOMDataBroker

createTransactionChain

public PingPongTransactionChain createTransactionChain(DOMTransactionChainListener listener)

Description copied from interface: DOMDataBroker

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 DOMDataBroker

Overrides:

createTransactionChain in class ForwardingDOMDataBroker

Parameters:

listener - Transaction chain event listener

Returns:

A new transaction chain.

close

public void close()

Specified by:

close in interface AutoCloseable

registerDataTreeChangeListener

public <L extends DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerDataTreeChangeListener(DOMDataTreeIdentifier treeId,
                                                                                                                                        L listener)

Description copied from interface: DOMDataTreeChangeService

Registers a DOMDataTreeChangeListener to receive notifications when data changes under a given path in the conceptual data tree.

You are able to register for notifications for any node or subtree which can be represented using DOMDataTreeIdentifier.

You are able to register for data change notifications for a subtree or leaf even if it does not exist. You will receive notification once that node is created.

If there is any pre-existing data in the data tree for the path for which you are registering, you will receive an initial data change event, which will contain all pre-existing data, marked as created.

This method returns a ListenerRegistration object. To "unregister" your listener for changes call the ListenerRegistration.close() method on the returned object.

You MUST explicitly unregister your listener when you no longer want to receive notifications. This is especially true in OSGi environments, where failure to do so during bundle shutdown can lead to stale listeners being still registered.

Specified by:

registerDataTreeChangeListener in interface DOMDataTreeChangeService

Type Parameters:

L - Listener type

Parameters:

treeId - Data tree identifier of the subtree which should be watched for changes.

listener - Listener instance which is being registered

Returns:

Listener registration object, which may be used to unregister your listener using ListenerRegistration.close() to stop delivery of change events.

toString

public String toString()

Overrides:

toString in class com.google.common.collect.ForwardingObject