Package org.opendaylight.controller.cluster.datastore

Class AbstractDataStore

java.lang.Object

org.opendaylight.controller.cluster.datastore.AbstractDataStore

All Implemented Interfaces:

AutoCloseable, DatastoreContextPropertiesUpdater.Listener, DistributedDataStoreInterface, DOMDataBroker.CommitCohortExtension, DOMDataBroker.Extension, DOMService.Extension<DOMDataBroker,DOMDataBroker.Extension>, DOMStore, DOMStoreTransactionFactory, DOMStoreTreeChangePublisher, ObjectExtension<DOMDataBroker,DOMDataBroker.Extension>

Direct Known Subclasses:

ClientBackedDataStore

public abstract class AbstractDataStore
extends Object
implements DistributedDataStoreInterface, DatastoreContextPropertiesUpdater.Listener, DOMStoreTreeChangePublisher, DOMDataBroker.CommitCohortExtension, AutoCloseable

Base implementation of a distributed DOMStore.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final boolean	awaitReadiness()	Deprecated.
final void	awaitReadiness(long timeout, TimeUnit unit)	Deprecated.
final boolean	awaitReadiness(scala.concurrent.duration.Duration toWait)	Deprecated.
final 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.
final void	onDatastoreContextUpdated(DatastoreContextFactory contextFactory)
void	onModelContextUpdated(EffectiveModelContext newModelContext)
final SettableFuture<Empty>	readinessFuture()
Registration	registerCommitCohort(DOMDataTreeIdentifier subtree, DOMDataTreeCommitCohort cohort)
final Registration	registerLegacyTreeChangeListener(YangInstanceIdentifier treeId, DOMDataTreeChangeListener listener)	Deprecated, for removal: This API element is subject to removal in a future version.
final Registration	registerProxyListener(YangInstanceIdentifier shardLookup, YangInstanceIdentifier insideShard, DOMDataTreeChangeListener delegate)
final Registration	registerTreeChangeListener(YangInstanceIdentifier treeId, DOMDataTreeChangeListener listener)
void	setCloseable(AutoCloseable closeable)
final 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(Path stateDir,
 ActorSystem actorSystem,
 ClusterWrapper cluster,
 Configuration configuration,
 DatastoreContextFactory datastoreContextFactory,
 DatastoreSnapshot restoreFromSnapshot)

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 final Registration registerTreeChangeListener(YangInstanceIdentifier treeId,
 DOMDataTreeChangeListener listener)

Specified by:

registerTreeChangeListener in interface DOMStoreTreeChangePublisher

registerLegacyTreeChangeListener

@Deprecated(since="9.0.0",
            forRemoval=true)
public final Registration registerLegacyTreeChangeListener(YangInstanceIdentifier treeId,
 DOMDataTreeChangeListener listener)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

registerLegacyTreeChangeListener in interface DOMStoreTreeChangePublisher

registerCommitCohort

public Registration registerCommitCohort(DOMDataTreeIdentifier subtree,
 DOMDataTreeCommitCohort cohort)

Specified by:

registerCommitCohort in interface DOMDataBroker.CommitCohortExtension

onModelContextUpdated

public void onModelContextUpdated(EffectiveModelContext newModelContext)

onDatastoreContextUpdated

public final void onDatastoreContextUpdated(DatastoreContextFactory contextFactory)

Specified by:

onDatastoreContextUpdated in interface DatastoreContextPropertiesUpdater.Listener

close

public final void close()

Specified by:

close in interface AutoCloseable

getActorUtils

public final ActorUtils getActorUtils()

Specified by:

getActorUtils in interface DistributedDataStoreInterface

waitTillReady

@Deprecated
public final void waitTillReady()

Deprecated.

awaitReadiness

@Beta
@Deprecated
public final boolean awaitReadiness()
                             throws InterruptedException

Deprecated.

Throws:

InterruptedException

awaitReadiness

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

Deprecated.

Throws:

InterruptedException

awaitReadiness

@Beta
@Deprecated
public final 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.

readinessFuture

public final SettableFuture<Empty> readinessFuture()

registerProxyListener

public final Registration registerProxyListener(YangInstanceIdentifier shardLookup,
 YangInstanceIdentifier insideShard,
 DOMDataTreeChangeListener delegate)

Specified by:

registerProxyListener in interface DistributedDataStoreInterface