tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 1 | package org.onlab.onos.cluster; |
| 2 | |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame^] | 3 | import org.onlab.onos.store.Store; |
| 4 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 5 | import java.util.Set; |
| 6 | |
| 7 | /** |
| 8 | * Manages inventory of controller cluster nodes; not intended for direct use. |
| 9 | */ |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame^] | 10 | public interface ClusterStore extends Store<ClusterEvent, ClusterStoreDelegate> { |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 11 | |
| 12 | /** |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 13 | * Returns the local controller node. |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 14 | * |
| 15 | * @return local controller instance |
| 16 | */ |
| 17 | ControllerNode getLocalNode(); |
| 18 | |
| 19 | /** |
| 20 | * Returns the set of current cluster members. |
| 21 | * |
| 22 | * @return set of cluster members |
| 23 | */ |
| 24 | Set<ControllerNode> getNodes(); |
| 25 | |
| 26 | /** |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 27 | * Returns the specified controller node. |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 28 | * |
| 29 | * @param nodeId controller instance identifier |
| 30 | * @return controller instance |
| 31 | */ |
| 32 | ControllerNode getNode(NodeId nodeId); |
| 33 | |
| 34 | /** |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 35 | * Returns the availability state of the specified controller node. |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 36 | * |
| 37 | * @param nodeId controller instance identifier |
| 38 | * @return availability state |
| 39 | */ |
| 40 | ControllerNode.State getState(NodeId nodeId); |
| 41 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 42 | /** |
| 43 | * Removes the specified node from the inventory of cluster nodes. |
| 44 | * |
| 45 | * @param nodeId controller instance identifier |
| 46 | */ |
| 47 | void removeNode(NodeId nodeId); |
| 48 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 49 | } |