2 * Copyright (c) 2014 Cisco 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.config;
10 import java.util.Collection;
12 import org.eclipse.jdt.annotation.NonNull;
13 import org.eclipse.jdt.annotation.Nullable;
14 import org.opendaylight.controller.cluster.access.concepts.MemberName;
15 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategy;
17 public interface Configuration {
20 * Returns all the shard names that belong on the member by the given name.
22 @NonNull Collection<String> getMemberShardNames(@NonNull MemberName memberName);
25 * Returns the module name for the given namespace name or null if not found.
27 @Nullable String getModuleNameFromNameSpace(@NonNull String nameSpace);
30 * Returns the first shard name corresponding to the given module name or null if none is configured.
32 @Nullable String getShardNameForModule(@NonNull String moduleName);
35 * Returns the member replicas for the given shard name.
37 @NonNull Collection<MemberName> getMembersFromShardName(@NonNull String shardName);
40 * Returns the ShardStrategy for the given module name or null if the module is not found.
42 @Nullable ShardStrategy getStrategyForModule(@NonNull String moduleName);
45 * Returns all the configured shard names.
47 Set<String> getAllShardNames();
50 * Adds a new configuration for a module and shard.
52 void addModuleShardConfiguration(@NonNull ModuleShardConfiguration config);
55 * Returns a unique set of all member names configured for all shards.
57 Collection<MemberName> getUniqueMemberNamesForAllShards();
60 * Verifies if the given module shard in available in the cluster
62 boolean isShardConfigured(String shardName);
65 * Adds the given member as the new replica for the given shardName.
67 void addMemberReplicaForShard(String shardName, MemberName memberName);
70 * Removes the given member as a replica for the given shardName.
72 void removeMemberReplicaForShard(String shardName, MemberName memberName);