opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DatastoreContext.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.cluster.datastore;
  10
  11 import org.opendaylight.controller.cluster.datastore.config.ConfigurationReader;
  12 import org.opendaylight.controller.cluster.datastore.config.FileConfigurationReader;
  13 import org.opendaylight.controller.cluster.raft.ConfigParams;
  14 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
  15 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreConfigProperties;
  16 import akka.util.Timeout;
  17 import scala.concurrent.duration.Duration;
  18 import scala.concurrent.duration.FiniteDuration;
  19
  20 import java.util.concurrent.TimeUnit;
  21
  22 /**
  23  * Contains contextual data for a data store.
  24  *
  25  * @author Thomas Pantelis
  26  */
  27 public class DatastoreContext {
  28
  29     private final InMemoryDOMDataStoreConfigProperties dataStoreProperties;
  30     private final Duration shardTransactionIdleTimeout;
  31     private final int operationTimeoutInSeconds;
  32     private final String dataStoreMXBeanType;
  33     private final ConfigParams shardRaftConfig;
  34     private final int shardTransactionCommitTimeoutInSeconds;
  35     private final int shardTransactionCommitQueueCapacity;
  36     private final Timeout shardInitializationTimeout;
  37     private final Timeout shardLeaderElectionTimeout;
  38     private final boolean persistent;
  39     private final ConfigurationReader configurationReader;
  40
  41     private DatastoreContext(InMemoryDOMDataStoreConfigProperties dataStoreProperties,
  42             ConfigParams shardRaftConfig, String dataStoreMXBeanType, int operationTimeoutInSeconds,
  43             Duration shardTransactionIdleTimeout, int shardTransactionCommitTimeoutInSeconds,
  44             int shardTransactionCommitQueueCapacity, Timeout shardInitializationTimeout,
  45             Timeout shardLeaderElectionTimeout,
  46             boolean persistent, ConfigurationReader configurationReader) {
  47         this.dataStoreProperties = dataStoreProperties;
  48         this.shardRaftConfig = shardRaftConfig;
  49         this.dataStoreMXBeanType = dataStoreMXBeanType;
  50         this.operationTimeoutInSeconds = operationTimeoutInSeconds;
  51         this.shardTransactionIdleTimeout = shardTransactionIdleTimeout;
  52         this.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
  53         this.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
  54         this.shardInitializationTimeout = shardInitializationTimeout;
  55         this.shardLeaderElectionTimeout = shardLeaderElectionTimeout;
  56         this.persistent = persistent;
  57         this.configurationReader = configurationReader;
  58     }
  59
  60     public static Builder newBuilder() {
  61         return new Builder();
  62     }
  63
  64     public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
  65         return dataStoreProperties;
  66     }
  67
  68     public Duration getShardTransactionIdleTimeout() {
  69         return shardTransactionIdleTimeout;
  70     }
  71
  72     public String getDataStoreMXBeanType() {
  73         return dataStoreMXBeanType;
  74     }
  75
  76     public int getOperationTimeoutInSeconds() {
  77         return operationTimeoutInSeconds;
  78     }
  79
  80     public ConfigParams getShardRaftConfig() {
  81         return shardRaftConfig;
  82     }
  83
  84     public int getShardTransactionCommitTimeoutInSeconds() {
  85         return shardTransactionCommitTimeoutInSeconds;
  86     }
  87
  88     public int getShardTransactionCommitQueueCapacity() {
  89         return shardTransactionCommitQueueCapacity;
  90     }
  91
  92     public Timeout getShardInitializationTimeout() {
  93         return shardInitializationTimeout;
  94     }
  95
  96     public Timeout getShardLeaderElectionTimeout() {
  97         return shardLeaderElectionTimeout;
  98     }
  99
 100     public boolean isPersistent() {
 101         return persistent;
 102     }
 103
 104     public ConfigurationReader getConfigurationReader() {
 105         return configurationReader;
 106     }
 107
 108     public static class Builder {
 109         private InMemoryDOMDataStoreConfigProperties dataStoreProperties;
 110         private Duration shardTransactionIdleTimeout = Duration.create(10, TimeUnit.MINUTES);
 111         private int operationTimeoutInSeconds = 5;
 112         private String dataStoreMXBeanType;
 113         private int shardTransactionCommitTimeoutInSeconds = 30;
 114         private int shardJournalRecoveryLogBatchSize = 1000;
 115         private int shardSnapshotBatchCount = 20000;
 116         private int shardHeartbeatIntervalInMillis = 500;
 117         private int shardTransactionCommitQueueCapacity = 20000;
 118         private Timeout shardInitializationTimeout = new Timeout(5, TimeUnit.MINUTES);
 119         private Timeout shardLeaderElectionTimeout = new Timeout(30, TimeUnit.SECONDS);
 120         private boolean persistent = true;
 121         private ConfigurationReader configurationReader = new FileConfigurationReader();
 122         private int shardIsolatedLeaderCheckIntervalInMillis = shardHeartbeatIntervalInMillis * 10;
 123
 124         public Builder shardTransactionIdleTimeout(Duration shardTransactionIdleTimeout) {
 125             this.shardTransactionIdleTimeout = shardTransactionIdleTimeout;
 126             return this;
 127         }
 128
 129         public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
 130             this.operationTimeoutInSeconds = operationTimeoutInSeconds;
 131             return this;
 132         }
 133
 134         public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
 135             this.dataStoreMXBeanType = dataStoreMXBeanType;
 136             return this;
 137         }
 138
 139         public Builder dataStoreProperties(InMemoryDOMDataStoreConfigProperties dataStoreProperties) {
 140             this.dataStoreProperties = dataStoreProperties;
 141             return this;
 142         }
 143
 144         public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
 145             this.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
 146             return this;
 147         }
 148
 149         public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
 150             this.shardJournalRecoveryLogBatchSize = shardJournalRecoveryLogBatchSize;
 151             return this;
 152         }
 153
 154         public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
 155             this.shardSnapshotBatchCount = shardSnapshotBatchCount;
 156             return this;
 157         }
 158
 159         public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
 160             this.shardHeartbeatIntervalInMillis = shardHeartbeatIntervalInMillis;
 161             return this;
 162         }
 163
 164         public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
 165             this.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
 166             return this;
 167         }
 168
 169         public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
 170             this.shardInitializationTimeout = new Timeout(timeout, unit);
 171             return this;
 172         }
 173
 174         public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
 175             this.shardLeaderElectionTimeout = new Timeout(timeout, unit);
 176             return this;
 177         }
 178
 179         public Builder configurationReader(ConfigurationReader configurationReader){
 180             this.configurationReader = configurationReader;
 181             return this;
 182         }
 183
 184         public Builder persistent(boolean persistent){
 185             this.persistent = persistent;
 186             return this;
 187         }
 188
 189         public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
 190             this.shardIsolatedLeaderCheckIntervalInMillis = shardIsolatedLeaderCheckIntervalInMillis;
 191             return this;
 192         }
 193
 194         public DatastoreContext build() {
 195             DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
 196             raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
 197                     TimeUnit.MILLISECONDS));
 198             raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
 199             raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
 200             raftConfig.setIsolatedLeaderCheckInterval(
 201                 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
 202
 203             return new DatastoreContext(dataStoreProperties, raftConfig, dataStoreMXBeanType,
 204                     operationTimeoutInSeconds, shardTransactionIdleTimeout,
 205                     shardTransactionCommitTimeoutInSeconds, shardTransactionCommitQueueCapacity,
 206                     shardInitializationTimeout, shardLeaderElectionTimeout,
 207                     persistent, configurationReader);
 208         }
 209     }
 210 }