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.opendaylight.controller.cluster.datastore.config.ConfigurationReader;
14 import org.opendaylight.controller.cluster.datastore.config.FileConfigurationReader;
15 import org.opendaylight.controller.cluster.raft.ConfigParams;
16 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
17 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreConfigProperties;
18 import scala.concurrent.duration.Duration;
19 import scala.concurrent.duration.FiniteDuration;
22 * Contains contextual data for a data store.
24 * @author Thomas Pantelis
26 public class DatastoreContext {
28 private final InMemoryDOMDataStoreConfigProperties dataStoreProperties;
29 private final Duration shardTransactionIdleTimeout;
30 private final int operationTimeoutInSeconds;
31 private final String dataStoreMXBeanType;
32 private final ConfigParams shardRaftConfig;
33 private final int shardTransactionCommitTimeoutInSeconds;
34 private final int shardTransactionCommitQueueCapacity;
35 private final Timeout shardInitializationTimeout;
36 private final Timeout shardLeaderElectionTimeout;
37 private final boolean persistent;
38 private final ConfigurationReader configurationReader;
40 private DatastoreContext(InMemoryDOMDataStoreConfigProperties dataStoreProperties,
41 ConfigParams shardRaftConfig, String dataStoreMXBeanType, int operationTimeoutInSeconds,
42 Duration shardTransactionIdleTimeout, int shardTransactionCommitTimeoutInSeconds,
43 int shardTransactionCommitQueueCapacity, Timeout shardInitializationTimeout,
44 Timeout shardLeaderElectionTimeout,
45 boolean persistent, ConfigurationReader configurationReader) {
46 this.dataStoreProperties = dataStoreProperties;
47 this.shardRaftConfig = shardRaftConfig;
48 this.dataStoreMXBeanType = dataStoreMXBeanType;
49 this.operationTimeoutInSeconds = operationTimeoutInSeconds;
50 this.shardTransactionIdleTimeout = shardTransactionIdleTimeout;
51 this.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
52 this.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
53 this.shardInitializationTimeout = shardInitializationTimeout;
54 this.shardLeaderElectionTimeout = shardLeaderElectionTimeout;
55 this.persistent = persistent;
56 this.configurationReader = configurationReader;
59 public static Builder newBuilder() {
63 public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
64 return dataStoreProperties;
67 public Duration getShardTransactionIdleTimeout() {
68 return shardTransactionIdleTimeout;
71 public String getDataStoreMXBeanType() {
72 return dataStoreMXBeanType;
75 public int getOperationTimeoutInSeconds() {
76 return operationTimeoutInSeconds;
79 public ConfigParams getShardRaftConfig() {
80 return shardRaftConfig;
83 public int getShardTransactionCommitTimeoutInSeconds() {
84 return shardTransactionCommitTimeoutInSeconds;
87 public int getShardTransactionCommitQueueCapacity() {
88 return shardTransactionCommitQueueCapacity;
91 public Timeout getShardInitializationTimeout() {
92 return shardInitializationTimeout;
95 public Timeout getShardLeaderElectionTimeout() {
96 return shardLeaderElectionTimeout;
99 public boolean isPersistent() {
103 public ConfigurationReader getConfigurationReader() {
104 return configurationReader;
107 public static class Builder {
108 private InMemoryDOMDataStoreConfigProperties dataStoreProperties;
109 private Duration shardTransactionIdleTimeout = Duration.create(10, TimeUnit.MINUTES);
110 private int operationTimeoutInSeconds = 5;
111 private String dataStoreMXBeanType;
112 private int shardTransactionCommitTimeoutInSeconds = 30;
113 private int shardJournalRecoveryLogBatchSize = 1000;
114 private int shardSnapshotBatchCount = 20000;
115 private int shardHeartbeatIntervalInMillis = 500;
116 private int shardTransactionCommitQueueCapacity = 20000;
117 private Timeout shardInitializationTimeout = new Timeout(5, TimeUnit.MINUTES);
118 private Timeout shardLeaderElectionTimeout = new Timeout(30, TimeUnit.SECONDS);
119 private boolean persistent = true;
120 private ConfigurationReader configurationReader = new FileConfigurationReader();
121 private int shardIsolatedLeaderCheckIntervalInMillis = shardHeartbeatIntervalInMillis * 10;
122 private int shardSnapshotDataThresholdPercentage = 12;
124 public Builder shardTransactionIdleTimeout(Duration shardTransactionIdleTimeout) {
125 this.shardTransactionIdleTimeout = shardTransactionIdleTimeout;
129 public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
130 this.operationTimeoutInSeconds = operationTimeoutInSeconds;
134 public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
135 this.dataStoreMXBeanType = dataStoreMXBeanType;
139 public Builder dataStoreProperties(InMemoryDOMDataStoreConfigProperties dataStoreProperties) {
140 this.dataStoreProperties = dataStoreProperties;
144 public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
145 this.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
149 public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
150 this.shardJournalRecoveryLogBatchSize = shardJournalRecoveryLogBatchSize;
154 public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
155 this.shardSnapshotBatchCount = shardSnapshotBatchCount;
159 public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
160 this.shardSnapshotDataThresholdPercentage = shardSnapshotDataThresholdPercentage;
165 public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
166 this.shardHeartbeatIntervalInMillis = shardHeartbeatIntervalInMillis;
170 public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
171 this.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
175 public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
176 this.shardInitializationTimeout = new Timeout(timeout, unit);
180 public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
181 this.shardLeaderElectionTimeout = new Timeout(timeout, unit);
185 public Builder configurationReader(ConfigurationReader configurationReader){
186 this.configurationReader = configurationReader;
190 public Builder persistent(boolean persistent){
191 this.persistent = persistent;
195 public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
196 this.shardIsolatedLeaderCheckIntervalInMillis = shardIsolatedLeaderCheckIntervalInMillis;
201 public DatastoreContext build() {
202 DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
203 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
204 TimeUnit.MILLISECONDS));
205 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
206 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
207 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
208 raftConfig.setIsolatedLeaderCheckInterval(
209 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
211 return new DatastoreContext(dataStoreProperties, raftConfig, dataStoreMXBeanType,
212 operationTimeoutInSeconds, shardTransactionIdleTimeout,
213 shardTransactionCommitTimeoutInSeconds, shardTransactionCommitQueueCapacity,
214 shardInitializationTimeout, shardLeaderElectionTimeout,
215 persistent, configurationReader);