Interface CDSDataTreeProducer

  • All Superinterfaces:
    AutoCloseable, org.opendaylight.mdsal.dom.api.DOMDataTreeProducer, org.opendaylight.mdsal.dom.api.DOMDataTreeProducerFactory

    @Beta
    public interface CDSDataTreeProducer
    extends org.opendaylight.mdsal.dom.api.DOMDataTreeProducer
    An extension to DOMDataTreeProducer, which allows users access to information about the backing shard.
    Author:
    Robert Varga
    • Method Detail

      • getShardAccess

        @NonNull CDSShardAccess getShardAccess​(@NonNull org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier subtree)
        Return a CDSShardAccess handle. This handle will remain valid as long as this producer is operational. Returned handle can be accessed independently from this producer and is not subject to the usual access restrictions imposed on DOMDataTreeProducer state.
        Parameters:
        subtree - One of the subtrees to which are currently under control of this producer
        Returns:
        A shard access handle.
        Throws:
        NullPointerException - when subtree is null
        IllegalArgumentException - if the specified subtree is not controlled by this producer
        IllegalStateException - if this producer is no longer operational
        IllegalThreadStateException - if the access rules to this producer are violated, for example if this producer is bound and this thread is currently not executing from a listener context.