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";
45 public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT= 100;
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;
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);
70 public static Builder newBuilder() {
74 public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
75 return dataStoreProperties;
78 public Duration getShardTransactionIdleTimeout() {
79 return shardTransactionIdleTimeout;
82 public String getDataStoreMXBeanType() {
83 return dataStoreMXBeanType;
86 public int getOperationTimeoutInSeconds() {
87 return operationTimeoutInSeconds;
90 public ConfigParams getShardRaftConfig() {
94 public int getShardTransactionCommitTimeoutInSeconds() {
95 return shardTransactionCommitTimeoutInSeconds;
98 public int getShardTransactionCommitQueueCapacity() {
99 return shardTransactionCommitQueueCapacity;
102 public Timeout getShardInitializationTimeout() {
103 return shardInitializationTimeout;
106 public Timeout getShardLeaderElectionTimeout() {
107 return shardLeaderElectionTimeout;
110 public boolean isPersistent() {
114 public ConfigurationReader getConfigurationReader() {
115 return configurationReader;
118 public long getShardElectionTimeoutFactor(){
119 return raftConfig.getElectionTimeoutFactor();
122 public String getDataStoreType(){
123 return dataStoreType;
126 public long getTransactionCreationInitialRateLimit() {
127 return transactionCreationInitialRateLimit;
130 private void setHeartbeatInterval(long shardHeartbeatIntervalInMillis){
131 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
132 TimeUnit.MILLISECONDS));
135 private void setShardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize){
136 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
140 private void setIsolatedLeaderCheckInterval(long shardIsolatedLeaderCheckIntervalInMillis) {
141 raftConfig.setIsolatedLeaderCheckInterval(
142 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
145 private void setElectionTimeoutFactor(long shardElectionTimeoutFactor) {
146 raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
149 private void setSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
150 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
153 private void setSnapshotBatchCount(int shardSnapshotBatchCount) {
154 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
157 public int getShardBatchedModificationCount() {
158 return shardBatchedModificationCount;
161 public static class Builder {
162 private final DatastoreContext datastoreContext = new DatastoreContext();
164 public Builder shardTransactionIdleTimeout(Duration shardTransactionIdleTimeout) {
165 datastoreContext.shardTransactionIdleTimeout = shardTransactionIdleTimeout;
169 public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
170 datastoreContext.operationTimeoutInSeconds = operationTimeoutInSeconds;
174 public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
175 datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
179 public Builder dataStoreProperties(InMemoryDOMDataStoreConfigProperties dataStoreProperties) {
180 datastoreContext.dataStoreProperties = dataStoreProperties;
184 public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
185 datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
189 public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
190 datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
194 public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
195 datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
199 public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
200 datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
204 public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
205 datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
209 public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
210 datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
214 public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
215 datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
219 public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
220 datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
224 public Builder configurationReader(ConfigurationReader configurationReader){
225 datastoreContext.configurationReader = configurationReader;
229 public Builder persistent(boolean persistent){
230 datastoreContext.persistent = persistent;
234 public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
235 datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
239 public Builder shardElectionTimeoutFactor(long shardElectionTimeoutFactor){
240 datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
244 public Builder transactionCreationInitialRateLimit(long initialRateLimit){
245 datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
249 public Builder dataStoreType(String dataStoreType){
250 datastoreContext.dataStoreType = dataStoreType;
251 datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreType) + "Datastore";
255 public Builder shardBatchedModificationCount(int shardBatchedModificationCount) {
256 datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
260 public DatastoreContext build() {
261 return datastoreContext;