tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 1 | package org.onlab.onos.cluster; |
| 2 | |
| 3 | import java.util.Set; |
| 4 | |
| 5 | /** |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 6 | * Service for obtaining information about the individual nodes within |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 7 | * the controller cluster. |
| 8 | */ |
| 9 | public interface ClusterService { |
| 10 | |
| 11 | /** |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 12 | * Returns the local controller node. |
| 13 | * |
| 14 | * @return local controller node |
| 15 | */ |
| 16 | ControllerNode getLocalNode(); |
| 17 | |
| 18 | /** |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 19 | * Returns the set of current cluster members. |
| 20 | * |
| 21 | * @return set of cluster members |
| 22 | */ |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 23 | Set<ControllerNode> getNodes(); |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 24 | |
| 25 | /** |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 26 | * Returns the specified controller node. |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 27 | * |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 28 | * @param nodeId controller node identifier |
| 29 | * @return controller node |
| 30 | */ |
| 31 | ControllerNode getNode(NodeId nodeId); |
| 32 | |
| 33 | /** |
| 34 | * Returns the availability state of the specified controller node. |
| 35 | * |
| 36 | * @param nodeId controller node identifier |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 37 | * @return availability state |
| 38 | */ |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 39 | ControllerNode.State getState(NodeId nodeId); |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 40 | |
tom | fc9a4ff | 2014-09-22 18:22:47 -0700 | [diff] [blame] | 41 | /** |
| 42 | * Adds the specified cluster event listener. |
| 43 | * |
| 44 | * @param listener the cluster listener |
| 45 | */ |
| 46 | void addListener(ClusterEventListener listener); |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 47 | |
tom | fc9a4ff | 2014-09-22 18:22:47 -0700 | [diff] [blame] | 48 | /** |
| 49 | * Removes the specified cluster event listener. |
| 50 | * |
| 51 | * @param listener the cluster listener |
| 52 | */ |
| 53 | void removeListener(ClusterEventListener listener); |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 54 | |
| 55 | } |