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
9 package org.opendaylight.controller.cluster.datastore.config;
11 import java.util.Collection;
13 import javax.annotation.Nonnull;
14 import javax.annotation.Nullable;
15 import org.opendaylight.controller.cluster.access.concepts.MemberName;
16 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategy;
18 public interface Configuration {
21 * Returns all the shard names that belong on the member by the given name.
23 @Nonnull Collection<String> getMemberShardNames(@Nonnull MemberName memberName);
26 * Returns the module name for the given namespace name or null if not found.
28 @Nullable String getModuleNameFromNameSpace(@Nonnull String nameSpace);
31 * Returns the first shard name corresponding to the given module name or null if none is configured.
33 @Nullable String getShardNameForModule(@Nonnull String moduleName);
36 * Returns the member replicas for the given shard name.
38 @Nonnull Collection<MemberName> getMembersFromShardName(@Nonnull String shardName);
41 * Returns the ShardStrategy for the given module name or null if the module is not found.
43 @Nullable ShardStrategy getStrategyForModule(@Nonnull String moduleName);
46 * Returns all the configured shard names.
48 Set<String> getAllShardNames();
51 * Adds a new configuration for a module and shard.
53 void addModuleShardConfiguration(@Nonnull ModuleShardConfiguration config);
56 * Returns a unique set of all member names configured for all shards.
58 Collection<MemberName> getUniqueMemberNamesForAllShards();
61 * Verifies if the given module shard in available in the cluster
63 boolean isShardConfigured(String shardName);
66 * Adds the given member as the new replica for the given shardName
68 void addMemberReplicaForShard (String shardName, MemberName memberName);
71 * Removes the given member as a replica for the given shardName
73 void removeMemberReplicaForShard (String shardName, MemberName memberName);