2 * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.cluster.datastore;
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;
23 * Contains contextual data for a data store.
25 * @author Thomas Pantelis
27 public class DatastoreContext {
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";
46 private InMemoryDOMDataStoreConfigProperties dataStoreProperties;
47 private Duration shardTransactionIdleTimeout = DatastoreContext.DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT;
48 private int operationTimeoutInSeconds = DEFAULT_OPERATION_TIMEOUT_IN_SECONDS;
49 private String dataStoreMXBeanType;
50 private int shardTransactionCommitTimeoutInSeconds = DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS;
51 private int shardTransactionCommitQueueCapacity = DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY;
52 private Timeout shardInitializationTimeout = DEFAULT_SHARD_INITIALIZATION_TIMEOUT;
53 private Timeout shardLeaderElectionTimeout = DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT;
54 private boolean persistent = DEFAULT_PERSISTENT;
55 private ConfigurationReader configurationReader = DEFAULT_CONFIGURATION_READER;
56 private long transactionCreationInitialRateLimit = DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT;
57 private DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
58 private String dataStoreType = UNKNOWN_DATA_STORE_TYPE;
60 private DatastoreContext(){
61 setShardJournalRecoveryLogBatchSize(DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE);
62 setSnapshotBatchCount(DEFAULT_SNAPSHOT_BATCH_COUNT);
63 setHeartbeatInterval(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS);
64 setIsolatedLeaderCheckInterval(DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS);
65 setSnapshotDataThresholdPercentage(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE);
68 public static Builder newBuilder() {
72 public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
73 return dataStoreProperties;
76 public Duration getShardTransactionIdleTimeout() {
77 return shardTransactionIdleTimeout;
80 public String getDataStoreMXBeanType() {
81 return dataStoreMXBeanType;
84 public int getOperationTimeoutInSeconds() {
85 return operationTimeoutInSeconds;
88 public ConfigParams getShardRaftConfig() {
92 public int getShardTransactionCommitTimeoutInSeconds() {
93 return shardTransactionCommitTimeoutInSeconds;
96 public int getShardTransactionCommitQueueCapacity() {
97 return shardTransactionCommitQueueCapacity;
100 public Timeout getShardInitializationTimeout() {
101 return shardInitializationTimeout;
104 public Timeout getShardLeaderElectionTimeout() {
105 return shardLeaderElectionTimeout;
108 public boolean isPersistent() {
112 public ConfigurationReader getConfigurationReader() {
113 return configurationReader;
116 public long getShardElectionTimeoutFactor(){
117 return raftConfig.getElectionTimeoutFactor();
120 public String getDataStoreType(){
121 return dataStoreType;
124 public long getTransactionCreationInitialRateLimit() {
125 return transactionCreationInitialRateLimit;
128 private void setHeartbeatInterval(long shardHeartbeatIntervalInMillis){
129 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
130 TimeUnit.MILLISECONDS));
133 private void setShardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize){
134 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
138 private void setIsolatedLeaderCheckInterval(long shardIsolatedLeaderCheckIntervalInMillis) {
139 raftConfig.setIsolatedLeaderCheckInterval(
140 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
143 private void setElectionTimeoutFactor(long shardElectionTimeoutFactor) {
144 raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
147 private void setSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
148 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
151 private void setSnapshotBatchCount(int shardSnapshotBatchCount) {
152 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
155 public static class Builder {
156 private DatastoreContext datastoreContext = new DatastoreContext();
158 public Builder shardTransactionIdleTimeout(Duration shardTransactionIdleTimeout) {
159 datastoreContext.shardTransactionIdleTimeout = shardTransactionIdleTimeout;
163 public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
164 datastoreContext.operationTimeoutInSeconds = operationTimeoutInSeconds;
168 public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
169 datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
173 public Builder dataStoreProperties(InMemoryDOMDataStoreConfigProperties dataStoreProperties) {
174 datastoreContext.dataStoreProperties = dataStoreProperties;
178 public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
179 datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
183 public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
184 datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
188 public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
189 datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
193 public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
194 datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
198 public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
199 datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
203 public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
204 datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
208 public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
209 datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
213 public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
214 datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
218 public Builder configurationReader(ConfigurationReader configurationReader){
219 datastoreContext.configurationReader = configurationReader;
223 public Builder persistent(boolean persistent){
224 datastoreContext.persistent = persistent;
228 public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
229 datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
233 public Builder shardElectionTimeoutFactor(long shardElectionTimeoutFactor){
234 datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
238 public Builder transactionCreationInitialRateLimit(long initialRateLimit){
239 datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
243 public Builder dataStoreType(String dataStoreType){
244 datastoreContext.dataStoreType = dataStoreType;
245 datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreType) + "Datastore";
249 public DatastoreContext build() {
250 return datastoreContext;