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
boolean	awaitReadiness()	Deprecated.
void	awaitReadiness(long timeout, TimeUnit unit)	Deprecated.
boolean	awaitReadiness(scala.concurrent.duration.Duration toWait)	Deprecated.
void	close()
final ActorUtils	getActorUtils()
protected final DataStoreClient	getClient()
protected AbstractShardManagerCreator<?>	getShardManagerCreator()
final ListenableFuture<?>	initialSettleFuture()	Future which completes when all shards settle for the first time.
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>	registerTreeChangeListener(YangInstanceIdentifier treeId, L listener)
void	setCloseable(AutoCloseable closeable)
void	waitTillReady()	Deprecated.

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 Details

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 Details

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 final ActorUtils getActorUtils()

Specified by:

getActorUtils in interface DistributedDataStoreInterface

waitTillReady

@Deprecated
public void waitTillReady()

Deprecated.

awaitReadiness

@Beta
@Deprecated
public boolean awaitReadiness()
                       throws InterruptedException

Deprecated.

Throws:

InterruptedException

awaitReadiness

@Beta
@Deprecated
public boolean awaitReadiness(scala.concurrent.duration.Duration toWait)
                       throws InterruptedException

Deprecated.

Throws:

InterruptedException

awaitReadiness

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

Deprecated.

Throws:

InterruptedException

TimeoutException

initialSettleFuture

public final ListenableFuture<?> initialSettleFuture()

Future which completes when all shards settle for the first time.

Returns:

A Listenable future.

registerProxyListener

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

Specified by:

registerProxyListener in interface DistributedDataStoreInterface