Package 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

  • Field Details

    • METRICS_DOMAIN

      public static final String METRICS_DOMAIN
      See Also:

    • DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT

      public static final Duration DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT

    • DEFAULT_OPERATION_TIMEOUT_IN_MS

      public static final int DEFAULT_OPERATION_TIMEOUT_IN_MS
      See Also:

    • DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS

      public static final int DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS
      See Also:

    • DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE

      public static final int DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE
      See Also:

    • DEFAULT_SNAPSHOT_BATCH_COUNT

      public static final int DEFAULT_SNAPSHOT_BATCH_COUNT
      See Also:

    • DEFAULT_RECOVERY_SNAPSHOT_INTERVAL_SECONDS

      public static final int DEFAULT_RECOVERY_SNAPSHOT_INTERVAL_SECONDS
      See Also:

    • DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS

      public static final int DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS
      See Also:

    • DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS

      public static final int DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS
      See Also:

    • DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY

      public static final int DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY
      See Also:

    • DEFAULT_SHARD_INITIALIZATION_TIMEOUT

      public static final Timeout DEFAULT_SHARD_INITIALIZATION_TIMEOUT

    • DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT

      public static final Timeout DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT

    • DEFAULT_INITIAL_SETTLE_TIMEOUT_MULTIPLIER

      public static final int DEFAULT_INITIAL_SETTLE_TIMEOUT_MULTIPLIER
      See Also:

    • DEFAULT_PERSISTENT

      public static final boolean DEFAULT_PERSISTENT
      See Also:

    • DEFAULT_SNAPSHOT_ON_ROOT_OVERWRITE

      public static final boolean DEFAULT_SNAPSHOT_ON_ROOT_OVERWRITE
      See Also:

    • 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:

    • DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD

      public static final int DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD
      See Also:

    • DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR

      public static final int DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR
      See Also:

    • DEFAULT_SHARD_CANDIDATE_ELECTION_TIMEOUT_DIVISOR

      public static final int DEFAULT_SHARD_CANDIDATE_ELECTION_TIMEOUT_DIVISOR
      See Also:

    • UNKNOWN_DATA_STORE_TYPE

      public static final String UNKNOWN_DATA_STORE_TYPE
      See Also:

    • DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT

      public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT
      See Also:

    • 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:

    • DEFAULT_INITIAL_PAYLOAD_SERIALIZED_BUFFER_CAPACITY

      public static final int DEFAULT_INITIAL_PAYLOAD_SERIALIZED_BUFFER_CAPACITY
      See Also:

    • DEFAULT_EXPORT_ON_RECOVERY

      public static final DataStoreProperties.ExportOnRecovery DEFAULT_EXPORT_ON_RECOVERY

    • DEFAULT_RECOVERY_EXPORT_BASE_DIR

      public static final String DEFAULT_RECOVERY_EXPORT_BASE_DIR
      See Also:

    • DEFAULT_SYNC_INDEX_THRESHOLD

      public static final long DEFAULT_SYNC_INDEX_THRESHOLD
      See Also:

  • Method Details

    • newBuilder

      public static final DatastoreContext.Builder newBuilder()

    • newBuilder

      public static final DatastoreContext.Builder newBuilder(RaftPolicyResolver raftPolicyResolver)

    • newBuilderFrom

      public static final DatastoreContext.Builder newBuilderFrom(DatastoreContext context)

    • getShardTransactionIdleTimeout

      public Duration getShardTransactionIdleTimeout()

    • getDataStoreMXBeanType

      public String getDataStoreMXBeanType()

    • getOperationTimeoutInMillis

      public long getOperationTimeoutInMillis()

    • getShardRaftConfig

      public ConfigParams getShardRaftConfig()

    • getShardTransactionCommitTimeoutInSeconds

      public int getShardTransactionCommitTimeoutInSeconds()

    • getShardTransactionCommitQueueCapacity

      public int getShardTransactionCommitQueueCapacity()

    • getShardInitializationTimeout

      public Timeout getShardInitializationTimeout()

    • getShardLeaderElectionTimeout

      public Timeout getShardLeaderElectionTimeout()

    • getInitialSettleTimeoutMultiplier

      public int getInitialSettleTimeoutMultiplier()
      Return the multiplier of getShardLeaderElectionTimeout() which the frontend will wait for all shards on the local node to settle.
      Returns:
      Non-negative multiplier. Value of 0 indicates to wait indefinitely.

    • isPersistent

      public boolean isPersistent()

    • isSnapshotOnRootOverwrite

      public boolean isSnapshotOnRootOverwrite()

    • getConfigurationReader

      public AkkaConfigurationReader getConfigurationReader()

    • getShardElectionTimeoutFactor

      public long getShardElectionTimeoutFactor()

    • getDataStoreName

      public String getDataStoreName()

    • getLogicalStoreType

      public LogicalDatastoreType getLogicalStoreType()

    • getStoreRoot

      public YangInstanceIdentifier getStoreRoot()

    • getShardManagerPersistenceId

      public String getShardManagerPersistenceId()

    • getTempFileDirectory

      public Path 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()

    • isUseLz4Compression

      public boolean isUseLz4Compression()

    • getExportOnRecovery

      public DataStoreProperties.ExportOnRecovery getExportOnRecovery()

    • getRecoveryExportBaseDir

      public String getRecoveryExportBaseDir()

    • 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()