package org.opendaylight.controller.cluster.datastore.config;
-import com.google.common.base.Optional;
import java.util.Collection;
-import java.util.List;
import java.util.Map;
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.mdsal.dom.api.DOMDataTreeIdentifier;
public interface Configuration {
/**
- * Given a memberName find all the shards that belong on that member and
- * return the names of those shards
- *
- * @param memberName
- * @return
+ * Returns all the shard names that belong on the member by the given name.
*/
- List<String> getMemberShardNames(String memberName);
+ @Nonnull Collection<String> getMemberShardNames(@Nonnull MemberName memberName);
/**
- * Given a module namespace return the name of a module
- * @param nameSpace
- * @return
+ * Returns the module name for the given namespace name or null if not found.
*/
- Optional<String> getModuleNameFromNameSpace(String nameSpace);
+ @Nullable String getModuleNameFromNameSpace(@Nonnull String nameSpace);
/**
- * Get a mapping of the module names to it's corresponding ShardStrategy
- * @return
+ * Returns the first shard name corresponding to the given module name or null if none is configured.
*/
- Map<String, ShardStrategy> getModuleNameToShardStrategyMap();
+ @Nullable String getShardNameForModule(@Nonnull String moduleName);
/**
- * Given a module name find all the shardNames corresponding to it
- * @param moduleName
- * @return
+ * Return the shard name corresponding to the prefix, or null if none is configured.
*/
- List<String> getShardNamesFromModuleName(String moduleName);
+ @Nullable String getShardNameForPrefix(@Nonnull DOMDataTreeIdentifier prefix);
/**
- * Given a shardName find all the members on which it belongs
- *
- * @param shardName
- * @return
+ * Returns the member replicas for the given shard name.
*/
- List<String> getMembersFromShardName(String shardName);
+ @Nonnull Collection<MemberName> getMembersFromShardName(@Nonnull String shardName);
/**
- *
- * @return
+ * Returns the ShardStrategy for the given module name or null if the module is not found.
+ */
+ @Nullable ShardStrategy getStrategyForModule(@Nonnull String moduleName);
+
+ /**
+ * Returns all the configured shard names.
*/
Set<String> getAllShardNames();
+ /**
+ * Adds a new configuration for a module and shard.
+ */
+ void addModuleShardConfiguration(@Nonnull ModuleShardConfiguration config);
+
+ /**
+ * Adds a new configuration for a shard based on prefix.
+ */
+ void addPrefixShardConfiguration(@Nonnull PrefixShardConfiguration config);
+
+ /**
+ * Removes a shard configuration for the specified prefix.
+ */
+ void removePrefixShardConfiguration(@Nonnull DOMDataTreeIdentifier prefix);
+
+ /**
+ * Returns the configuration for all configured prefix shards.
+ *
+ * @return An immutable copy of the currently configured prefix shards.
+ */
+ Map<DOMDataTreeIdentifier, PrefixShardConfiguration> getAllPrefixShardConfigurations();
+
/**
* 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
+ */
+ boolean isShardConfigured(String 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 removeMemberReplicaForShard(String shardName, MemberName memberName);
+
+ /**
+ * Returns the ShardStrategy for the given prefix or null if the prefix is not found.
+ */
+ @Nullable ShardStrategy getStrategyForPrefix(@Nonnull DOMDataTreeIdentifier prefix);
}