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, 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.mdsal.dom.spi.store.DOMStore, org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionFactory, org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher, org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener

Direct Known Subclasses:

ClientBackedDataStore, DistributedDataStore

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

Base implementation of a distributed DOMStore.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDataStore(akka.actor.ActorSystem actorSystem, ClusterWrapper cluster, Configuration configuration, DatastoreContextFactory datastoreContextFactory, DatastoreSnapshot restoreFromSnapshot)
protected	AbstractDataStore(ActorUtils actorUtils, org.opendaylight.controller.cluster.access.concepts.ClientIdentifier identifier)
protected	AbstractDataStore(ActorUtils actorUtils, org.opendaylight.controller.cluster.access.concepts.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()
ActorUtils	getActorUtils()
protected DataStoreClient	getClient()
protected AbstractShardManagerCreator<?>	getShardManagerCreator()
com.google.common.util.concurrent.ListenableFuture<?>	initialSettleFuture()	Future which completes when all shards settle for the first time.
void	onDatastoreContextUpdated(DatastoreContextFactory contextFactory)
void	onModelContextUpdated(org.opendaylight.yangtools.yang.model.api.EffectiveModelContext newModelContext)
<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 org.opendaylight.mdsal.dom.api.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 org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerTreeChangeListener(org.opendaylight.yangtools.yang.data.api.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 Detail

AbstractDataStore

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

AbstractDataStore

protected AbstractDataStore(ActorUtils actorUtils,
                            org.opendaylight.controller.cluster.access.concepts.ClientIdentifier identifier)

AbstractDataStore

protected AbstractDataStore(ActorUtils actorUtils,
                            org.opendaylight.controller.cluster.access.concepts.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 org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerTreeChangeListener(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier treeId,
                                                                                                                                                                   L listener)

Specified by:

registerTreeChangeListener in interface org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher

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

onModelContextUpdated

public void onModelContextUpdated(org.opendaylight.yangtools.yang.model.api.EffectiveModelContext newModelContext)

Specified by:

onModelContextUpdated in interface org.opendaylight.yangtools.yang.model.api.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

@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 com.google.common.util.concurrent.ListenableFuture<?> initialSettleFuture()

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

Returns:

A Listenable future.

registerProxyListener

public <L extends org.opendaylight.mdsal.dom.api.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)

Specified by:

registerProxyListener in interface DistributedDataStoreInterface