org.opendaylight.mdsal.dom.broker

Class ShardedDOMDataTree

java.lang.Object

org.opendaylight.mdsal.dom.broker.ShardedDOMDataTree

All Implemented Interfaces:

DOMDataTreeProducerFactory, DOMDataTreeService, DOMDataTreeShardingService, DOMExtensibleService<DOMDataTreeService,DOMDataTreeServiceExtension>, DOMService

public final class ShardedDOMDataTree
extends Object
implements DOMDataTreeService, DOMDataTreeShardingService

Constructor Summary

Constructors

Constructor and Description
ShardedDOMDataTree()

Method Summary

Modifier and Type	Method and Description
DOMDataTreeProducer	createProducer(Collection<DOMDataTreeIdentifier> subtrees) Create a producer, which is able to access to a set of trees.
com.google.common.collect.ClassToInstanceMap<DOMDataTreeServiceExtension>	getExtensions() Return a map of currently-supported extensions, along with accessor services which provide access to the specific functionality bound to this service.
<T extends DOMDataTreeShard> DOMDataTreeShardRegistration<T>	registerDataTreeShard(DOMDataTreeIdentifier prefix, T shard, DOMDataTreeProducer producer) Register a shard as responsible for a particular subtree prefix.
<T extends DOMDataTreeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T>	registerListener(T listener, Collection<DOMDataTreeIdentifier> subtrees, boolean allowRxMerges, Collection<DOMDataTreeProducer> producers) Register a DOMDataTreeListener instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShardedDOMDataTree

public ShardedDOMDataTree()

Method Detail

registerDataTreeShard

public <T extends DOMDataTreeShard> DOMDataTreeShardRegistration<T> registerDataTreeShard(DOMDataTreeIdentifier prefix,
                                                                                          T shard,
                                                                                          DOMDataTreeProducer producer)
                                                                                   throws DOMDataTreeShardingConflictException

Description copied from interface: DOMDataTreeShardingService

Register a shard as responsible for a particular subtree prefix.

Specified by:

registerDataTreeShard in interface DOMDataTreeShardingService

Parameters:

prefix - Data tree identifier, may not be null.

shard - Responsible shard instance

producer - Producer instance to verify namespace claim

Returns:

A registration. To remove the shard's binding, close the registration.

Throws:

DOMDataTreeShardingConflictException - if the prefix is already bound

getExtensions

public com.google.common.collect.ClassToInstanceMap<DOMDataTreeServiceExtension> getExtensions()

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:

getExtensions in interface DOMExtensibleService<DOMDataTreeService,DOMDataTreeServiceExtension>

Returns:

A map of supported functionality.

createProducer

public DOMDataTreeProducer createProducer(Collection<DOMDataTreeIdentifier> subtrees)

Description copied from interface: DOMDataTreeProducerFactory

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

Specified by:

createProducer in interface DOMDataTreeProducerFactory

Parameters:

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

Returns:

A DOMDataTreeProducer instance.

registerListener

public <T extends DOMDataTreeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T> registerListener(T listener,
                                                                                                                    Collection<DOMDataTreeIdentifier> subtrees,
                                                                                                                    boolean allowRxMerges,
                                                                                                                    Collection<DOMDataTreeProducer> producers)
                                                                                                             throws DOMDataTreeLoopException

Description copied from interface: DOMDataTreeService

Register a DOMDataTreeListener 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 DOMDataTreeService

Parameters:

listener - DOMDataTreeListener 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 - DOMDataTreeProducer 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:

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