org.opendaylight.mdsal.dom.api

Interface DOMDataTreeShardingService

All Superinterfaces:

DOMService

All Known Implementing Classes:

ShardedDOMDataTree

public interface DOMDataTreeShardingService
extends DOMService

A DOMService providing access to details on how the conceptual data tree is distributed among providers (also known as shards). Each shard is tied to a single DOMDataTreeIdentifier. Based on those data tree identifiers, the shards are organized in a tree, where there is a logical parent/child relationship.

It is not allowed to attach two shards to the same data tree identifier, which means the mapping of each piece of information has an unambiguous home. When accessing the information, the shard with the longest matching data tree identifier is used, which is why this interface treats it is a prefix.

Whenever a parent/child relationship is changed, the parent is notified, so it can understand that a logical child has been attached.

Method Summary

Modifier and Type	Method and Description
<T extends DOMDataTreeShard> @NonNull org.opendaylight.yangtools.concepts.ListenerRegistration<T>	registerDataTreeShard(@NonNull DOMDataTreeIdentifier prefix, T shard, @NonNull DOMDataTreeProducer producer) Register a shard as responsible for a particular subtree prefix.

Method Detail

registerDataTreeShard

<T extends DOMDataTreeShard> @NonNull org.opendaylight.yangtools.concepts.ListenerRegistration<T> registerDataTreeShard(@NonNull DOMDataTreeIdentifier prefix,
                                                                                                                        T shard,
                                                                                                                        @NonNull DOMDataTreeProducer producer)
                                                                                                                 throws DOMDataTreeShardingConflictException

Register a shard as responsible for a particular subtree prefix.

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