3bf37e0f3812834f0ec5522b95adedb73c00b2b4
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / config / Configuration.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
9 package org.opendaylight.controller.cluster.datastore.config;
10
11 import java.util.Collection;
12 import java.util.Set;
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;
17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
18
19 public interface Configuration {
20
21     /**
22      * Returns all the shard names that belong on the member by the given name.
23      */
24     @Nonnull Collection<String> getMemberShardNames(@Nonnull MemberName memberName);
25
26     /**
27      * Returns the module name for the given namespace name or null if not found.
28      */
29     @Nullable String getModuleNameFromNameSpace(@Nonnull String nameSpace);
30
31     /**
32      * Returns the first shard name corresponding to the given module name or null if none is configured.
33      */
34     @Nullable String getShardNameForModule(@Nonnull String moduleName);
35
36     /**
37      * Return the shard name corresponding to the prefix, or null if none is configured.
38      */
39     @Nullable String getShardNameForPrefix(@Nonnull YangInstanceIdentifier prefix);
40
41     /**
42      * Returns the member replicas for the given shard name.
43      */
44     @Nonnull Collection<MemberName> getMembersFromShardName(@Nonnull String shardName);
45
46     /**
47      * Returns the ShardStrategy for the given module name or null if the module is not found.
48      */
49     @Nullable ShardStrategy getStrategyForModule(@Nonnull String moduleName);
50
51     /**
52      * Returns all the configured shard names.
53      */
54     Set<String> getAllShardNames();
55
56     /**
57      * Adds a new configuration for a module and shard.
58      */
59     void addModuleShardConfiguration(@Nonnull ModuleShardConfiguration config);
60
61     /**
62      * Adds a new configuration for a shard based on prefix.
63      */
64     void addPrefixShardConfiguration(@Nonnull PrefixShardConfiguration config);
65
66     /**
67      * Returns a unique set of all member names configured for all shards.
68      */
69     Collection<MemberName> getUniqueMemberNamesForAllShards();
70
71     /*
72      * Verifies if the given module shard in available in the cluster
73      */
74     boolean isShardConfigured(String shardName);
75
76     /**
77      * Adds the given member as the new replica for the given shardName.
78      */
79     void addMemberReplicaForShard(String shardName, MemberName memberName);
80
81     /**
82      * Removes the given member as a replica for the given shardName.
83      */
84     void removeMemberReplicaForShard(String shardName, MemberName memberName);
85
86     /**
87      * Returns the ShardStrategy for the given prefix or null if the prefix is not found.
88      */
89     @Nullable ShardStrategy getStrategyForPrefix(@Nonnull YangInstanceIdentifier prefix);
90 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.