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

   1 /*
   2  * Copyright (c) 2014 Cisco 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 package org.opendaylight.controller.cluster.datastore.config;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableMap;
  13 import com.google.common.collect.ImmutableSet;
  14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  15 import java.util.ArrayList;
  16 import java.util.Collection;
  17 import java.util.HashMap;
  18 import java.util.HashSet;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.Map.Entry;
  22 import java.util.Set;
  23 import org.opendaylight.controller.cluster.access.concepts.MemberName;
  24 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategy;
  25 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
  26
  27 // FIXME: Non-final for testing
  28 public class ConfigurationImpl implements Configuration {
  29     private volatile Map<String, ModuleConfig> moduleConfigMap;
  30
  31     // Look up maps to speed things up
  32
  33     private volatile Map<String, String> namespaceToModuleName;
  34     private volatile Set<String> allShardNames;
  35
  36     public ConfigurationImpl(final String moduleShardsConfigPath, final String modulesConfigPath) {
  37         this(new FileModuleShardConfigProvider(moduleShardsConfigPath, modulesConfigPath));
  38     }
  39
  40     @SuppressFBWarnings(value = "MC_OVERRIDABLE_METHOD_CALL_IN_CONSTRUCTOR", justification = "Subclassed for testing")
  41     public ConfigurationImpl(final ModuleShardConfigProvider provider) {
  42         ImmutableMap.Builder<String, ModuleConfig> mapBuilder = ImmutableMap.builder();
  43         for (Entry<String, ModuleConfig.Builder> e: provider.retrieveModuleConfigs(this).entrySet()) {
  44             mapBuilder.put(e.getKey(), e.getValue().build());
  45         }
  46
  47         moduleConfigMap = mapBuilder.build();
  48
  49         allShardNames = createAllShardNames(moduleConfigMap.values());
  50         namespaceToModuleName = createNamespaceToModuleName(moduleConfigMap.values());
  51     }
  52
  53     private static Set<String> createAllShardNames(final Iterable<ModuleConfig> moduleConfigs) {
  54         final ImmutableSet.Builder<String> builder = ImmutableSet.builder();
  55         for (ModuleConfig moduleConfig : moduleConfigs) {
  56             builder.addAll(moduleConfig.getShardNames());
  57         }
  58
  59         return builder.build();
  60     }
  61
  62     private static Map<String, String> createNamespaceToModuleName(final Iterable<ModuleConfig> moduleConfigs) {
  63         final ImmutableMap.Builder<String, String> builder = ImmutableMap.builder();
  64         for (ModuleConfig moduleConfig : moduleConfigs) {
  65             if (moduleConfig.getNamespace() != null) {
  66                 builder.put(moduleConfig.getNamespace(), moduleConfig.getName());
  67             }
  68         }
  69
  70         return builder.build();
  71     }
  72
  73     @Override
  74     public Collection<String> getMemberShardNames(final MemberName memberName) {
  75         requireNonNull(memberName, "memberName should not be null");
  76
  77         List<String> shards = new ArrayList<>();
  78         for (ModuleConfig moduleConfig: moduleConfigMap.values()) {
  79             for (ShardConfig shardConfig: moduleConfig.getShardConfigs()) {
  80                 if (shardConfig.getReplicas().contains(memberName)) {
  81                     shards.add(shardConfig.getName());
  82                 }
  83             }
  84         }
  85
  86         return shards;
  87     }
  88
  89     @Override
  90     public String getModuleNameFromNameSpace(final String nameSpace) {
  91         return namespaceToModuleName.get(requireNonNull(nameSpace, "nameSpace should not be null"));
  92     }
  93
  94     @Override
  95     public ShardStrategy getStrategyForModule(final String moduleName) {
  96         ModuleConfig moduleConfig = getModuleConfig(moduleName);
  97         return moduleConfig != null ? moduleConfig.getShardStrategy() : null;
  98     }
  99
 100     @Override
 101     public String getShardNameForModule(final String moduleName) {
 102         ModuleConfig moduleConfig = getModuleConfig(moduleName);
 103         if (moduleConfig != null) {
 104             Collection<ShardConfig> shardConfigs = moduleConfig.getShardConfigs();
 105             if (!shardConfigs.isEmpty()) {
 106                 return shardConfigs.iterator().next().getName();
 107             }
 108         }
 109         return null;
 110     }
 111
 112     private ModuleConfig getModuleConfig(final String moduleName) {
 113         return moduleConfigMap.get(requireNonNull(moduleName, "moduleName should not be null"));
 114     }
 115
 116     @Override
 117     public Collection<MemberName> getMembersFromShardName(final String shardName) {
 118         checkNotNullShardName(shardName);
 119
 120         for (ModuleConfig moduleConfig: moduleConfigMap.values()) {
 121             ShardConfig shardConfig = moduleConfig.getShardConfig(shardName);
 122             if (shardConfig != null) {
 123                 return shardConfig.getReplicas();
 124             }
 125         }
 126
 127         return List.of();
 128     }
 129
 130     private static void checkNotNullShardName(final String shardName) {
 131         requireNonNull(shardName, "shardName should not be null");
 132     }
 133
 134     @Override
 135     public Set<String> getAllShardNames() {
 136         return allShardNames;
 137     }
 138
 139     @Override
 140     public Collection<MemberName> getUniqueMemberNamesForAllShards() {
 141         Set<MemberName> allNames = new HashSet<>();
 142         for (String shardName: getAllShardNames()) {
 143             allNames.addAll(getMembersFromShardName(shardName));
 144         }
 145
 146         return allNames;
 147     }
 148
 149     @Override
 150     public synchronized void addModuleShardConfiguration(final ModuleShardConfiguration config) {
 151         requireNonNull(config, "ModuleShardConfiguration should not be null");
 152
 153         ModuleConfig moduleConfig = ModuleConfig.builder(config.getModuleName())
 154                 .nameSpace(config.getNamespace().toString())
 155                 .shardStrategy(createShardStrategy(config.getModuleName(), config.getShardStrategyName()))
 156                 .shardConfig(config.getShardName(), config.getShardMemberNames()).build();
 157
 158         updateModuleConfigMap(moduleConfig);
 159
 160         namespaceToModuleName = ImmutableMap.<String, String>builder().putAll(namespaceToModuleName)
 161                 .put(moduleConfig.getNamespace(), moduleConfig.getName()).build();
 162         allShardNames = ImmutableSet.<String>builder().addAll(allShardNames).add(config.getShardName()).build();
 163     }
 164
 165     private ShardStrategy createShardStrategy(final String moduleName, final String shardStrategyName) {
 166         return ShardStrategyFactory.newShardStrategyInstance(moduleName, shardStrategyName, this);
 167     }
 168
 169     @Override
 170     public boolean isShardConfigured(final String shardName) {
 171         checkNotNullShardName(shardName);
 172         return allShardNames.contains(shardName);
 173     }
 174
 175     @Override
 176     public void addMemberReplicaForShard(final String shardName, final MemberName newMemberName) {
 177         checkNotNullShardName(shardName);
 178         requireNonNull(newMemberName, "MemberName should not be null");
 179
 180         for (ModuleConfig moduleConfig: moduleConfigMap.values()) {
 181             ShardConfig shardConfig = moduleConfig.getShardConfig(shardName);
 182             if (shardConfig != null) {
 183                 Set<MemberName> replicas = new HashSet<>(shardConfig.getReplicas());
 184                 replicas.add(newMemberName);
 185                 updateModuleConfigMap(ModuleConfig.builder(moduleConfig).shardConfig(shardName, replicas).build());
 186                 return;
 187             }
 188         }
 189     }
 190
 191     @Override
 192     public void removeMemberReplicaForShard(final String shardName, final MemberName newMemberName) {
 193         checkNotNullShardName(shardName);
 194         requireNonNull(newMemberName, "MemberName should not be null");
 195
 196         for (ModuleConfig moduleConfig: moduleConfigMap.values()) {
 197             ShardConfig shardConfig = moduleConfig.getShardConfig(shardName);
 198             if (shardConfig != null) {
 199                 Set<MemberName> replicas = new HashSet<>(shardConfig.getReplicas());
 200                 replicas.remove(newMemberName);
 201                 updateModuleConfigMap(ModuleConfig.builder(moduleConfig).shardConfig(shardName, replicas).build());
 202                 return;
 203             }
 204         }
 205     }
 206
 207     private void updateModuleConfigMap(final ModuleConfig moduleConfig) {
 208         final Map<String, ModuleConfig> newModuleConfigMap = new HashMap<>(moduleConfigMap);
 209         newModuleConfigMap.put(moduleConfig.getName(), moduleConfig);
 210         moduleConfigMap = ImmutableMap.copyOf(newModuleConfigMap);
 211     }
 212 }