alshabib | ab98466 | 2014-12-04 18:56:18 -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; |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 17 | |
| 18 | import java.util.Objects; |
Ayaka Koshibe | a48f752 | 2015-04-01 17:06:09 -0700 | [diff] [blame^] | 19 | import java.util.List; |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 20 | |
Madan Jampani | 30a57f8 | 2015-03-02 12:19:41 -0800 | [diff] [blame] | 21 | import org.joda.time.DateTime; |
| 22 | |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 23 | import com.google.common.base.MoreObjects; |
Ayaka Koshibe | a48f752 | 2015-04-01 17:06:09 -0700 | [diff] [blame^] | 24 | import com.google.common.collect.ImmutableList; |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 25 | |
| 26 | /** |
Ayaka Koshibe | a48f752 | 2015-04-01 17:06:09 -0700 | [diff] [blame^] | 27 | * Abstract leadership concept. The information carried by this construct |
| 28 | * include the topic of contention, the {@link NodeId}s of Nodes that could |
| 29 | * become leader for the topic, the epoch when the term for a given leader |
| 30 | * began, and the system time when the term began. Note: |
| 31 | * <ul> |
| 32 | * <li>The list of NodeIds may include the current leader at index 0, and the |
| 33 | * rest in decreasing preference order.</li> |
| 34 | * <li>The epoch is the logical age of a Leadership construct, and should be |
| 35 | * used for comparing two Leaderships, but only of the same topic.</li> |
| 36 | * </ul> |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 37 | */ |
| 38 | public class Leadership { |
| 39 | |
| 40 | private final String topic; |
Madan Jampani | 8d21c79 | 2014-12-01 16:31:07 -0800 | [diff] [blame] | 41 | private final NodeId leader; |
Ayaka Koshibe | a48f752 | 2015-04-01 17:06:09 -0700 | [diff] [blame^] | 42 | private final List<NodeId> candidates; |
Madan Jampani | 1ee9178 | 2014-11-20 20:24:24 -0800 | [diff] [blame] | 43 | private final long epoch; |
Madan Jampani | 30a57f8 | 2015-03-02 12:19:41 -0800 | [diff] [blame] | 44 | private final long electedTime; |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 45 | |
Madan Jampani | 30a57f8 | 2015-03-02 12:19:41 -0800 | [diff] [blame] | 46 | public Leadership(String topic, NodeId leader, long epoch, long electedTime) { |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 47 | this.topic = topic; |
| 48 | this.leader = leader; |
Ayaka Koshibe | a48f752 | 2015-04-01 17:06:09 -0700 | [diff] [blame^] | 49 | this.candidates = ImmutableList.of(leader); |
| 50 | this.epoch = epoch; |
| 51 | this.electedTime = electedTime; |
| 52 | } |
| 53 | |
| 54 | public Leadership(String topic, NodeId leader, List<NodeId> candidates, |
| 55 | long epoch, long electedTime) { |
| 56 | this.topic = topic; |
| 57 | this.leader = leader; |
| 58 | this.candidates = ImmutableList.copyOf(candidates); |
Madan Jampani | 1ee9178 | 2014-11-20 20:24:24 -0800 | [diff] [blame] | 59 | this.epoch = epoch; |
Madan Jampani | 30a57f8 | 2015-03-02 12:19:41 -0800 | [diff] [blame] | 60 | this.electedTime = electedTime; |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 61 | } |
| 62 | |
| 63 | /** |
| 64 | * The topic for which this leadership applies. |
| 65 | * @return leadership topic. |
| 66 | */ |
| 67 | public String topic() { |
| 68 | return topic; |
| 69 | } |
| 70 | |
| 71 | /** |
Madan Jampani | 8d21c79 | 2014-12-01 16:31:07 -0800 | [diff] [blame] | 72 | * The nodeId of leader for this topic. |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 73 | * @return leader node. |
| 74 | */ |
Madan Jampani | 8d21c79 | 2014-12-01 16:31:07 -0800 | [diff] [blame] | 75 | public NodeId leader() { |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 76 | return leader; |
| 77 | } |
| 78 | |
| 79 | /** |
Ayaka Koshibe | a48f752 | 2015-04-01 17:06:09 -0700 | [diff] [blame^] | 80 | * Returns an preference-ordered list of nodes that are in the leadership |
| 81 | * race for this topic. |
| 82 | * |
| 83 | * @return a list of NodeIds in priority-order, or an empty list. |
| 84 | */ |
| 85 | public List<NodeId> candidates() { |
| 86 | return candidates; |
| 87 | } |
| 88 | |
| 89 | /** |
Madan Jampani | 1ee9178 | 2014-11-20 20:24:24 -0800 | [diff] [blame] | 90 | * The epoch when the leadership was assumed. |
Madan Jampani | 30a57f8 | 2015-03-02 12:19:41 -0800 | [diff] [blame] | 91 | * <p> |
Ayaka Koshibe | a48f752 | 2015-04-01 17:06:09 -0700 | [diff] [blame^] | 92 | * Comparing epochs is only appropriate for leadership events for the same |
| 93 | * topic. The system guarantees that for any given topic the epoch for a new |
| 94 | * term is higher (not necessarily by 1) than the epoch for any previous |
| 95 | * term. |
| 96 | * |
Madan Jampani | 1ee9178 | 2014-11-20 20:24:24 -0800 | [diff] [blame] | 97 | * @return leadership epoch |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 98 | */ |
Madan Jampani | 1ee9178 | 2014-11-20 20:24:24 -0800 | [diff] [blame] | 99 | public long epoch() { |
| 100 | return epoch; |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 101 | } |
| 102 | |
Madan Jampani | 30a57f8 | 2015-03-02 12:19:41 -0800 | [diff] [blame] | 103 | /** |
| 104 | * The system time when the term started. |
| 105 | * <p> |
| 106 | * The elected time is initially set on the node coordinating |
| 107 | * the leader election using its local system time. Due to possible |
| 108 | * clock skew, relying on this value for determining event ordering |
| 109 | * is discouraged. Epoch is more appropriate for determining |
| 110 | * event ordering. |
| 111 | * @return elected time. |
| 112 | */ |
| 113 | public long electedTime() { |
| 114 | return electedTime; |
| 115 | } |
| 116 | |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 117 | @Override |
| 118 | public int hashCode() { |
Ayaka Koshibe | a48f752 | 2015-04-01 17:06:09 -0700 | [diff] [blame^] | 119 | return Objects.hash(topic, leader, candidates, epoch); |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 120 | } |
| 121 | |
| 122 | @Override |
Ray Milkey | 30edb16 | 2014-11-24 15:02:14 -0800 | [diff] [blame] | 123 | public boolean equals(Object obj) { |
| 124 | if (this == obj) { |
| 125 | return true; |
| 126 | } |
| 127 | if (obj instanceof Leadership) { |
| 128 | final Leadership other = (Leadership) obj; |
| 129 | return Objects.equals(this.topic, other.topic) && |
| 130 | Objects.equals(this.leader, other.leader) && |
Ayaka Koshibe | a48f752 | 2015-04-01 17:06:09 -0700 | [diff] [blame^] | 131 | Objects.equals(this.candidates, other.candidates) && |
Madan Jampani | 30a57f8 | 2015-03-02 12:19:41 -0800 | [diff] [blame] | 132 | Objects.equals(this.epoch, other.epoch) && |
| 133 | Objects.equals(this.electedTime, other.electedTime); |
Ray Milkey | 30edb16 | 2014-11-24 15:02:14 -0800 | [diff] [blame] | 134 | } |
| 135 | return false; |
| 136 | } |
| 137 | |
| 138 | @Override |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 139 | public String toString() { |
| 140 | return MoreObjects.toStringHelper(this.getClass()) |
| 141 | .add("topic", topic) |
| 142 | .add("leader", leader) |
Ayaka Koshibe | a48f752 | 2015-04-01 17:06:09 -0700 | [diff] [blame^] | 143 | .add("candidates", candidates) |
Madan Jampani | 1ee9178 | 2014-11-20 20:24:24 -0800 | [diff] [blame] | 144 | .add("epoch", epoch) |
Madan Jampani | 30a57f8 | 2015-03-02 12:19:41 -0800 | [diff] [blame] | 145 | .add("electedTime", new DateTime(electedTime)) |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame] | 146 | .toString(); |
| 147 | } |
Ray Milkey | 30edb16 | 2014-11-24 15:02:14 -0800 | [diff] [blame] | 148 | } |