BUG 2138: Introduce prefix based shards into ShardManager

[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / config / Configuration.java

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/config/Configuration.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/config/Configuration.java
index b6122b3d29f4f07eada831feaa5765c3a073047f..3bf37e0f3812834f0ec5522b95adedb73c00b2b4 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/config/Configuration.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/config/Configuration.java
@@ -12,14 +12,16 @@ import java.util.Collection;
 import java.util.Set;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
+import org.opendaylight.controller.cluster.access.concepts.MemberName;
 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategy;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 
 public interface Configuration {
 
     /**
      * Returns all the shard names that belong on the member by the given name.
      */
-    @Nonnull Collection<String> getMemberShardNames(@Nonnull String memberName);
+    @Nonnull Collection<String> getMemberShardNames(@Nonnull MemberName memberName);
 
     /**
      * Returns the module name for the given namespace name or null if not found.
@@ -31,10 +33,15 @@ public interface Configuration {
      */
     @Nullable String getShardNameForModule(@Nonnull String moduleName);
 
+    /**
+     * Return the shard name corresponding to the prefix, or null if none is configured.
+     */
+    @Nullable String getShardNameForPrefix(@Nonnull YangInstanceIdentifier prefix);
+
     /**
      * Returns the member replicas for the given shard name.
      */
-    @Nonnull Collection<String> getMembersFromShardName(@Nonnull String shardName);
+    @Nonnull Collection<MemberName> getMembersFromShardName(@Nonnull String shardName);
 
     /**
      * Returns the ShardStrategy for the given module name or null if the module is not found.
@@ -51,10 +58,15 @@ public interface Configuration {
      */
     void addModuleShardConfiguration(@Nonnull ModuleShardConfiguration config);
 
+    /**
+     * Adds a new configuration for a shard based on prefix.
+     */
+    void addPrefixShardConfiguration(@Nonnull PrefixShardConfiguration config);
+
     /**
      * Returns a unique set of all member names configured for all shards.
      */
-    Collection<String> getUniqueMemberNamesForAllShards();
+    Collection<MemberName> getUniqueMemberNamesForAllShards();
 
     /*
      * Verifies if the given module shard in available in the cluster
@@ -62,12 +74,17 @@ public interface Configuration {
     boolean isShardConfigured(String shardName);
 
     /**
-     * Adds the given member as the new replica for the given shardName
+     * Adds the given member as the new replica for the given shardName.
+     */
+    void addMemberReplicaForShard(String shardName, MemberName memberName);
+
+    /**
+     * Removes the given member as a replica for the given shardName.
      */
-    void addMemberReplicaForShard (String shardName, String memberName);
+    void removeMemberReplicaForShard(String shardName, MemberName memberName);
 
     /**
-     * Removes the given member as a replica for the given shardName
+     * Returns the ShardStrategy for the given prefix or null if the prefix is not found.
      */
-    void removeMemberReplicaForShard (String shardName, String memberName);
+    @Nullable ShardStrategy getStrategyForPrefix(@Nonnull YangInstanceIdentifier prefix);
 }