Package org.opendaylight.controller.cluster.sharding

Class OSGiDistributedShardedDOMDataTree

java.lang.Object

org.opendaylight.controller.cluster.sharding.OSGiDistributedShardedDOMDataTree

All Implemented Interfaces:

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

public final class OSGiDistributedShardedDOMDataTree
extends Object
implements DOMDataTreeService, DOMDataTreeShardingService, DistributedShardFactory

Constructor Summary

Constructors

Constructor	Description
OSGiDistributedShardedDOMDataTree()

Method Summary

Modifier and Type	Method	Description
CompletionStage<DistributedShardRegistration>	createDistributedShard(DOMDataTreeIdentifier prefix, Collection<MemberName> replicaMembers)	Register a new shard that is rooted at the desired prefix with replicas on the provided members.
DOMDataTreeProducer	createProducer(Collection<DOMDataTreeIdentifier> subtrees)
ClassToInstanceMap<DOMDataTreeServiceExtension>	getExtensions()
<T extends DOMDataTreeShard> ListenerRegistration<T>	registerDataTreeShard(DOMDataTreeIdentifier prefix, T shard, DOMDataTreeProducer producer)
<T extends DOMDataTreeListener> ListenerRegistration<T>	registerListener(T listener, Collection<DOMDataTreeIdentifier> subtrees, boolean allowRxMerges, Collection<DOMDataTreeProducer> producers)

Methods inherited from class java.lang.Object

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

Constructor Detail

OSGiDistributedShardedDOMDataTree

public OSGiDistributedShardedDOMDataTree()

Method Detail

createProducer

public DOMDataTreeProducer createProducer(Collection<DOMDataTreeIdentifier> subtrees)

Specified by:

createProducer in interface DOMDataTreeProducerFactory

getExtensions

public ClassToInstanceMap<DOMDataTreeServiceExtension> getExtensions()

Specified by:

getExtensions in interface DOMExtensibleService<DOMDataTreeService,DOMDataTreeServiceExtension>

createDistributedShard

public CompletionStage<DistributedShardRegistration> createDistributedShard(DOMDataTreeIdentifier prefix,
                                                                            Collection<MemberName> replicaMembers)
                                                                     throws DOMDataTreeShardingConflictException

Description copied from interface: DistributedShardFactory

Register a new shard that is rooted at the desired prefix with replicas on the provided members. Note to register a shard without replicas you still need to provide at least one Member for the shard.

Specified by:

createDistributedShard in interface DistributedShardFactory

Parameters:

prefix - Shard root

replicaMembers - Members that this shard is replicated on, has to have at least one Member even if the shard should not be replicated.

Returns:

A future that will be completed with a DistributedShardRegistration once the backend and frontend shards are spawned.

Throws:

DOMDataTreeShardingConflictException - If the initial check for a conflict on the local node fails, the sharding configuration won't be updated if this exception is thrown.

registerDataTreeShard

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

Specified by:

registerDataTreeShard in interface DOMDataTreeShardingService

Throws:

DOMDataTreeShardingConflictException

registerListener

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

Specified by:

registerListener in interface DOMDataTreeService

Throws:

DOMDataTreeLoopException