BUG 2185 : Add JMX API to change the state of a Shard

[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / jmx / mbeans / shardmanager / ShardManagerInfoMBean.java

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/jmx/mbeans/shardmanager/ShardManagerInfoMBean.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/jmx/mbeans/shardmanager/ShardManagerInfoMBean.java
index b64ba747827d3eb6c90d6d6b7ed043cf6986e1e1..da0331eb77cfd6383bf6b602933de1dc97d8da18 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/jmx/mbeans/shardmanager/ShardManagerInfoMBean.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/jmx/mbeans/shardmanager/ShardManagerInfoMBean.java
@@ -11,6 +11,38 @@ package org.opendaylight.controller.cluster.datastore.jmx.mbeans.shardmanager;
 import java.util.List;
 
 public interface ShardManagerInfoMBean {
+    /**
+     *
+     * @return a list of all the local shard names
+     */
     List<String> getLocalShards();
+
+    /**
+     *
+     * @return true if all local shards are in sync with their corresponding leaders
+     */
     boolean getSyncStatus();
+
+    /**
+     * Switch the Raft Behavior of all the local shards to the newBehavior
+     *
+     * @param newBehavior should be either Leader/Follower only
+     * @param term when switching to the Leader specifies for which term the Shard would be the Leader. Any modifications
+     *             made to state will be written with this term. This term will then be used by the Raft replication
+     *             implementation to decide which modifications should stay and which ones should be removed. Ideally
+     *             the term provided when switching to a new Leader should always be higher than the previous term.
+     */
+    void switchAllLocalShardsState(String newBehavior, long term);
+
+    /**
+     * Switch the Raft Behavior of the shard specified by shardName to the newBehavior
+     *
+     * @param shardName a shard that is local to this shard manager
+     * @param newBehavior should be either Leader/Follower only
+     * @param term when switching to the Leader specifies for which term the Shard would be the Leader. Any modifications
+     *             made to state will be written with this term. This term will then be used by the Raft replication
+     *             implementation to decide which modifications should stay and which ones should be removed. Ideally
+     *             the term provided when switching to a new Leader should always be higher than the previous term.
+     */
+    void switchShardState(String shardName, String newBehavior, long term);
 }