forked from twitter-archive/commons
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CandidateImpl.java
178 lines (155 loc) · 6.91 KB
/
CandidateImpl.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
// =================================================================================================
// Copyright 2011 Twitter, Inc.
// -------------------------------------------------------------------------------------------------
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this work except in compliance with the License.
// You may obtain a copy of the License in the LICENSE file, or at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// =================================================================================================
package com.twitter.common.zookeeper;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.google.common.base.Function;
import com.google.common.base.Preconditions;
import com.google.common.base.Supplier;
import com.google.common.base.Suppliers;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.common.collect.Ordering;
import org.apache.zookeeper.KeeperException;
import com.twitter.common.base.Command;
import com.twitter.common.base.ExceptionalCommand;
import com.twitter.common.zookeeper.Group.GroupChangeListener;
import com.twitter.common.zookeeper.Group.JoinException;
import com.twitter.common.zookeeper.Group.Membership;
import com.twitter.common.zookeeper.Group.WatchException;
import com.twitter.common.zookeeper.ZooKeeperClient.ZooKeeperConnectionException;
/**
* Implements leader election for small groups of candidates. This implementation is subject to the
* <a href="http://hadoop.apache.org/zookeeper/docs/r3.2.1/recipes.html#sc_leaderElection">
* herd effect</a> for a given group and should only be used for small (~10 member) candidate pools.
*
* @author John Sirois
*/
public class CandidateImpl implements Candidate {
private static final Logger LOG = Logger.getLogger(CandidateImpl.class.getName());
private static final String UNKOWN_CANDIDATE_DATA = "<unknown>";
private static final Function<Iterable<String>, String> MOST_RECENT_JUDGE =
new Function<Iterable<String>, String>() {
@Override public String apply(Iterable<String> candidates) {
return Ordering.natural().min(candidates);
}
};
private final Group group;
private final Function<Iterable<String>, String> judge;
private final Supplier<byte[]> dataSupplier;
/**
* Equivalent to {@link #CandidateImpl(Group, com.google.common.base.Function, Supplier)} using a judge that
* always picks the lowest numbered candidate ephemeral node - by proxy the oldest or 1st
* candidate and a default supplier that populates the data in the underlying znode with the ip address of this host.
*/
public CandidateImpl(Group group) {
this(group, MOST_RECENT_JUDGE, new Supplier<byte[]>() {
@Override
public byte[] get() {
try {
return InetAddress.getLocalHost().getHostAddress().getBytes();
} catch (UnknownHostException e) {
LOG.log(Level.WARNING, "Failed to determine local address!", e);
return UNKOWN_CANDIDATE_DATA.getBytes();
}
}
});
}
/**
* Creates a candidate that can be used to offer leadership for the given {@code group}. The
* {@code judge} is used to pick the current leader from all group members whenever the group
* membership changes. To form a well-behaved election group with one leader, all candidates
* should use the same judge.
*/
public CandidateImpl(Group group, Function<Iterable<String>, String> judge, Supplier<byte[]> dataSupplier) {
this.group = Preconditions.checkNotNull(group);
this.judge = Preconditions.checkNotNull(judge);
this.dataSupplier = Preconditions.checkNotNull(dataSupplier);
}
@Override
public String getLeaderData()
throws ZooKeeperConnectionException, KeeperException, InterruptedException {
String leaderId = getLeader(group.getMemberIds());
if (leaderId == null) {
return null;
}
byte[] data = group.getMemberData(leaderId);
return data == null ? UNKOWN_CANDIDATE_DATA : new String(data);
}
@Override
public Supplier<Boolean> offerLeadership(final Leader leader)
throws JoinException, WatchException, InterruptedException {
final Membership membership = group.join(dataSupplier, new Command() {
@Override public void execute() {
leader.onDefeated();
}
});
final AtomicBoolean elected = new AtomicBoolean(false);
final AtomicBoolean abdicated = new AtomicBoolean(false);
group.watch(new GroupChangeListener() {
@Override public void onGroupChange(Iterable<String> memberIds) {
boolean noCandidates = Iterables.isEmpty(memberIds);
String memberId = membership.getMemberId();
if (noCandidates) {
LOG.warning("All candidates have temporarily left the group: " + group);
} else if (!Iterables.contains(memberIds, memberId)) {
LOG.severe(String.format(
"Current member ID %s is not a candidate for leader, current voting: %s",
memberId, memberIds));
} else {
boolean electedLeader = memberId.equals(getLeader(memberIds));
boolean previouslyElected = elected.getAndSet(electedLeader);
if (!previouslyElected && electedLeader) {
LOG.info(String.format("Candidate %s is now leader of group: %s",
membership.getMemberPath(), memberIds));
leader.onElected(new ExceptionalCommand<JoinException>() {
@Override public void execute() throws JoinException {
membership.cancel();
abdicated.set(true);
}
});
} else if (!electedLeader) {
if (previouslyElected) {
leader.onDefeated();
}
LOG.info(String.format(
"Candidate %s waiting for the next leader election, current voting: %s",
membership.getMemberPath(), memberIds));
}
}
}
});
return new Supplier<Boolean>() {
@Override public Boolean get() {
return !abdicated.get() && elected.get();
}
};
}
private String getAddress() {
try {
return InetAddress.getLocalHost().getHostAddress();
} catch (UnknownHostException e) {
LOG.log(Level.WARNING, "Failed to determine local address!", e);
return UNKOWN_CANDIDATE_DATA;
}
}
private String getLeader(Iterable<String> memberIds) {
return judge.apply(memberIds);
}
}