opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DatastoreContext.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.cluster.datastore;
  10
  11 import akka.util.Timeout;
  12 import java.util.concurrent.TimeUnit;
  13 import org.apache.commons.lang3.text.WordUtils;
  14 import org.opendaylight.controller.cluster.datastore.config.ConfigurationReader;
  15 import org.opendaylight.controller.cluster.datastore.config.FileConfigurationReader;
  16 import org.opendaylight.controller.cluster.raft.ConfigParams;
  17 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
  18 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreConfigProperties;
  19 import scala.concurrent.duration.Duration;
  20 import scala.concurrent.duration.FiniteDuration;
  21
  22 /**
  23  * Contains contextual data for a data store.
  24  *
  25  * @author Thomas Pantelis
  26  */
  27 public class DatastoreContext {
  28
  29     public static final Duration DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT = Duration.create(10, TimeUnit.MINUTES);
  30     public static final int DEFAULT_OPERATION_TIMEOUT_IN_SECONDS = 5;
  31     public static final int DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS = 30;
  32     public static final int DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE = 1000;
  33     public static final int DEFAULT_SNAPSHOT_BATCH_COUNT = 20000;
  34     public static final int DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS = 500;
  35     public static final int DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS = DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS * 10;
  36     public static final int DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY = 20000;
  37     public static final Timeout DEFAULT_SHARD_INITIALIZATION_TIMEOUT = new Timeout(5, TimeUnit.MINUTES);
  38     public static final Timeout DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT = new Timeout(30, TimeUnit.SECONDS);
  39     public static final boolean DEFAULT_PERSISTENT = true;
  40     public static final FileConfigurationReader DEFAULT_CONFIGURATION_READER = new FileConfigurationReader();
  41     public static final int DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE = 12;
  42     public static final int DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR = 2;
  43     public static final int DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT = 100;
  44     public static final String UNKNOWN_DATA_STORE_TYPE = "unknown";
  45     public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT= 100;
  46
  47     private InMemoryDOMDataStoreConfigProperties dataStoreProperties;
  48     private Duration shardTransactionIdleTimeout = DatastoreContext.DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT;
  49     private int operationTimeoutInSeconds = DEFAULT_OPERATION_TIMEOUT_IN_SECONDS;
  50     private String dataStoreMXBeanType;
  51     private int shardTransactionCommitTimeoutInSeconds = DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS;
  52     private int shardTransactionCommitQueueCapacity = DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY;
  53     private Timeout shardInitializationTimeout = DEFAULT_SHARD_INITIALIZATION_TIMEOUT;
  54     private Timeout shardLeaderElectionTimeout = DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT;
  55     private boolean persistent = DEFAULT_PERSISTENT;
  56     private ConfigurationReader configurationReader = DEFAULT_CONFIGURATION_READER;
  57     private long transactionCreationInitialRateLimit = DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT;
  58     private final DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
  59     private String dataStoreType = UNKNOWN_DATA_STORE_TYPE;
  60     private int shardBatchedModificationCount = DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT;
  61
  62     private DatastoreContext(){
  63         setShardJournalRecoveryLogBatchSize(DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE);
  64         setSnapshotBatchCount(DEFAULT_SNAPSHOT_BATCH_COUNT);
  65         setHeartbeatInterval(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS);
  66         setIsolatedLeaderCheckInterval(DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS);
  67         setSnapshotDataThresholdPercentage(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE);
  68     }
  69
  70     public static Builder newBuilder() {
  71         return new Builder();
  72     }
  73
  74     public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
  75         return dataStoreProperties;
  76     }
  77
  78     public Duration getShardTransactionIdleTimeout() {
  79         return shardTransactionIdleTimeout;
  80     }
  81
  82     public String getDataStoreMXBeanType() {
  83         return dataStoreMXBeanType;
  84     }
  85
  86     public int getOperationTimeoutInSeconds() {
  87         return operationTimeoutInSeconds;
  88     }
  89
  90     public ConfigParams getShardRaftConfig() {
  91         return raftConfig;
  92     }
  93
  94     public int getShardTransactionCommitTimeoutInSeconds() {
  95         return shardTransactionCommitTimeoutInSeconds;
  96     }
  97
  98     public int getShardTransactionCommitQueueCapacity() {
  99         return shardTransactionCommitQueueCapacity;
 100     }
 101
 102     public Timeout getShardInitializationTimeout() {
 103         return shardInitializationTimeout;
 104     }
 105
 106     public Timeout getShardLeaderElectionTimeout() {
 107         return shardLeaderElectionTimeout;
 108     }
 109
 110     public boolean isPersistent() {
 111         return persistent;
 112     }
 113
 114     public ConfigurationReader getConfigurationReader() {
 115         return configurationReader;
 116     }
 117
 118     public long getShardElectionTimeoutFactor(){
 119         return raftConfig.getElectionTimeoutFactor();
 120     }
 121
 122     public String getDataStoreType(){
 123         return dataStoreType;
 124     }
 125
 126     public long getTransactionCreationInitialRateLimit() {
 127         return transactionCreationInitialRateLimit;
 128     }
 129
 130     private void setHeartbeatInterval(long shardHeartbeatIntervalInMillis){
 131         raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
 132                 TimeUnit.MILLISECONDS));
 133     }
 134
 135     private void setShardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize){
 136         raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
 137     }
 138
 139
 140     private void setIsolatedLeaderCheckInterval(long shardIsolatedLeaderCheckIntervalInMillis) {
 141         raftConfig.setIsolatedLeaderCheckInterval(
 142                 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
 143     }
 144
 145     private void setElectionTimeoutFactor(long shardElectionTimeoutFactor) {
 146         raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
 147     }
 148
 149     private void setSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
 150         raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
 151     }
 152
 153     private void setSnapshotBatchCount(int shardSnapshotBatchCount) {
 154         raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
 155     }
 156
 157     public int getShardBatchedModificationCount() {
 158         return shardBatchedModificationCount;
 159     }
 160
 161     public static class Builder {
 162         private final DatastoreContext datastoreContext = new DatastoreContext();
 163
 164         public Builder shardTransactionIdleTimeout(Duration shardTransactionIdleTimeout) {
 165             datastoreContext.shardTransactionIdleTimeout = shardTransactionIdleTimeout;
 166             return this;
 167         }
 168
 169         public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
 170             datastoreContext.operationTimeoutInSeconds = operationTimeoutInSeconds;
 171             return this;
 172         }
 173
 174         public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
 175             datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
 176             return this;
 177         }
 178
 179         public Builder dataStoreProperties(InMemoryDOMDataStoreConfigProperties dataStoreProperties) {
 180             datastoreContext.dataStoreProperties = dataStoreProperties;
 181             return this;
 182         }
 183
 184         public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
 185             datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
 186             return this;
 187         }
 188
 189         public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
 190             datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
 191             return this;
 192         }
 193
 194         public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
 195             datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
 196             return this;
 197         }
 198
 199         public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
 200             datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
 201             return this;
 202         }
 203
 204         public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
 205             datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
 206             return this;
 207         }
 208
 209         public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
 210             datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
 211             return this;
 212         }
 213
 214         public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
 215             datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
 216             return this;
 217         }
 218
 219         public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
 220             datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
 221             return this;
 222         }
 223
 224         public Builder configurationReader(ConfigurationReader configurationReader){
 225             datastoreContext.configurationReader = configurationReader;
 226             return this;
 227         }
 228
 229         public Builder persistent(boolean persistent){
 230             datastoreContext.persistent = persistent;
 231             return this;
 232         }
 233
 234         public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
 235             datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
 236             return this;
 237         }
 238
 239         public Builder shardElectionTimeoutFactor(long shardElectionTimeoutFactor){
 240             datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
 241             return this;
 242         }
 243
 244         public Builder transactionCreationInitialRateLimit(long initialRateLimit){
 245             datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
 246             return this;
 247         }
 248
 249         public Builder dataStoreType(String dataStoreType){
 250             datastoreContext.dataStoreType = dataStoreType;
 251             datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreType) + "Datastore";
 252             return this;
 253         }
 254
 255         public Builder shardBatchedModificationCount(int shardBatchedModificationCount) {
 256             datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
 257             return this;
 258         }
 259
 260         public DatastoreContext build() {
 261             return datastoreContext;
 262         }
 263     }
 264 }