org.opendaylight.controller.cluster.datastore

Class AbstractDataStore

java.lang.Object

org.opendaylight.controller.cluster.datastore.AbstractDataStore

All Implemented Interfaces:

AutoCloseable, EventListener, DatastoreContextPropertiesUpdater.Listener, DistributedDataStoreInterface, DOMStore, DOMStoreTransactionFactory, DOMStoreTreeChangePublisher, org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension, org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry, org.opendaylight.mdsal.dom.api.DOMServiceExtension<org.opendaylight.mdsal.dom.api.DOMDataBroker,org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension>, org.opendaylight.yangtools.yang.model.api.SchemaContextListener

Direct Known Subclasses:

ClientBackedDataStore, DistributedDataStore

public abstract class AbstractDataStore
extends Object
implements DistributedDataStoreInterface, org.opendaylight.yangtools.yang.model.api.SchemaContextListener, DatastoreContextPropertiesUpdater.Listener, DOMStoreTreeChangePublisher, org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry, AutoCloseable

Base implementation of a distributed DOMStore.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDataStore(ActorContext actorContext, ClientIdentifier identifier)
protected	AbstractDataStore(ActorContext actorContext, ClientIdentifier identifier, DataStoreClient clientActor)
protected	AbstractDataStore(akka.actor.ActorSystem actorSystem, ClusterWrapper cluster, Configuration configuration, DatastoreContextFactory datastoreContextFactory, DatastoreSnapshot restoreFromSnapshot)

Method Summary

Modifier and Type	Method and Description
void	close()
ActorContext	getActorContext()
protected DataStoreClient	getClient()
CountDownLatch	getWaitTillReadyCountDownLatch()
void	onDatastoreContextUpdated(DatastoreContextFactory contextFactory)
void	onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)
<L extends AsyncDataChangeListener<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, L listener, AsyncDataBroker.DataChangeScope scope) Registers AsyncDataChangeListener for Data Change callbacks which will be triggered on the change of provided subpath.
<C extends org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort> org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistration<C>	registerCommitCohort(org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier subtree, C cohort)
<L extends DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerProxyListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier shardLookup, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier insideShard, org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener delegate)
<L extends DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerShardConfigListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier internalPath, DOMDataTreeChangeListener delegate)
<L extends DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerTreeChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier treeId, L listener) Registers a DOMDataTreeChangeListener to receive notifications when data changes under a given path in the conceptual data tree.
void	setCloseable(AutoCloseable closeable)
void	waitTillReady()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.controller.sal.core.spi.data.DOMStore

createTransactionChain

Methods inherited from interface org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory

newReadOnlyTransaction, newReadWriteTransaction, newWriteOnlyTransaction

Constructor Detail

AbstractDataStore

protected AbstractDataStore(akka.actor.ActorSystem actorSystem,
                            ClusterWrapper cluster,
                            Configuration configuration,
                            DatastoreContextFactory datastoreContextFactory,
                            DatastoreSnapshot restoreFromSnapshot)

AbstractDataStore

protected AbstractDataStore(ActorContext actorContext,
                            ClientIdentifier identifier)

AbstractDataStore

protected AbstractDataStore(ActorContext actorContext,
                            ClientIdentifier identifier,
                            DataStoreClient clientActor)

Method Detail

getClient

protected final DataStoreClient getClient()

setCloseable

public void setCloseable(AutoCloseable closeable)

registerChangeListener

public <L extends AsyncDataChangeListener<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path,
                                                                                                                                                                                                                                                                   L listener,
                                                                                                                                                                                                                                                                   AsyncDataBroker.DataChangeScope scope)

Description copied from interface: DOMStore

Registers AsyncDataChangeListener for Data Change callbacks which will be triggered on the change of provided subpath. What constitutes a change depends on the @scope parameter. Listener upon registration receives an initial callback AsyncDataChangeListener.onDataChanged(org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent) which contains stable view of data tree at the time of registration. @param path Path (subtree identifier) on which client listener will be invoked.

Specified by:

registerChangeListener in interface DOMStore

listener - Instance of listener which should be invoked on

scope - Scope of change which triggers callback.

Returns:

Listener Registration object, which client may use to close registration / interest on receiving data changes.

registerTreeChangeListener

public <L extends DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerTreeChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier treeId,
                                                                                                                                    L listener)

Description copied from interface: DOMStoreTreeChangePublisher

Registers a DOMDataTreeChangeListener to receive notifications when data changes under a given path in the conceptual data tree.

You are able to register for notifications for any node or subtree which can be represented using YangInstanceIdentifier.

You are able to register for data change notifications for a subtree or leaf even if it does not exist. You will receive notification once that node is created.

If there is any pre-existing data in data tree on path for which you are registering, you will receive initial data change event, which will contain all pre-existing data, marked as created.

This method returns a ListenerRegistration object. To "unregister" your listener for changes call the ListenerRegistration.close() method on this returned object.

You MUST explicitly unregister your listener when you no longer want to receive notifications. This is especially true in OSGi environments, where failure to do so during bundle shutdown can lead to stale listeners being still registered.

Specified by:

registerTreeChangeListener in interface DOMStoreTreeChangePublisher

Parameters:

treeId - Data tree identifier of the subtree which should be watched for changes.

listener - Listener instance which is being registered

Returns:

Listener registration object, which may be used to unregister your listener using ListenerRegistration.close() to stop delivery of change events.

registerCommitCohort

public <C extends org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort> org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistration<C> registerCommitCohort(org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier subtree,
                                                                                                                                                                     C cohort)

Specified by:

registerCommitCohort in interface org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry

onGlobalContextUpdated

public void onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

Specified by:

onGlobalContextUpdated in interface org.opendaylight.yangtools.yang.model.api.SchemaContextListener

onDatastoreContextUpdated

public void onDatastoreContextUpdated(DatastoreContextFactory contextFactory)

Specified by:

onDatastoreContextUpdated in interface DatastoreContextPropertiesUpdater.Listener

close

public void close()

Specified by:

close in interface AutoCloseable

getActorContext

public ActorContext getActorContext()

Specified by:

getActorContext in interface DistributedDataStoreInterface

waitTillReady

public void waitTillReady()

getWaitTillReadyCountDownLatch

public CountDownLatch getWaitTillReadyCountDownLatch()

registerProxyListener

public <L extends DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerProxyListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier shardLookup,
                                                                                                                               org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier insideShard,
                                                                                                                               org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener delegate)

registerShardConfigListener

public <L extends DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerShardConfigListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier internalPath,
                                                                                                                                     DOMDataTreeChangeListener delegate)