org.opendaylight.mdsal.binding.javav2.dom.adapter.impl.data.tree

Class BindingDOMDataTreeServiceAdapter

java.lang.Object

org.opendaylight.mdsal.binding.javav2.dom.adapter.impl.data.tree.BindingDOMDataTreeServiceAdapter

All Implemented Interfaces:

BindingService, DataTreeProducerFactory, DataTreeService

@Beta
public class BindingDOMDataTreeServiceAdapter
extends Object
implements DataTreeService

Data tree service adapter.

Method Summary

Modifier and Type	Method and Description
static BindingDOMDataTreeServiceAdapter	create(DOMDataTreeService domService, BindingToNormalizedNodeCodec codec) Create instance of data tree service adapter.
DataTreeProducer	createProducer(Collection<DataTreeIdentifier<?>> subtrees) Create a producer, which is able to access to a set of trees.
<T extends DataTreeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T>	registerListener(T listener, Collection<DataTreeIdentifier<?>> subtrees, boolean allowRxMerges, Collection<DataTreeProducer> producers) Register a DataTreeListener instance.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static BindingDOMDataTreeServiceAdapter create(DOMDataTreeService domService,
                                                      BindingToNormalizedNodeCodec codec)

Create instance of data tree service adapter.

Parameters:

domService - - data tree service

codec - - codec foer serialize/deserialize

Returns:

instance of data tree service adapter

createProducer

public DataTreeProducer createProducer(Collection<DataTreeIdentifier<?>> subtrees)

Description copied from interface: DataTreeProducerFactory

Create a producer, which is able to access to a set of trees.

Specified by:

createProducer in interface DataTreeProducerFactory

Parameters:

subtrees - The collection of subtrees the resulting producer should have access to.

Returns:

A DataTreeProducer instance.

registerListener

@Nonnull
public <T extends DataTreeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T> registerListener(@Nonnull
                                                                                                                          T listener,
                                                                                                                          @Nonnull
                                                                                                                          Collection<DataTreeIdentifier<?>> subtrees,
                                                                                                                          boolean allowRxMerges,
                                                                                                                          @Nonnull
                                                                                                                          Collection<DataTreeProducer> producers)
                                                                                                                   throws DataTreeLoopException

Description copied from interface: DataTreeService

Register a DataTreeListener instance. Once registered, the listener will start receiving changes on the selected subtrees. If the listener cannot keep up with the rate of changes, and allowRxMerges is set to true, this service is free to merge the changes, so that a smaller number of them will be reported, possibly hiding some data transitions (like flaps).

If the listener wants to write into any producer, that producer has to be mentioned in the call to this method. Those producers will be bound exclusively to the registration, so that accessing them outside of this listener's callback will trigger an error. Any producers mentioned must be idle, e.g. they may not have an open transaction at the time this method is invoked.

Each listener instance can be registered at most once. Implementations of this interface have to guarantee that the listener's methods will not be invoked concurrently from multiple threads.

Specified by:

registerListener in interface DataTreeService

Type Parameters:

T - listener type

Parameters:

listener - DataTreeListener that is being registered

subtrees - Conceptual subtree identifier of subtrees which should be monitored for changes. May not be null or empty.

allowRxMerges - True if the backend may perform ingress state compression.

producers - DataTreeProducer instances to bind to the listener.

Returns:

A listener registration. Once closed, the listener will no longer be invoked and the producers will be unbound.

Throws:

DataTreeLoopException - if the registration of the listener to the specified subtrees with specified producers would form a feedback loop