org.opendaylight.controller.cluster.datastore

Class DatastoreContext

java.lang.Object

org.opendaylight.controller.cluster.datastore.DatastoreContext

All Implemented Interfaces:

ClientActorConfig

public class DatastoreContext
extends Object
implements ClientActorConfig

Contains contextual data for a data store.

Author:

Thomas Pantelis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatastoreContext.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static FileAkkaConfigurationReader	DEFAULT_CONFIGURATION_READER
static int	DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS
static int	DEFAULT_INITIAL_PAYLOAD_SERIALIZED_BUFFER_CAPACITY
static int	DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS
static int	DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE
static int	DEFAULT_MAX_MESSAGE_SLICE_SIZE
static int	DEFAULT_OPERATION_TIMEOUT_IN_MS
static boolean	DEFAULT_PERSISTENT
static int	DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT
static long	DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS
static int	DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR
static akka.util.Timeout	DEFAULT_SHARD_INITIALIZATION_TIMEOUT
static akka.util.Timeout	DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT
static int	DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE
static scala.concurrent.duration.Duration	DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT
static int	DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY
static int	DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS
static int	DEFAULT_SNAPSHOT_BATCH_COUNT
static long	DEFAULT_SYNC_INDEX_THRESHOLD
static int	DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT
static String	METRICS_DOMAIN
static String	UNKNOWN_DATA_STORE_TYPE

Method Summary

Modifier and Type	Method and Description
long	getBackendAlivenessTimerInterval() Returns the timer interval whereby, on expiration after response inactivity from the back-end, the connection to the back-end is torn down and reconnection is attempted.
AkkaConfigurationReader	getConfigurationReader()
String	getDataStoreMXBeanType()
String	getDataStoreName()
org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataStoreConfigProperties	getDataStoreProperties()
int	getFileBackedStreamingThreshold() Returns the threshold in bytes before switching from storing in memory to buffering to a file when streaming large amounts of data.
static Set<String>	getGlobalDatastoreNames()
int	getInitialPayloadSerializedBufferCapacity()
org.opendaylight.mdsal.common.api.LogicalDatastoreType	getLogicalStoreType()
int	getMaximumMessageSliceSize() Returns the maximum size in bytes for a message slice when fragmenting messages thru the akka remoting framework.
long	getNoProgressTimeout() Returns the timeout interval whereby the client front-end hasn't made progress with the back-end on any request and terminates.
long	getOperationTimeoutInMillis()
long	getRequestTimeout() Returns the timeout interval whereby requests are failed.
int	getShardBatchedModificationCount()
long	getShardCommitQueueExpiryTimeoutInMillis()
long	getShardElectionTimeoutFactor()
akka.util.Timeout	getShardInitializationTimeout()
akka.util.Timeout	getShardLeaderElectionTimeout()
String	getShardManagerPersistenceId()
ConfigParams	getShardRaftConfig()
int	getShardTransactionCommitQueueCapacity()
int	getShardTransactionCommitTimeoutInSeconds()
scala.concurrent.duration.Duration	getShardTransactionIdleTimeout()
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	getStoreRoot()
String	getTempFileDirectory() Returns the directory in which to create temporary files.
long	getTransactionCreationInitialRateLimit()
boolean	isPersistent()
boolean	isTransactionDebugContextEnabled()
boolean	isUseTellBasedProtocol()
boolean	isWriteOnlyTransactionOptimizationsEnabled()
static DatastoreContext.Builder	newBuilder()
static DatastoreContext.Builder	newBuilderFrom(DatastoreContext context)

Methods inherited from class java.lang.Object

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

Field Detail

METRICS_DOMAIN

public static final String METRICS_DOMAIN

See Also:

Constant Field Values

DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT

public static final scala.concurrent.duration.Duration DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT

DEFAULT_OPERATION_TIMEOUT_IN_MS

public static final int DEFAULT_OPERATION_TIMEOUT_IN_MS

See Also:

Constant Field Values

DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS

public static final int DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS

See Also:

Constant Field Values

DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE

public static final int DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE

See Also:

Constant Field Values

DEFAULT_SNAPSHOT_BATCH_COUNT

public static final int DEFAULT_SNAPSHOT_BATCH_COUNT

See Also:

Constant Field Values

DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS

public static final int DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS

See Also:

Constant Field Values

DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS

public static final int DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS

See Also:

Constant Field Values

DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY

public static final int DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY

See Also:

Constant Field Values

DEFAULT_SHARD_INITIALIZATION_TIMEOUT

public static final akka.util.Timeout DEFAULT_SHARD_INITIALIZATION_TIMEOUT

DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT

public static final akka.util.Timeout DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT

DEFAULT_PERSISTENT

public static final boolean DEFAULT_PERSISTENT

See Also:

Constant Field Values

DEFAULT_CONFIGURATION_READER

public static final FileAkkaConfigurationReader DEFAULT_CONFIGURATION_READER

DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE

public static final int DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE

See Also:

Constant Field Values

DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR

public static final int DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR

See Also:

Constant Field Values

DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT

public static final int DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT

See Also:

Constant Field Values

UNKNOWN_DATA_STORE_TYPE

public static final String UNKNOWN_DATA_STORE_TYPE

See Also:

Constant Field Values

DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT

public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT

See Also:

Constant Field Values

DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS

public static final long DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS

DEFAULT_MAX_MESSAGE_SLICE_SIZE

public static final int DEFAULT_MAX_MESSAGE_SLICE_SIZE

See Also:

Constant Field Values

DEFAULT_INITIAL_PAYLOAD_SERIALIZED_BUFFER_CAPACITY

public static final int DEFAULT_INITIAL_PAYLOAD_SERIALIZED_BUFFER_CAPACITY

See Also:

Constant Field Values

DEFAULT_SYNC_INDEX_THRESHOLD

public static final long DEFAULT_SYNC_INDEX_THRESHOLD

See Also:

Constant Field Values

Method Detail

getGlobalDatastoreNames

public static Set<String> getGlobalDatastoreNames()

newBuilder

public static DatastoreContext.Builder newBuilder()

newBuilderFrom

public static DatastoreContext.Builder newBuilderFrom(DatastoreContext context)

getDataStoreProperties

public org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataStoreConfigProperties getDataStoreProperties()

getShardTransactionIdleTimeout

public scala.concurrent.duration.Duration getShardTransactionIdleTimeout()

getDataStoreMXBeanType

public String getDataStoreMXBeanType()

getOperationTimeoutInMillis

public long getOperationTimeoutInMillis()

getShardRaftConfig

public ConfigParams getShardRaftConfig()

getShardTransactionCommitTimeoutInSeconds

public int getShardTransactionCommitTimeoutInSeconds()

getShardTransactionCommitQueueCapacity

public int getShardTransactionCommitQueueCapacity()

getShardInitializationTimeout

public akka.util.Timeout getShardInitializationTimeout()

getShardLeaderElectionTimeout

public akka.util.Timeout getShardLeaderElectionTimeout()

isPersistent

public boolean isPersistent()

getConfigurationReader

public AkkaConfigurationReader getConfigurationReader()

getShardElectionTimeoutFactor

public long getShardElectionTimeoutFactor()

getDataStoreName

public String getDataStoreName()

getLogicalStoreType

public org.opendaylight.mdsal.common.api.LogicalDatastoreType getLogicalStoreType()

getStoreRoot

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier getStoreRoot()

getTransactionCreationInitialRateLimit

public long getTransactionCreationInitialRateLimit()

getShardManagerPersistenceId

public String getShardManagerPersistenceId()

getTempFileDirectory

public String getTempFileDirectory()

Description copied from interface: ClientActorConfig

Returns the directory in which to create temporary files.

Specified by:

getTempFileDirectory in interface ClientActorConfig

Returns:

the directory name

getFileBackedStreamingThreshold

public int getFileBackedStreamingThreshold()

Description copied from interface: ClientActorConfig

Returns the threshold in bytes before switching from storing in memory to buffering to a file when streaming large amounts of data.

Specified by:

getFileBackedStreamingThreshold in interface ClientActorConfig

Returns:

the threshold in bytes

getShardBatchedModificationCount

public int getShardBatchedModificationCount()

isWriteOnlyTransactionOptimizationsEnabled

public boolean isWriteOnlyTransactionOptimizationsEnabled()

getShardCommitQueueExpiryTimeoutInMillis

public long getShardCommitQueueExpiryTimeoutInMillis()

isTransactionDebugContextEnabled

public boolean isTransactionDebugContextEnabled()

isUseTellBasedProtocol

public boolean isUseTellBasedProtocol()

getMaximumMessageSliceSize

public int getMaximumMessageSliceSize()

Description copied from interface: ClientActorConfig

Returns the maximum size in bytes for a message slice when fragmenting messages thru the akka remoting framework.

Specified by:

getMaximumMessageSliceSize in interface ClientActorConfig

Returns:

the maximum size in bytes

getBackendAlivenessTimerInterval

public long getBackendAlivenessTimerInterval()

Description copied from interface: ClientActorConfig

Returns the timer interval whereby, on expiration after response inactivity from the back-end, the connection to the back-end is torn down and reconnection is attempted.

Specified by:

getBackendAlivenessTimerInterval in interface ClientActorConfig

Returns:

timer interval in nanoseconds.

getRequestTimeout

public long getRequestTimeout()

Description copied from interface: ClientActorConfig

Returns the timeout interval whereby requests are failed.

Specified by:

getRequestTimeout in interface ClientActorConfig

Returns:

the timeout interval in nanoseconds.

getNoProgressTimeout

public long getNoProgressTimeout()

Description copied from interface: ClientActorConfig

Returns the timeout interval whereby the client front-end hasn't made progress with the back-end on any request and terminates.

Specified by:

getNoProgressTimeout in interface ClientActorConfig

Returns:

the timeout interval in nanoseconds.

getInitialPayloadSerializedBufferCapacity

public int getInitialPayloadSerializedBufferCapacity()