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
8 package org.opendaylight.controller.cluster.datastore;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
13 import akka.util.Timeout;
14 import com.google.common.annotations.VisibleForTesting;
16 import java.util.concurrent.ConcurrentHashMap;
17 import java.util.concurrent.TimeUnit;
18 import org.apache.commons.text.WordUtils;
19 import org.opendaylight.controller.cluster.access.client.AbstractClientConnection;
20 import org.opendaylight.controller.cluster.access.client.ClientActorConfig;
21 import org.opendaylight.controller.cluster.common.actor.AkkaConfigurationReader;
22 import org.opendaylight.controller.cluster.common.actor.FileAkkaConfigurationReader;
23 import org.opendaylight.controller.cluster.raft.ConfigParams;
24 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
25 import org.opendaylight.controller.cluster.raft.PeerAddressResolver;
26 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
27 import org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataStoreConfigProperties;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
31 import scala.concurrent.duration.FiniteDuration;
34 * Contains contextual data for a data store.
36 * @author Thomas Pantelis
38 // Non-final for mocking
39 public class DatastoreContext implements ClientActorConfig {
40 public static final String METRICS_DOMAIN = "org.opendaylight.controller.cluster.datastore";
42 public static final FiniteDuration DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT = FiniteDuration.create(10,
44 public static final int DEFAULT_OPERATION_TIMEOUT_IN_MS = 5000;
45 public static final int DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS = 30;
46 public static final int DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE = 1;
47 public static final int DEFAULT_SNAPSHOT_BATCH_COUNT = 20000;
48 public static final int DEFAULT_RECOVERY_SNAPSHOT_INTERVAL_SECONDS = 0;
49 public static final int DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS = 500;
50 public static final int DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS =
51 DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS * 10;
52 public static final int DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY = 50000;
53 public static final Timeout DEFAULT_SHARD_INITIALIZATION_TIMEOUT = new Timeout(5, TimeUnit.MINUTES);
54 public static final Timeout DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT = new Timeout(30, TimeUnit.SECONDS);
55 public static final int DEFAULT_INITIAL_SETTLE_TIMEOUT_MULTIPLIER = 3;
56 public static final boolean DEFAULT_PERSISTENT = true;
57 public static final FileAkkaConfigurationReader DEFAULT_CONFIGURATION_READER = new FileAkkaConfigurationReader();
58 public static final int DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE = 12;
59 public static final int DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR = 2;
60 public static final int DEFAULT_SHARD_CANDIDATE_ELECTION_TIMEOUT_DIVISOR = 1;
61 public static final int DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT = 100;
62 public static final String UNKNOWN_DATA_STORE_TYPE = "unknown";
63 public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT = 1000;
64 public static final long DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS =
65 TimeUnit.MILLISECONDS.convert(2, TimeUnit.MINUTES);
66 public static final int DEFAULT_MAX_MESSAGE_SLICE_SIZE = 2048 * 1000; // 2MB
67 public static final int DEFAULT_INITIAL_PAYLOAD_SERIALIZED_BUFFER_CAPACITY = 512;
69 public static final long DEFAULT_SYNC_INDEX_THRESHOLD = 10;
71 private static final Logger LOG = LoggerFactory.getLogger(DatastoreContext.class);
73 private static final Set<String> GLOBAL_DATASTORE_NAMES = ConcurrentHashMap.newKeySet();
75 private final DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
77 private InMemoryDOMDataStoreConfigProperties dataStoreProperties;
78 private FiniteDuration shardTransactionIdleTimeout = DatastoreContext.DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT;
79 private long operationTimeoutInMillis = DEFAULT_OPERATION_TIMEOUT_IN_MS;
80 private String dataStoreMXBeanType;
81 private int shardTransactionCommitTimeoutInSeconds = DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS;
82 private int shardTransactionCommitQueueCapacity = DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY;
83 private Timeout shardInitializationTimeout = DEFAULT_SHARD_INITIALIZATION_TIMEOUT;
84 private Timeout shardLeaderElectionTimeout = DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT;
85 private int initialSettleTimeoutMultiplier = DEFAULT_INITIAL_SETTLE_TIMEOUT_MULTIPLIER;
86 private boolean persistent = DEFAULT_PERSISTENT;
87 private AkkaConfigurationReader configurationReader = DEFAULT_CONFIGURATION_READER;
88 private long transactionCreationInitialRateLimit = DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT;
89 private String dataStoreName = UNKNOWN_DATA_STORE_TYPE;
90 private LogicalDatastoreType logicalStoreType = LogicalDatastoreType.OPERATIONAL;
91 private YangInstanceIdentifier storeRoot = YangInstanceIdentifier.empty();
92 private int shardBatchedModificationCount = DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT;
93 private boolean writeOnlyTransactionOptimizationsEnabled = true;
94 private long shardCommitQueueExpiryTimeoutInMillis = DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS;
95 private boolean useTellBasedProtocol = false;
96 private boolean transactionDebugContextEnabled = false;
97 private String shardManagerPersistenceId;
98 private int maximumMessageSliceSize = DEFAULT_MAX_MESSAGE_SLICE_SIZE;
99 private long backendAlivenessTimerInterval = AbstractClientConnection.DEFAULT_BACKEND_ALIVE_TIMEOUT_NANOS;
100 private long requestTimeout = AbstractClientConnection.DEFAULT_REQUEST_TIMEOUT_NANOS;
101 private long noProgressTimeout = AbstractClientConnection.DEFAULT_NO_PROGRESS_TIMEOUT_NANOS;
102 private int initialPayloadSerializedBufferCapacity = DEFAULT_INITIAL_PAYLOAD_SERIALIZED_BUFFER_CAPACITY;
104 public static Set<String> getGlobalDatastoreNames() {
105 return GLOBAL_DATASTORE_NAMES;
109 setShardJournalRecoveryLogBatchSize(DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE);
110 setSnapshotBatchCount(DEFAULT_SNAPSHOT_BATCH_COUNT);
111 setRecoverySnapshotIntervalSeconds(DEFAULT_RECOVERY_SNAPSHOT_INTERVAL_SECONDS);
112 setHeartbeatInterval(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS);
113 setIsolatedLeaderCheckInterval(DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS);
114 setSnapshotDataThresholdPercentage(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE);
115 setElectionTimeoutFactor(DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR);
116 setCandidateElectionTimeoutDivisor(DEFAULT_SHARD_CANDIDATE_ELECTION_TIMEOUT_DIVISOR);
117 setSyncIndexThreshold(DEFAULT_SYNC_INDEX_THRESHOLD);
118 setMaximumMessageSliceSize(DEFAULT_MAX_MESSAGE_SLICE_SIZE);
121 private DatastoreContext(final DatastoreContext other) {
122 this.dataStoreProperties = other.dataStoreProperties;
123 this.shardTransactionIdleTimeout = other.shardTransactionIdleTimeout;
124 this.operationTimeoutInMillis = other.operationTimeoutInMillis;
125 this.dataStoreMXBeanType = other.dataStoreMXBeanType;
126 this.shardTransactionCommitTimeoutInSeconds = other.shardTransactionCommitTimeoutInSeconds;
127 this.shardTransactionCommitQueueCapacity = other.shardTransactionCommitQueueCapacity;
128 this.shardInitializationTimeout = other.shardInitializationTimeout;
129 this.shardLeaderElectionTimeout = other.shardLeaderElectionTimeout;
130 this.initialSettleTimeoutMultiplier = other.initialSettleTimeoutMultiplier;
131 this.persistent = other.persistent;
132 this.configurationReader = other.configurationReader;
133 this.transactionCreationInitialRateLimit = other.transactionCreationInitialRateLimit;
134 this.dataStoreName = other.dataStoreName;
135 this.logicalStoreType = other.logicalStoreType;
136 this.storeRoot = other.storeRoot;
137 this.shardBatchedModificationCount = other.shardBatchedModificationCount;
138 this.writeOnlyTransactionOptimizationsEnabled = other.writeOnlyTransactionOptimizationsEnabled;
139 this.shardCommitQueueExpiryTimeoutInMillis = other.shardCommitQueueExpiryTimeoutInMillis;
140 this.transactionDebugContextEnabled = other.transactionDebugContextEnabled;
141 this.shardManagerPersistenceId = other.shardManagerPersistenceId;
142 this.useTellBasedProtocol = other.useTellBasedProtocol;
143 this.backendAlivenessTimerInterval = other.backendAlivenessTimerInterval;
144 this.requestTimeout = other.requestTimeout;
145 this.noProgressTimeout = other.noProgressTimeout;
146 this.initialPayloadSerializedBufferCapacity = other.initialPayloadSerializedBufferCapacity;
148 setShardJournalRecoveryLogBatchSize(other.raftConfig.getJournalRecoveryLogBatchSize());
149 setSnapshotBatchCount(other.raftConfig.getSnapshotBatchCount());
150 setRecoverySnapshotIntervalSeconds(other.raftConfig.getRecoverySnapshotIntervalSeconds());
151 setHeartbeatInterval(other.raftConfig.getHeartBeatInterval().toMillis());
152 setIsolatedLeaderCheckInterval(other.raftConfig.getIsolatedCheckIntervalInMillis());
153 setSnapshotDataThresholdPercentage(other.raftConfig.getSnapshotDataThresholdPercentage());
154 setElectionTimeoutFactor(other.raftConfig.getElectionTimeoutFactor());
155 setCandidateElectionTimeoutDivisor(other.raftConfig.getCandidateElectionTimeoutDivisor());
156 setCustomRaftPolicyImplementation(other.raftConfig.getCustomRaftPolicyImplementationClass());
157 setMaximumMessageSliceSize(other.getMaximumMessageSliceSize());
158 setShardSnapshotChunkSize(other.raftConfig.getSnapshotChunkSize());
159 setPeerAddressResolver(other.raftConfig.getPeerAddressResolver());
160 setTempFileDirectory(other.getTempFileDirectory());
161 setFileBackedStreamingThreshold(other.getFileBackedStreamingThreshold());
162 setSyncIndexThreshold(other.raftConfig.getSyncIndexThreshold());
165 public static Builder newBuilder() {
166 return new Builder(new DatastoreContext());
169 public static Builder newBuilderFrom(final DatastoreContext context) {
170 return new Builder(new DatastoreContext(context));
173 public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
174 return dataStoreProperties;
177 public FiniteDuration getShardTransactionIdleTimeout() {
178 return shardTransactionIdleTimeout;
181 public String getDataStoreMXBeanType() {
182 return dataStoreMXBeanType;
185 public long getOperationTimeoutInMillis() {
186 return operationTimeoutInMillis;
189 public ConfigParams getShardRaftConfig() {
193 public int getShardTransactionCommitTimeoutInSeconds() {
194 return shardTransactionCommitTimeoutInSeconds;
197 public int getShardTransactionCommitQueueCapacity() {
198 return shardTransactionCommitQueueCapacity;
201 public Timeout getShardInitializationTimeout() {
202 return shardInitializationTimeout;
205 public Timeout getShardLeaderElectionTimeout() {
206 return shardLeaderElectionTimeout;
210 * Return the multiplier of {@link #getShardLeaderElectionTimeout()} which the frontend will wait for all shards
211 * on the local node to settle.
213 * @return Non-negative multiplier. Value of {@code 0} indicates to wait indefinitely.
215 public int getInitialSettleTimeoutMultiplier() {
216 return initialSettleTimeoutMultiplier;
219 public boolean isPersistent() {
223 public AkkaConfigurationReader getConfigurationReader() {
224 return configurationReader;
227 public long getShardElectionTimeoutFactor() {
228 return raftConfig.getElectionTimeoutFactor();
231 public String getDataStoreName() {
232 return dataStoreName;
235 public LogicalDatastoreType getLogicalStoreType() {
236 return logicalStoreType;
239 public YangInstanceIdentifier getStoreRoot() {
243 public long getTransactionCreationInitialRateLimit() {
244 return transactionCreationInitialRateLimit;
247 public String getShardManagerPersistenceId() {
248 return shardManagerPersistenceId;
252 public String getTempFileDirectory() {
253 return raftConfig.getTempFileDirectory();
256 private void setTempFileDirectory(final String tempFileDirectory) {
257 raftConfig.setTempFileDirectory(tempFileDirectory);
261 public int getFileBackedStreamingThreshold() {
262 return raftConfig.getFileBackedStreamingThreshold();
265 private void setFileBackedStreamingThreshold(final int fileBackedStreamingThreshold) {
266 raftConfig.setFileBackedStreamingThreshold(fileBackedStreamingThreshold);
269 private void setPeerAddressResolver(final PeerAddressResolver resolver) {
270 raftConfig.setPeerAddressResolver(resolver);
273 private void setHeartbeatInterval(final long shardHeartbeatIntervalInMillis) {
274 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
275 TimeUnit.MILLISECONDS));
278 private void setShardJournalRecoveryLogBatchSize(final int shardJournalRecoveryLogBatchSize) {
279 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
283 private void setIsolatedLeaderCheckInterval(final long shardIsolatedLeaderCheckIntervalInMillis) {
284 raftConfig.setIsolatedLeaderCheckInterval(
285 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
288 private void setElectionTimeoutFactor(final long shardElectionTimeoutFactor) {
289 raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
292 private void setCandidateElectionTimeoutDivisor(final long candidateElectionTimeoutDivisor) {
293 raftConfig.setCandidateElectionTimeoutDivisor(candidateElectionTimeoutDivisor);
296 private void setCustomRaftPolicyImplementation(final String customRaftPolicyImplementation) {
297 raftConfig.setCustomRaftPolicyImplementationClass(customRaftPolicyImplementation);
300 private void setSnapshotDataThresholdPercentage(final int shardSnapshotDataThresholdPercentage) {
301 checkArgument(shardSnapshotDataThresholdPercentage >= 0 && shardSnapshotDataThresholdPercentage <= 100);
302 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
305 private void setSnapshotBatchCount(final long shardSnapshotBatchCount) {
306 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
310 * Set the interval in seconds after which a snapshot should be taken during the recovery process.
311 * 0 means don't take snapshots
313 private void setRecoverySnapshotIntervalSeconds(final int recoverySnapshotInterval) {
314 raftConfig.setRecoverySnapshotIntervalSeconds(recoverySnapshotInterval);
318 private void setShardSnapshotChunkSize(final int shardSnapshotChunkSize) {
319 // We'll honor the shardSnapshotChunkSize setting for backwards compatibility but only if it doesn't exceed
320 // maximumMessageSliceSize.
321 if (shardSnapshotChunkSize < maximumMessageSliceSize) {
322 raftConfig.setSnapshotChunkSize(shardSnapshotChunkSize);
326 private void setMaximumMessageSliceSize(final int maximumMessageSliceSize) {
327 raftConfig.setSnapshotChunkSize(maximumMessageSliceSize);
328 this.maximumMessageSliceSize = maximumMessageSliceSize;
331 private void setSyncIndexThreshold(final long syncIndexThreshold) {
332 raftConfig.setSyncIndexThreshold(syncIndexThreshold);
335 public int getShardBatchedModificationCount() {
336 return shardBatchedModificationCount;
339 public boolean isWriteOnlyTransactionOptimizationsEnabled() {
340 return writeOnlyTransactionOptimizationsEnabled;
343 public long getShardCommitQueueExpiryTimeoutInMillis() {
344 return shardCommitQueueExpiryTimeoutInMillis;
347 public boolean isTransactionDebugContextEnabled() {
348 return transactionDebugContextEnabled;
351 public boolean isUseTellBasedProtocol() {
352 return useTellBasedProtocol;
356 public int getMaximumMessageSliceSize() {
357 return maximumMessageSliceSize;
361 public long getBackendAlivenessTimerInterval() {
362 return backendAlivenessTimerInterval;
366 public long getRequestTimeout() {
367 return requestTimeout;
371 public long getNoProgressTimeout() {
372 return noProgressTimeout;
375 public int getInitialPayloadSerializedBufferCapacity() {
376 return initialPayloadSerializedBufferCapacity;
379 public static class Builder implements org.opendaylight.yangtools.concepts.Builder<DatastoreContext> {
380 private final DatastoreContext datastoreContext;
381 private int maxShardDataChangeExecutorPoolSize =
382 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_POOL_SIZE;
383 private int maxShardDataChangeExecutorQueueSize =
384 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_QUEUE_SIZE;
385 private int maxShardDataChangeListenerQueueSize =
386 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE;
387 private int maxShardDataStoreExecutorQueueSize =
388 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_STORE_EXECUTOR_QUEUE_SIZE;
390 Builder(final DatastoreContext datastoreContext) {
391 this.datastoreContext = datastoreContext;
393 if (datastoreContext.getDataStoreProperties() != null) {
394 maxShardDataChangeExecutorPoolSize =
395 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorPoolSize();
396 maxShardDataChangeExecutorQueueSize =
397 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorQueueSize();
398 maxShardDataChangeListenerQueueSize =
399 datastoreContext.getDataStoreProperties().getMaxDataChangeListenerQueueSize();
400 maxShardDataStoreExecutorQueueSize =
401 datastoreContext.getDataStoreProperties().getMaxDataStoreExecutorQueueSize();
405 public Builder boundedMailboxCapacity(final int boundedMailboxCapacity) {
406 // TODO - this is defined in the yang DataStoreProperties but not currently used.
410 public Builder enableMetricCapture(final boolean enableMetricCapture) {
411 // TODO - this is defined in the yang DataStoreProperties but not currently used.
416 public Builder shardTransactionIdleTimeout(final long timeout, final TimeUnit unit) {
417 datastoreContext.shardTransactionIdleTimeout = FiniteDuration.create(timeout, unit);
421 public Builder shardTransactionIdleTimeoutInMinutes(final long timeout) {
422 return shardTransactionIdleTimeout(timeout, TimeUnit.MINUTES);
425 public Builder operationTimeoutInSeconds(final int operationTimeoutInSeconds) {
426 datastoreContext.operationTimeoutInMillis = TimeUnit.SECONDS.toMillis(operationTimeoutInSeconds);
430 public Builder operationTimeoutInMillis(final long operationTimeoutInMillis) {
431 datastoreContext.operationTimeoutInMillis = operationTimeoutInMillis;
435 public Builder dataStoreMXBeanType(final String dataStoreMXBeanType) {
436 datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
440 public Builder shardTransactionCommitTimeoutInSeconds(final int shardTransactionCommitTimeoutInSeconds) {
441 datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
445 public Builder shardJournalRecoveryLogBatchSize(final int shardJournalRecoveryLogBatchSize) {
446 datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
450 public Builder shardSnapshotBatchCount(final int shardSnapshotBatchCount) {
451 datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
455 public Builder recoverySnapshotIntervalSeconds(final int recoverySnapshotIntervalSeconds) {
456 checkArgument(recoverySnapshotIntervalSeconds >= 0);
457 datastoreContext.setRecoverySnapshotIntervalSeconds(recoverySnapshotIntervalSeconds);
461 public Builder shardSnapshotDataThresholdPercentage(final int shardSnapshotDataThresholdPercentage) {
462 datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
466 public Builder shardHeartbeatIntervalInMillis(final int shardHeartbeatIntervalInMillis) {
467 datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
471 public Builder shardTransactionCommitQueueCapacity(final int shardTransactionCommitQueueCapacity) {
472 datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
476 public Builder shardInitializationTimeout(final long timeout, final TimeUnit unit) {
477 datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
481 public Builder shardInitializationTimeoutInSeconds(final long timeout) {
482 return shardInitializationTimeout(timeout, TimeUnit.SECONDS);
485 public Builder shardLeaderElectionTimeout(final long timeout, final TimeUnit unit) {
486 datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
490 public Builder initialSettleTimeoutMultiplier(final int multiplier) {
491 checkArgument(multiplier >= 0);
492 datastoreContext.initialSettleTimeoutMultiplier = multiplier;
496 public Builder shardLeaderElectionTimeoutInSeconds(final long timeout) {
497 return shardLeaderElectionTimeout(timeout, TimeUnit.SECONDS);
500 public Builder configurationReader(final AkkaConfigurationReader configurationReader) {
501 datastoreContext.configurationReader = configurationReader;
505 public Builder persistent(final boolean persistent) {
506 datastoreContext.persistent = persistent;
510 public Builder shardIsolatedLeaderCheckIntervalInMillis(final int shardIsolatedLeaderCheckIntervalInMillis) {
511 datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
515 public Builder shardElectionTimeoutFactor(final long shardElectionTimeoutFactor) {
516 datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
520 public Builder shardCandidateElectionTimeoutDivisor(final long candidateElectionTimeoutDivisor) {
521 datastoreContext.setCandidateElectionTimeoutDivisor(candidateElectionTimeoutDivisor);
525 public Builder transactionCreationInitialRateLimit(final long initialRateLimit) {
526 datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
530 public Builder logicalStoreType(final LogicalDatastoreType logicalStoreType) {
531 datastoreContext.logicalStoreType = requireNonNull(logicalStoreType);
533 // Retain compatible naming
534 switch (logicalStoreType) {
536 dataStoreName("config");
539 dataStoreName("operational");
542 dataStoreName(logicalStoreType.name());
548 public Builder storeRoot(final YangInstanceIdentifier storeRoot) {
549 datastoreContext.storeRoot = storeRoot;
553 public Builder dataStoreName(final String dataStoreName) {
554 datastoreContext.dataStoreName = requireNonNull(dataStoreName);
555 datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreName) + "Datastore";
559 public Builder shardBatchedModificationCount(final int shardBatchedModificationCount) {
560 datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
564 public Builder writeOnlyTransactionOptimizationsEnabled(final boolean value) {
565 datastoreContext.writeOnlyTransactionOptimizationsEnabled = value;
569 public Builder shardCommitQueueExpiryTimeoutInMillis(final long value) {
570 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = value;
574 public Builder shardCommitQueueExpiryTimeoutInSeconds(final long value) {
575 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = TimeUnit.MILLISECONDS.convert(
576 value, TimeUnit.SECONDS);
580 public Builder transactionDebugContextEnabled(final boolean value) {
581 datastoreContext.transactionDebugContextEnabled = value;
585 public Builder maxShardDataChangeExecutorPoolSize(final int newMaxShardDataChangeExecutorPoolSize) {
586 this.maxShardDataChangeExecutorPoolSize = newMaxShardDataChangeExecutorPoolSize;
590 public Builder maxShardDataChangeExecutorQueueSize(final int newMaxShardDataChangeExecutorQueueSize) {
591 this.maxShardDataChangeExecutorQueueSize = newMaxShardDataChangeExecutorQueueSize;
595 public Builder maxShardDataChangeListenerQueueSize(final int newMaxShardDataChangeListenerQueueSize) {
596 this.maxShardDataChangeListenerQueueSize = newMaxShardDataChangeListenerQueueSize;
600 public Builder maxShardDataStoreExecutorQueueSize(final int newMaxShardDataStoreExecutorQueueSize) {
601 this.maxShardDataStoreExecutorQueueSize = newMaxShardDataStoreExecutorQueueSize;
605 public Builder useTellBasedProtocol(final boolean value) {
606 datastoreContext.useTellBasedProtocol = value;
611 * For unit tests only.
614 public Builder shardManagerPersistenceId(final String id) {
615 datastoreContext.shardManagerPersistenceId = id;
619 public Builder customRaftPolicyImplementation(final String customRaftPolicyImplementation) {
620 datastoreContext.setCustomRaftPolicyImplementation(customRaftPolicyImplementation);
625 public Builder shardSnapshotChunkSize(final int shardSnapshotChunkSize) {
626 LOG.warn("The shard-snapshot-chunk-size configuration parameter is deprecated - "
627 + "use maximum-message-slice-size instead");
628 datastoreContext.setShardSnapshotChunkSize(shardSnapshotChunkSize);
632 public Builder maximumMessageSliceSize(final int maximumMessageSliceSize) {
633 datastoreContext.setMaximumMessageSliceSize(maximumMessageSliceSize);
637 public Builder shardPeerAddressResolver(final PeerAddressResolver resolver) {
638 datastoreContext.setPeerAddressResolver(resolver);
642 public Builder tempFileDirectory(final String tempFileDirectory) {
643 datastoreContext.setTempFileDirectory(tempFileDirectory);
647 public Builder fileBackedStreamingThresholdInMegabytes(final int fileBackedStreamingThreshold) {
648 datastoreContext.setFileBackedStreamingThreshold(fileBackedStreamingThreshold * ConfigParams.MEGABYTE);
652 public Builder syncIndexThreshold(final long syncIndexThreshold) {
653 datastoreContext.setSyncIndexThreshold(syncIndexThreshold);
657 public Builder backendAlivenessTimerIntervalInSeconds(final long interval) {
658 datastoreContext.backendAlivenessTimerInterval = TimeUnit.SECONDS.toNanos(interval);
662 public Builder frontendRequestTimeoutInSeconds(final long timeout) {
663 datastoreContext.requestTimeout = TimeUnit.SECONDS.toNanos(timeout);
667 public Builder frontendNoProgressTimeoutInSeconds(final long timeout) {
668 datastoreContext.noProgressTimeout = TimeUnit.SECONDS.toNanos(timeout);
672 public Builder initialPayloadSerializedBufferCapacity(final int capacity) {
673 datastoreContext.initialPayloadSerializedBufferCapacity = capacity;
678 public DatastoreContext build() {
679 datastoreContext.dataStoreProperties = InMemoryDOMDataStoreConfigProperties.builder()
680 .maxDataChangeExecutorPoolSize(maxShardDataChangeExecutorPoolSize)
681 .maxDataChangeExecutorQueueSize(maxShardDataChangeExecutorQueueSize)
682 .maxDataChangeListenerQueueSize(maxShardDataChangeListenerQueueSize)
683 .maxDataStoreExecutorQueueSize(maxShardDataStoreExecutorQueueSize)
686 if (datastoreContext.dataStoreName != null) {
687 GLOBAL_DATASTORE_NAMES.add(datastoreContext.dataStoreName);
690 return datastoreContext;