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; |
tom | ee49c37 | 2014-09-26 15:14:50 -0700 | [diff] [blame] | 4 | import org.onlab.packet.IpPrefix; |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 5 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 6 | import java.util.Set; |
| 7 | |
| 8 | /** |
| 9 | * Manages inventory of controller cluster nodes; not intended for direct use. |
| 10 | */ |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 11 | public interface ClusterStore extends Store<ClusterEvent, ClusterStoreDelegate> { |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 12 | |
| 13 | /** |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 14 | * Returns the local controller node. |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 15 | * |
| 16 | * @return local controller instance |
| 17 | */ |
| 18 | ControllerNode getLocalNode(); |
| 19 | |
| 20 | /** |
| 21 | * Returns the set of current cluster members. |
| 22 | * |
| 23 | * @return set of cluster members |
| 24 | */ |
| 25 | Set<ControllerNode> getNodes(); |
| 26 | |
| 27 | /** |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 28 | * Returns the specified controller node. |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 29 | * |
| 30 | * @param nodeId controller instance identifier |
| 31 | * @return controller instance |
| 32 | */ |
| 33 | ControllerNode getNode(NodeId nodeId); |
| 34 | |
| 35 | /** |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 36 | * Returns the availability state of the specified controller node. |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 37 | * |
| 38 | * @param nodeId controller instance identifier |
| 39 | * @return availability state |
| 40 | */ |
| 41 | ControllerNode.State getState(NodeId nodeId); |
| 42 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 43 | /** |
tom | ee49c37 | 2014-09-26 15:14:50 -0700 | [diff] [blame] | 44 | * Adds a new controller node to the cluster. |
| 45 | * |
| 46 | * @param nodeId controller node identifier |
| 47 | * @param ip node IP listen address |
| 48 | * @param tcpPort tcp listen port |
| 49 | * @return newly added node |
| 50 | */ |
| 51 | ControllerNode addNode(NodeId nodeId, IpPrefix ip, int tcpPort); |
| 52 | |
| 53 | /** |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 54 | * Removes the specified node from the inventory of cluster nodes. |
| 55 | * |
| 56 | * @param nodeId controller instance identifier |
| 57 | */ |
| 58 | void removeNode(NodeId nodeId); |
| 59 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 60 | } |