Pavlin Radoslavov | a6b754c | 2014-11-18 13:55:37 -0800 | [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; |
Pavlin Radoslavov | a6b754c | 2014-11-18 13:55:37 -0800 | [diff] [blame] | 17 | |
Yuta HIGUCHI | c2bf3d8 | 2014-11-28 18:50:41 -0800 | [diff] [blame] | 18 | import java.util.Map; |
Madan Jampani | 5961051 | 2015-02-25 15:25:43 -0800 | [diff] [blame] | 19 | import java.util.Set; |
Ayaka Koshibe | c19b8b8 | 2015-04-08 15:18:24 -0700 | [diff] [blame] | 20 | import java.util.List; |
Yuta HIGUCHI | c2bf3d8 | 2014-11-28 18:50:41 -0800 | [diff] [blame] | 21 | |
Pavlin Radoslavov | a6b754c | 2014-11-18 13:55:37 -0800 | [diff] [blame] | 22 | /** |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 23 | * Service for leader election. |
Madan Jampani | 1ee9178 | 2014-11-20 20:24:24 -0800 | [diff] [blame] | 24 | * Leadership contests are organized around topics. A instance can join the |
| 25 | * leadership race for a topic or withdraw from a race it has previously joined. |
| 26 | * Listeners can be added to receive notifications asynchronously for various |
| 27 | * leadership contests. |
Pavlin Radoslavov | a6b754c | 2014-11-18 13:55:37 -0800 | [diff] [blame] | 28 | */ |
| 29 | public interface LeadershipService { |
| 30 | |
| 31 | /** |
Madan Jampani | 5961051 | 2015-02-25 15:25:43 -0800 | [diff] [blame] | 32 | * Returns the current leader for the topic. |
Madan Jampani | 1ee9178 | 2014-11-20 20:24:24 -0800 | [diff] [blame] | 33 | * @param path topic |
Madan Jampani | 8d21c79 | 2014-12-01 16:31:07 -0800 | [diff] [blame] | 34 | * @return nodeId of the leader, null if so such topic exists. |
Madan Jampani | 1ee9178 | 2014-11-20 20:24:24 -0800 | [diff] [blame] | 35 | */ |
Madan Jampani | 8d21c79 | 2014-12-01 16:31:07 -0800 | [diff] [blame] | 36 | NodeId getLeader(String path); |
Madan Jampani | 1ee9178 | 2014-11-20 20:24:24 -0800 | [diff] [blame] | 37 | |
| 38 | /** |
Madan Jampani | 5961051 | 2015-02-25 15:25:43 -0800 | [diff] [blame] | 39 | * Returns the current leadership info for the topic. |
| 40 | * @param path topic |
| 41 | * @return leadership info or null if so such topic exists. |
| 42 | */ |
| 43 | Leadership getLeadership(String path); |
| 44 | |
| 45 | /** |
| 46 | * Returns the set of topics owned by the specified node. |
| 47 | * @param nodeId node Id. |
| 48 | * @return set of topics for which this node is the current leader. |
| 49 | */ |
| 50 | Set<String> ownedTopics(NodeId nodeId); |
| 51 | |
| 52 | /** |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 53 | * Joins the leadership contest. |
| 54 | * @param path topic for which this controller node wishes to be a leader. |
Pavlin Radoslavov | a6b754c | 2014-11-18 13:55:37 -0800 | [diff] [blame] | 55 | */ |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 56 | void runForLeadership(String path); |
Pavlin Radoslavov | a6b754c | 2014-11-18 13:55:37 -0800 | [diff] [blame] | 57 | |
| 58 | /** |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 59 | * Withdraws from a leadership contest. |
| 60 | * @param path topic for which this controller node no longer wishes to be a leader. |
| 61 | */ |
| 62 | void withdraw(String path); |
| 63 | |
Madan Jampani | 5961051 | 2015-02-25 15:25:43 -0800 | [diff] [blame] | 64 | /** |
| 65 | * Returns the current leader board. |
| 66 | * @return mapping from topic to leadership info. |
| 67 | */ |
Yuta HIGUCHI | c2bf3d8 | 2014-11-28 18:50:41 -0800 | [diff] [blame] | 68 | Map<String, Leadership> getLeaderBoard(); |
| 69 | |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 70 | /** |
Ayaka Koshibe | c19b8b8 | 2015-04-08 15:18:24 -0700 | [diff] [blame] | 71 | * Returns the candidates for all known topics. |
| 72 | * @return A map of topics to lists of NodeIds. |
| 73 | */ |
| 74 | Map<String, List<NodeId>> getCandidates(); |
| 75 | |
| 76 | /** |
| 77 | * Returns the candidates for a given topic. |
| 78 | * @param path topic |
| 79 | * @return A lists of NodeIds, which may be empty. |
| 80 | */ |
| 81 | List<NodeId> getCandidates(String path); |
| 82 | |
| 83 | /** |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 84 | * Registers a event listener to be notified of leadership events. |
| 85 | * @param listener listener that will asynchronously notified of leadership events. |
Pavlin Radoslavov | a6b754c | 2014-11-18 13:55:37 -0800 | [diff] [blame] | 86 | */ |
| 87 | void addListener(LeadershipEventListener listener); |
| 88 | |
| 89 | /** |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 90 | * Unregisters a event listener for leadership events. |
| 91 | * @param listener listener to be removed. |
Pavlin Radoslavov | a6b754c | 2014-11-18 13:55:37 -0800 | [diff] [blame] | 92 | */ |
| 93 | void removeListener(LeadershipEventListener listener); |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 94 | } |