Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.cluster; |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 17 | |
| 18 | import java.util.Set; |
| 19 | |
| 20 | /** |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 21 | * Service for obtaining information about the individual nodes within |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 22 | * the controller cluster. |
| 23 | */ |
| 24 | public interface ClusterService { |
| 25 | |
| 26 | /** |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 27 | * Returns the local controller node. |
| 28 | * |
| 29 | * @return local controller node |
| 30 | */ |
| 31 | ControllerNode getLocalNode(); |
| 32 | |
| 33 | /** |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 34 | * Returns the set of current cluster members. |
| 35 | * |
| 36 | * @return set of cluster members |
| 37 | */ |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 38 | Set<ControllerNode> getNodes(); |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 39 | |
| 40 | /** |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 41 | * Returns the specified controller node. |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 42 | * |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 43 | * @param nodeId controller node identifier |
| 44 | * @return controller node |
| 45 | */ |
| 46 | ControllerNode getNode(NodeId nodeId); |
| 47 | |
| 48 | /** |
| 49 | * Returns the availability state of the specified controller node. |
| 50 | * |
| 51 | * @param nodeId controller node identifier |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 52 | * @return availability state |
| 53 | */ |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 54 | ControllerNode.State getState(NodeId nodeId); |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 55 | |
tom | fc9a4ff | 2014-09-22 18:22:47 -0700 | [diff] [blame] | 56 | /** |
| 57 | * Adds the specified cluster event listener. |
| 58 | * |
| 59 | * @param listener the cluster listener |
| 60 | */ |
| 61 | void addListener(ClusterEventListener listener); |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 62 | |
tom | fc9a4ff | 2014-09-22 18:22:47 -0700 | [diff] [blame] | 63 | /** |
| 64 | * Removes the specified cluster event listener. |
| 65 | * |
| 66 | * @param listener the cluster listener |
| 67 | */ |
| 68 | void removeListener(ClusterEventListener listener); |
tom | 73d6d1e | 2014-09-17 20:08:01 -0700 | [diff] [blame] | 69 | |
| 70 | } |