Package org.opendaylight.controller.cluster.datastore

Class AbstractDataStore

java.lang.Object

org.opendaylight.controller.cluster.datastore.AbstractDataStore

All Implemented Interfaces:

AutoCloseable, EventListener, DatastoreContextPropertiesUpdater.Listener, DistributedDataStoreInterface, DOMDataBrokerExtension, DOMDataTreeCommitCohortRegistry, DOMServiceExtension<DOMDataBroker,DOMDataBrokerExtension>, DOMStore, DOMStoreTransactionFactory, DOMStoreTreeChangePublisher, EffectiveModelContextListener

Direct Known Subclasses:

ClientBackedDataStore, DistributedDataStore

public abstract class AbstractDataStore
extends Object
implements DistributedDataStoreInterface, EffectiveModelContextListener, DatastoreContextPropertiesUpdater.Listener, DOMStoreTreeChangePublisher, DOMDataTreeCommitCohortRegistry, AutoCloseable

Base implementation of a distributed DOMStore.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDataStore(ActorSystem actorSystem, ClusterWrapper cluster, Configuration configuration, DatastoreContextFactory datastoreContextFactory, DatastoreSnapshot restoreFromSnapshot)
protected	AbstractDataStore(ActorUtils actorUtils, ClientIdentifier identifier)
protected	AbstractDataStore(ActorUtils actorUtils, ClientIdentifier identifier, DataStoreClient clientActor)

Method Summary

Modifier and Type	Method	Description
void	awaitReadiness(long timeout, TimeUnit unit)
void	close()
ActorUtils	getActorUtils()
protected DataStoreClient	getClient()
protected AbstractShardManagerCreator<?>	getShardManagerCreator()
CountDownLatch	getWaitTillReadyCountDownLatch()
void	onDatastoreContextUpdated(DatastoreContextFactory contextFactory)
void	onModelContextUpdated(EffectiveModelContext newModelContext)
<C extends DOMDataTreeCommitCohort> DOMDataTreeCommitCohortRegistration<C>	registerCommitCohort(DOMDataTreeIdentifier subtree, C cohort)
<L extends DOMDataTreeChangeListener> ListenerRegistration<L>	registerProxyListener(YangInstanceIdentifier shardLookup, YangInstanceIdentifier insideShard, DOMDataTreeChangeListener delegate)
<L extends DOMDataTreeChangeListener> ListenerRegistration<L>	registerShardConfigListener(YangInstanceIdentifier internalPath, DOMDataTreeChangeListener delegate)
<L extends DOMDataTreeChangeListener> ListenerRegistration<L>	registerTreeChangeListener(YangInstanceIdentifier treeId, L listener)
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.mdsal.dom.spi.store.DOMStore

createTransactionChain

Methods inherited from interface org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionFactory

newReadOnlyTransaction, newReadWriteTransaction, newWriteOnlyTransaction

Constructor Detail

AbstractDataStore

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

AbstractDataStore

protected AbstractDataStore(ActorUtils actorUtils,
                            ClientIdentifier identifier)

AbstractDataStore

protected AbstractDataStore(ActorUtils actorUtils,
                            ClientIdentifier identifier,
                            DataStoreClient clientActor)

Method Detail

getShardManagerCreator

protected AbstractShardManagerCreator<?> getShardManagerCreator()

getClient

protected final DataStoreClient getClient()

setCloseable

public void setCloseable(AutoCloseable closeable)

registerTreeChangeListener

public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerTreeChangeListener(YangInstanceIdentifier treeId,
                                                                                                L listener)

Specified by:

registerTreeChangeListener in interface DOMStoreTreeChangePublisher

registerCommitCohort

public <C extends DOMDataTreeCommitCohort> DOMDataTreeCommitCohortRegistration<C> registerCommitCohort(DOMDataTreeIdentifier subtree,
                                                                                                       C cohort)

Specified by:

registerCommitCohort in interface DOMDataTreeCommitCohortRegistry

onModelContextUpdated

public void onModelContextUpdated(EffectiveModelContext newModelContext)

Specified by:

onModelContextUpdated in interface EffectiveModelContextListener

onDatastoreContextUpdated

public void onDatastoreContextUpdated(DatastoreContextFactory contextFactory)

Specified by:

onDatastoreContextUpdated in interface DatastoreContextPropertiesUpdater.Listener

close

public void close()

Specified by:

close in interface AutoCloseable

getActorUtils

public ActorUtils getActorUtils()

Specified by:

getActorUtils in interface DistributedDataStoreInterface

waitTillReady

public void waitTillReady()

awaitReadiness

@Beta
public void awaitReadiness(long timeout,
                           TimeUnit unit)
                    throws InterruptedException,
                           TimeoutException

Throws:

InterruptedException

TimeoutException

getWaitTillReadyCountDownLatch

public CountDownLatch getWaitTillReadyCountDownLatch()

registerProxyListener

public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerProxyListener(YangInstanceIdentifier shardLookup,
                                                                                           YangInstanceIdentifier insideShard,
                                                                                           DOMDataTreeChangeListener delegate)

registerShardConfigListener

public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerShardConfigListener(YangInstanceIdentifier internalPath,
                                                                                                 DOMDataTreeChangeListener delegate)