Fix ShardManagerInfo JMX registration error

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

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardmanager/ShardManagerInfoMBean.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardmanager/ShardManagerInfoMBean.java
new file mode 100644 (file)
index 0000000..5f34578
--- /dev/null
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardmanager/ShardManagerInfoMBean.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.controller.cluster.datastore.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();
+
+    /**
+     * Get the name of of the current member
+     *
+     * @return
+     */
+    String getMemberName();
+
+    /**
+     * 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);
+}