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.yangtools.yang.data.api.YangInstanceIdentifier;
28 import org.slf4j.Logger;
29 import org.slf4j.LoggerFactory;
30 import scala.concurrent.duration.FiniteDuration;
33 * Contains contextual data for a data store.
35 * @author Thomas Pantelis
37 // Non-final for mocking
38 public class DatastoreContext implements ClientActorConfig {
39 public static final String METRICS_DOMAIN = "org.opendaylight.controller.cluster.datastore";
41 public static final FiniteDuration DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT = FiniteDuration.create(10,
43 public static final int DEFAULT_OPERATION_TIMEOUT_IN_MS = 5000;
44 public static final int DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS = 30;
45 public static final int DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE = 1;
46 public static final int DEFAULT_SNAPSHOT_BATCH_COUNT = 20000;
47 public static final int DEFAULT_RECOVERY_SNAPSHOT_INTERVAL_SECONDS = 0;
48 public static final int DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS = 500;
49 public static final int DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS =
50 DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS * 10;
51 public static final int DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY = 50000;
52 public static final Timeout DEFAULT_SHARD_INITIALIZATION_TIMEOUT = new Timeout(5, TimeUnit.MINUTES);
53 public static final Timeout DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT = new Timeout(30, TimeUnit.SECONDS);
54 public static final int DEFAULT_INITIAL_SETTLE_TIMEOUT_MULTIPLIER = 3;
55 public static final boolean DEFAULT_PERSISTENT = true;
56 public static final boolean DEFAULT_SNAPSHOT_ON_ROOT_OVERWRITE = false;
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_SNAPSHOT_DATA_THRESHOLD = 0;
60 public static final int DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR = 2;
61 public static final int DEFAULT_SHARD_CANDIDATE_ELECTION_TIMEOUT_DIVISOR = 1;
62 public static final int DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT = 100;
63 public static final String UNKNOWN_DATA_STORE_TYPE = "unknown";
64 public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT = 1000;
65 public static final long DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS =
66 TimeUnit.MILLISECONDS.convert(2, TimeUnit.MINUTES);
67 public static final int DEFAULT_MAX_MESSAGE_SLICE_SIZE = 2048 * 1000; // 2MB
68 public static final int DEFAULT_INITIAL_PAYLOAD_SERIALIZED_BUFFER_CAPACITY = 512;
70 public static final long DEFAULT_SYNC_INDEX_THRESHOLD = 10;
72 private static final Logger LOG = LoggerFactory.getLogger(DatastoreContext.class);
74 private static final Set<String> GLOBAL_DATASTORE_NAMES = ConcurrentHashMap.newKeySet();
76 private final DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
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 boolean snapshotOnRootOverwrite = DEFAULT_SNAPSHOT_ON_ROOT_OVERWRITE;
88 private AkkaConfigurationReader configurationReader = DEFAULT_CONFIGURATION_READER;
89 private long transactionCreationInitialRateLimit = DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT;
90 private String dataStoreName = UNKNOWN_DATA_STORE_TYPE;
91 private LogicalDatastoreType logicalStoreType = LogicalDatastoreType.OPERATIONAL;
92 private YangInstanceIdentifier storeRoot = YangInstanceIdentifier.empty();
93 private int shardBatchedModificationCount = DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT;
94 private boolean writeOnlyTransactionOptimizationsEnabled = true;
95 private long shardCommitQueueExpiryTimeoutInMillis = DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS;
96 private boolean useTellBasedProtocol = false;
97 private boolean transactionDebugContextEnabled = false;
98 private String shardManagerPersistenceId;
99 private int maximumMessageSliceSize = DEFAULT_MAX_MESSAGE_SLICE_SIZE;
100 private long backendAlivenessTimerInterval = AbstractClientConnection.DEFAULT_BACKEND_ALIVE_TIMEOUT_NANOS;
101 private long requestTimeout = AbstractClientConnection.DEFAULT_REQUEST_TIMEOUT_NANOS;
102 private long noProgressTimeout = AbstractClientConnection.DEFAULT_NO_PROGRESS_TIMEOUT_NANOS;
103 private int initialPayloadSerializedBufferCapacity = DEFAULT_INITIAL_PAYLOAD_SERIALIZED_BUFFER_CAPACITY;
104 private boolean useLz4Compression = false;
106 public static Set<String> getGlobalDatastoreNames() {
107 return GLOBAL_DATASTORE_NAMES;
111 setShardJournalRecoveryLogBatchSize(DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE);
112 setSnapshotBatchCount(DEFAULT_SNAPSHOT_BATCH_COUNT);
113 setRecoverySnapshotIntervalSeconds(DEFAULT_RECOVERY_SNAPSHOT_INTERVAL_SECONDS);
114 setHeartbeatInterval(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS);
115 setIsolatedLeaderCheckInterval(DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS);
116 setSnapshotDataThresholdPercentage(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE);
117 setSnapshotDataThreshold(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD);
118 setElectionTimeoutFactor(DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR);
119 setCandidateElectionTimeoutDivisor(DEFAULT_SHARD_CANDIDATE_ELECTION_TIMEOUT_DIVISOR);
120 setSyncIndexThreshold(DEFAULT_SYNC_INDEX_THRESHOLD);
121 setMaximumMessageSliceSize(DEFAULT_MAX_MESSAGE_SLICE_SIZE);
124 private DatastoreContext(final DatastoreContext other) {
125 this.shardTransactionIdleTimeout = other.shardTransactionIdleTimeout;
126 this.operationTimeoutInMillis = other.operationTimeoutInMillis;
127 this.dataStoreMXBeanType = other.dataStoreMXBeanType;
128 this.shardTransactionCommitTimeoutInSeconds = other.shardTransactionCommitTimeoutInSeconds;
129 this.shardTransactionCommitQueueCapacity = other.shardTransactionCommitQueueCapacity;
130 this.shardInitializationTimeout = other.shardInitializationTimeout;
131 this.shardLeaderElectionTimeout = other.shardLeaderElectionTimeout;
132 this.initialSettleTimeoutMultiplier = other.initialSettleTimeoutMultiplier;
133 this.persistent = other.persistent;
134 this.snapshotOnRootOverwrite = other.snapshotOnRootOverwrite;
135 this.configurationReader = other.configurationReader;
136 this.transactionCreationInitialRateLimit = other.transactionCreationInitialRateLimit;
137 this.dataStoreName = other.dataStoreName;
138 this.logicalStoreType = other.logicalStoreType;
139 this.storeRoot = other.storeRoot;
140 this.shardBatchedModificationCount = other.shardBatchedModificationCount;
141 this.writeOnlyTransactionOptimizationsEnabled = other.writeOnlyTransactionOptimizationsEnabled;
142 this.shardCommitQueueExpiryTimeoutInMillis = other.shardCommitQueueExpiryTimeoutInMillis;
143 this.transactionDebugContextEnabled = other.transactionDebugContextEnabled;
144 this.shardManagerPersistenceId = other.shardManagerPersistenceId;
145 this.useTellBasedProtocol = other.useTellBasedProtocol;
146 this.backendAlivenessTimerInterval = other.backendAlivenessTimerInterval;
147 this.requestTimeout = other.requestTimeout;
148 this.noProgressTimeout = other.noProgressTimeout;
149 this.initialPayloadSerializedBufferCapacity = other.initialPayloadSerializedBufferCapacity;
150 this.useLz4Compression = other.useLz4Compression;
152 setShardJournalRecoveryLogBatchSize(other.raftConfig.getJournalRecoveryLogBatchSize());
153 setSnapshotBatchCount(other.raftConfig.getSnapshotBatchCount());
154 setRecoverySnapshotIntervalSeconds(other.raftConfig.getRecoverySnapshotIntervalSeconds());
155 setHeartbeatInterval(other.raftConfig.getHeartBeatInterval().toMillis());
156 setIsolatedLeaderCheckInterval(other.raftConfig.getIsolatedCheckIntervalInMillis());
157 setSnapshotDataThresholdPercentage(other.raftConfig.getSnapshotDataThresholdPercentage());
158 setSnapshotDataThreshold(other.raftConfig.getSnapshotDataThreshold());
159 setElectionTimeoutFactor(other.raftConfig.getElectionTimeoutFactor());
160 setCandidateElectionTimeoutDivisor(other.raftConfig.getCandidateElectionTimeoutDivisor());
161 setCustomRaftPolicyImplementation(other.raftConfig.getCustomRaftPolicyImplementationClass());
162 setMaximumMessageSliceSize(other.getMaximumMessageSliceSize());
163 setShardSnapshotChunkSize(other.raftConfig.getSnapshotChunkSize());
164 setPeerAddressResolver(other.raftConfig.getPeerAddressResolver());
165 setTempFileDirectory(other.getTempFileDirectory());
166 setFileBackedStreamingThreshold(other.getFileBackedStreamingThreshold());
167 setSyncIndexThreshold(other.raftConfig.getSyncIndexThreshold());
170 public static Builder newBuilder() {
171 return new Builder(new DatastoreContext());
174 public static Builder newBuilderFrom(final DatastoreContext context) {
175 return new Builder(new DatastoreContext(context));
178 public FiniteDuration getShardTransactionIdleTimeout() {
179 return shardTransactionIdleTimeout;
182 public String getDataStoreMXBeanType() {
183 return dataStoreMXBeanType;
186 public long getOperationTimeoutInMillis() {
187 return operationTimeoutInMillis;
190 public ConfigParams getShardRaftConfig() {
194 public int getShardTransactionCommitTimeoutInSeconds() {
195 return shardTransactionCommitTimeoutInSeconds;
198 public int getShardTransactionCommitQueueCapacity() {
199 return shardTransactionCommitQueueCapacity;
202 public Timeout getShardInitializationTimeout() {
203 return shardInitializationTimeout;
206 public Timeout getShardLeaderElectionTimeout() {
207 return shardLeaderElectionTimeout;
211 * Return the multiplier of {@link #getShardLeaderElectionTimeout()} which the frontend will wait for all shards
212 * on the local node to settle.
214 * @return Non-negative multiplier. Value of {@code 0} indicates to wait indefinitely.
216 public int getInitialSettleTimeoutMultiplier() {
217 return initialSettleTimeoutMultiplier;
220 public boolean isPersistent() {
224 public boolean isSnapshotOnRootOverwrite() {
225 return this.snapshotOnRootOverwrite;
228 public AkkaConfigurationReader getConfigurationReader() {
229 return configurationReader;
232 public long getShardElectionTimeoutFactor() {
233 return raftConfig.getElectionTimeoutFactor();
236 public String getDataStoreName() {
237 return dataStoreName;
240 public LogicalDatastoreType getLogicalStoreType() {
241 return logicalStoreType;
244 public YangInstanceIdentifier getStoreRoot() {
248 public long getTransactionCreationInitialRateLimit() {
249 return transactionCreationInitialRateLimit;
252 public String getShardManagerPersistenceId() {
253 return shardManagerPersistenceId;
257 public String getTempFileDirectory() {
258 return raftConfig.getTempFileDirectory();
261 private void setTempFileDirectory(final String tempFileDirectory) {
262 raftConfig.setTempFileDirectory(tempFileDirectory);
266 public int getFileBackedStreamingThreshold() {
267 return raftConfig.getFileBackedStreamingThreshold();
270 private void setFileBackedStreamingThreshold(final int fileBackedStreamingThreshold) {
271 raftConfig.setFileBackedStreamingThreshold(fileBackedStreamingThreshold);
274 private void setPeerAddressResolver(final PeerAddressResolver resolver) {
275 raftConfig.setPeerAddressResolver(resolver);
278 private void setHeartbeatInterval(final long shardHeartbeatIntervalInMillis) {
279 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
280 TimeUnit.MILLISECONDS));
283 private void setShardJournalRecoveryLogBatchSize(final int shardJournalRecoveryLogBatchSize) {
284 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
288 private void setIsolatedLeaderCheckInterval(final long shardIsolatedLeaderCheckIntervalInMillis) {
289 raftConfig.setIsolatedLeaderCheckInterval(
290 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
293 private void setElectionTimeoutFactor(final long shardElectionTimeoutFactor) {
294 raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
297 private void setCandidateElectionTimeoutDivisor(final long candidateElectionTimeoutDivisor) {
298 raftConfig.setCandidateElectionTimeoutDivisor(candidateElectionTimeoutDivisor);
301 private void setCustomRaftPolicyImplementation(final String customRaftPolicyImplementation) {
302 raftConfig.setCustomRaftPolicyImplementationClass(customRaftPolicyImplementation);
305 private void setSnapshotDataThresholdPercentage(final int shardSnapshotDataThresholdPercentage) {
306 checkArgument(shardSnapshotDataThresholdPercentage >= 0 && shardSnapshotDataThresholdPercentage <= 100);
307 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
310 private void setSnapshotDataThreshold(final int shardSnapshotDataThreshold) {
311 checkArgument(shardSnapshotDataThreshold >= 0);
312 raftConfig.setSnapshotDataThreshold(shardSnapshotDataThreshold);
315 private void setSnapshotBatchCount(final long shardSnapshotBatchCount) {
316 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
320 * Set the interval in seconds after which a snapshot should be taken during the recovery process.
321 * 0 means don't take snapshots
323 private void setRecoverySnapshotIntervalSeconds(final int recoverySnapshotInterval) {
324 raftConfig.setRecoverySnapshotIntervalSeconds(recoverySnapshotInterval);
328 private void setShardSnapshotChunkSize(final int shardSnapshotChunkSize) {
329 // We'll honor the shardSnapshotChunkSize setting for backwards compatibility but only if it doesn't exceed
330 // maximumMessageSliceSize.
331 if (shardSnapshotChunkSize < maximumMessageSliceSize) {
332 raftConfig.setSnapshotChunkSize(shardSnapshotChunkSize);
336 private void setMaximumMessageSliceSize(final int maximumMessageSliceSize) {
337 raftConfig.setSnapshotChunkSize(maximumMessageSliceSize);
338 this.maximumMessageSliceSize = maximumMessageSliceSize;
341 private void setSyncIndexThreshold(final long syncIndexThreshold) {
342 raftConfig.setSyncIndexThreshold(syncIndexThreshold);
345 public int getShardBatchedModificationCount() {
346 return shardBatchedModificationCount;
349 public boolean isWriteOnlyTransactionOptimizationsEnabled() {
350 return writeOnlyTransactionOptimizationsEnabled;
353 public long getShardCommitQueueExpiryTimeoutInMillis() {
354 return shardCommitQueueExpiryTimeoutInMillis;
357 public boolean isTransactionDebugContextEnabled() {
358 return transactionDebugContextEnabled;
361 public boolean isUseTellBasedProtocol() {
362 return useTellBasedProtocol;
365 public boolean isUseLz4Compression() {
366 return useLz4Compression;
370 public int getMaximumMessageSliceSize() {
371 return maximumMessageSliceSize;
375 public long getBackendAlivenessTimerInterval() {
376 return backendAlivenessTimerInterval;
380 public long getRequestTimeout() {
381 return requestTimeout;
385 public long getNoProgressTimeout() {
386 return noProgressTimeout;
389 public int getInitialPayloadSerializedBufferCapacity() {
390 return initialPayloadSerializedBufferCapacity;
393 public static class Builder implements org.opendaylight.yangtools.concepts.Builder<DatastoreContext> {
394 private final DatastoreContext datastoreContext;
396 Builder(final DatastoreContext datastoreContext) {
397 this.datastoreContext = datastoreContext;
400 public Builder boundedMailboxCapacity(final int boundedMailboxCapacity) {
401 // TODO - this is defined in the yang DataStoreProperties but not currently used.
405 public Builder enableMetricCapture(final boolean enableMetricCapture) {
406 // TODO - this is defined in the yang DataStoreProperties but not currently used.
411 public Builder shardTransactionIdleTimeout(final long timeout, final TimeUnit unit) {
412 datastoreContext.shardTransactionIdleTimeout = FiniteDuration.create(timeout, unit);
416 public Builder shardTransactionIdleTimeoutInMinutes(final long timeout) {
417 return shardTransactionIdleTimeout(timeout, TimeUnit.MINUTES);
420 public Builder operationTimeoutInSeconds(final int operationTimeoutInSeconds) {
421 datastoreContext.operationTimeoutInMillis = TimeUnit.SECONDS.toMillis(operationTimeoutInSeconds);
425 public Builder operationTimeoutInMillis(final long operationTimeoutInMillis) {
426 datastoreContext.operationTimeoutInMillis = operationTimeoutInMillis;
430 public Builder dataStoreMXBeanType(final String dataStoreMXBeanType) {
431 datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
435 public Builder shardTransactionCommitTimeoutInSeconds(final int shardTransactionCommitTimeoutInSeconds) {
436 datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
440 public Builder shardJournalRecoveryLogBatchSize(final int shardJournalRecoveryLogBatchSize) {
441 datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
445 public Builder shardSnapshotBatchCount(final int shardSnapshotBatchCount) {
446 datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
450 public Builder recoverySnapshotIntervalSeconds(final int recoverySnapshotIntervalSeconds) {
451 checkArgument(recoverySnapshotIntervalSeconds >= 0);
452 datastoreContext.setRecoverySnapshotIntervalSeconds(recoverySnapshotIntervalSeconds);
456 public Builder shardSnapshotDataThresholdPercentage(final int shardSnapshotDataThresholdPercentage) {
457 datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
461 public Builder shardSnapshotDataThreshold(final int shardSnapshotDataThreshold) {
462 datastoreContext.setSnapshotDataThreshold(shardSnapshotDataThreshold);
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 snapshotOnRootOverwrite(final boolean snapshotOnRootOverwrite) {
511 datastoreContext.snapshotOnRootOverwrite = snapshotOnRootOverwrite;
515 public Builder shardIsolatedLeaderCheckIntervalInMillis(final int shardIsolatedLeaderCheckIntervalInMillis) {
516 datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
520 public Builder shardElectionTimeoutFactor(final long shardElectionTimeoutFactor) {
521 datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
525 public Builder shardCandidateElectionTimeoutDivisor(final long candidateElectionTimeoutDivisor) {
526 datastoreContext.setCandidateElectionTimeoutDivisor(candidateElectionTimeoutDivisor);
530 public Builder transactionCreationInitialRateLimit(final long initialRateLimit) {
531 datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
535 public Builder logicalStoreType(final LogicalDatastoreType logicalStoreType) {
536 datastoreContext.logicalStoreType = requireNonNull(logicalStoreType);
538 // Retain compatible naming
539 switch (logicalStoreType) {
541 dataStoreName("config");
544 dataStoreName("operational");
547 dataStoreName(logicalStoreType.name());
553 public Builder storeRoot(final YangInstanceIdentifier storeRoot) {
554 datastoreContext.storeRoot = storeRoot;
558 public Builder dataStoreName(final String dataStoreName) {
559 datastoreContext.dataStoreName = requireNonNull(dataStoreName);
560 datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreName) + "Datastore";
564 public Builder shardBatchedModificationCount(final int shardBatchedModificationCount) {
565 datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
569 public Builder writeOnlyTransactionOptimizationsEnabled(final boolean value) {
570 datastoreContext.writeOnlyTransactionOptimizationsEnabled = value;
574 public Builder shardCommitQueueExpiryTimeoutInMillis(final long value) {
575 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = value;
579 public Builder shardCommitQueueExpiryTimeoutInSeconds(final long value) {
580 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = TimeUnit.MILLISECONDS.convert(
581 value, TimeUnit.SECONDS);
585 public Builder transactionDebugContextEnabled(final boolean value) {
586 datastoreContext.transactionDebugContextEnabled = value;
590 @Deprecated(forRemoval = true)
591 public Builder maxShardDataChangeExecutorPoolSize(final int newMaxShardDataChangeExecutorPoolSize) {
595 @Deprecated(forRemoval = true)
596 public Builder maxShardDataChangeExecutorQueueSize(final int newMaxShardDataChangeExecutorQueueSize) {
600 @Deprecated(forRemoval = true)
601 public Builder maxShardDataChangeListenerQueueSize(final int newMaxShardDataChangeListenerQueueSize) {
605 @Deprecated(forRemoval = true)
606 public Builder maxShardDataStoreExecutorQueueSize(final int newMaxShardDataStoreExecutorQueueSize) {
610 public Builder useTellBasedProtocol(final boolean value) {
611 datastoreContext.useTellBasedProtocol = value;
615 public Builder useLz4Compression(final boolean value) {
616 datastoreContext.useLz4Compression = value;
621 * For unit tests only.
624 public Builder shardManagerPersistenceId(final String id) {
625 datastoreContext.shardManagerPersistenceId = id;
629 public Builder customRaftPolicyImplementation(final String customRaftPolicyImplementation) {
630 datastoreContext.setCustomRaftPolicyImplementation(customRaftPolicyImplementation);
635 public Builder shardSnapshotChunkSize(final int shardSnapshotChunkSize) {
636 LOG.warn("The shard-snapshot-chunk-size configuration parameter is deprecated - "
637 + "use maximum-message-slice-size instead");
638 datastoreContext.setShardSnapshotChunkSize(shardSnapshotChunkSize);
642 public Builder maximumMessageSliceSize(final int maximumMessageSliceSize) {
643 datastoreContext.setMaximumMessageSliceSize(maximumMessageSliceSize);
647 public Builder shardPeerAddressResolver(final PeerAddressResolver resolver) {
648 datastoreContext.setPeerAddressResolver(resolver);
652 public Builder tempFileDirectory(final String tempFileDirectory) {
653 datastoreContext.setTempFileDirectory(tempFileDirectory);
657 public Builder fileBackedStreamingThresholdInMegabytes(final int fileBackedStreamingThreshold) {
658 datastoreContext.setFileBackedStreamingThreshold(fileBackedStreamingThreshold * ConfigParams.MEGABYTE);
662 public Builder syncIndexThreshold(final long syncIndexThreshold) {
663 datastoreContext.setSyncIndexThreshold(syncIndexThreshold);
667 public Builder backendAlivenessTimerIntervalInSeconds(final long interval) {
668 datastoreContext.backendAlivenessTimerInterval = TimeUnit.SECONDS.toNanos(interval);
672 public Builder frontendRequestTimeoutInSeconds(final long timeout) {
673 datastoreContext.requestTimeout = TimeUnit.SECONDS.toNanos(timeout);
677 public Builder frontendNoProgressTimeoutInSeconds(final long timeout) {
678 datastoreContext.noProgressTimeout = TimeUnit.SECONDS.toNanos(timeout);
682 public Builder initialPayloadSerializedBufferCapacity(final int capacity) {
683 datastoreContext.initialPayloadSerializedBufferCapacity = capacity;
688 public DatastoreContext build() {
689 if (datastoreContext.dataStoreName != null) {
690 GLOBAL_DATASTORE_NAMES.add(datastoreContext.dataStoreName);
693 return datastoreContext;