* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.controller.cluster.raft.messages;
-public class AbstractRaftRPC implements RaftRPC {
+public abstract class AbstractRaftRPC implements RaftRPC {
private static final long serialVersionUID = -6061342433962854822L;
// term
- private long term;
+ private final long term;
- protected AbstractRaftRPC(long term) {
+ AbstractRaftRPC(final long term) {
this.term = term;
}
- // added for testing while serialize-messages=on
- public AbstractRaftRPC() {
- }
-
@Override
- public long getTerm() {
+ public final long getTerm() {
return term;
}
- protected void setTerm(long term) {
- this.term = term;
- }
+ // All implementations must use Externalizable Proxy pattern
+ abstract Object writeReplace();
}
import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
/**
- * Invoked by leader to replicate log entries (§5.3); also used as
- * heartbeat (§5.2).
+ * Invoked by leader to replicate log entries (§5.3); also used as heartbeat (§5.2).
*/
-public class AppendEntries extends AbstractRaftRPC {
+public final class AppendEntries extends AbstractRaftRPC {
private static final long serialVersionUID = 1L;
// So that follower can redirect clients
- private final String leaderId;
+ private final @NonNull String leaderId;
// Index of log entry immediately preceding new ones
private final long prevLogIndex;
private final long prevLogTerm;
// log entries to store (empty for heart beat - may send more than one for efficiency)
- private final List<ReplicatedLogEntry> entries;
+ private final @NonNull List<ReplicatedLogEntry> entries;
// leader's commitIndex
private final long leaderCommit;
private final String leaderAddress;
- private AppendEntries(long term, @NonNull String leaderId, long prevLogIndex, long prevLogTerm,
- @NonNull List<ReplicatedLogEntry> entries, long leaderCommit, long replicatedToAllIndex,
- short payloadVersion, short recipientRaftVersion, short leaderRaftVersion, @Nullable String leaderAddress) {
+ private AppendEntries(final long term, @NonNull final String leaderId, final long prevLogIndex,
+ final long prevLogTerm, @NonNull final List<ReplicatedLogEntry> entries, final long leaderCommit,
+ final long replicatedToAllIndex, final short payloadVersion, final short recipientRaftVersion,
+ final short leaderRaftVersion, @Nullable final String leaderAddress) {
super(term);
this.leaderId = requireNonNull(leaderId);
this.prevLogIndex = prevLogIndex;
this.leaderAddress = leaderAddress;
}
- public AppendEntries(long term, @NonNull String leaderId, long prevLogIndex, long prevLogTerm,
- @NonNull List<ReplicatedLogEntry> entries, long leaderCommit, long replicatedToAllIndex,
- short payloadVersion, short recipientRaftVersion, @Nullable String leaderAddress) {
+ public AppendEntries(final long term, final @NonNull String leaderId, final long prevLogIndex,
+ final long prevLogTerm, final @NonNull List<ReplicatedLogEntry> entries, final long leaderCommit,
+ final long replicatedToAllIndex, final short payloadVersion, final short recipientRaftVersion,
+ final @Nullable String leaderAddress) {
this(term, leaderId, prevLogIndex, prevLogTerm, entries, leaderCommit, replicatedToAllIndex, payloadVersion,
recipientRaftVersion, RaftVersions.CURRENT_VERSION, leaderAddress);
}
@VisibleForTesting
- public AppendEntries(long term, @NonNull String leaderId, long prevLogIndex, long prevLogTerm,
- @NonNull List<ReplicatedLogEntry> entries, long leaderCommit, long replicatedToAllIndex,
- short payloadVersion) {
+ public AppendEntries(final long term, final @NonNull String leaderId, final long prevLogIndex,
+ final long prevLogTerm, final @NonNull List<ReplicatedLogEntry> entries, final long leaderCommit,
+ final long replicatedToAllIndex, final short payloadVersion) {
this(term, leaderId, prevLogIndex, prevLogTerm, entries, leaderCommit, replicatedToAllIndex, payloadVersion,
RaftVersions.CURRENT_VERSION, null);
}
+ ", entries=" + entries + "]";
}
- private Object writeReplace() {
+ @Override
+ Object writeReplace() {
return recipientRaftVersion >= RaftVersions.FLUORINE_VERSION ? new ProxyV2(this) : new Proxy(this);
}
public ProxyV2() {
}
- ProxyV2(AppendEntries appendEntries) {
+ ProxyV2(final AppendEntries appendEntries) {
this.appendEntries = appendEntries;
}
@Override
- public void writeExternal(ObjectOutput out) throws IOException {
+ public void writeExternal(final ObjectOutput out) throws IOException {
out.writeShort(appendEntries.leaderRaftVersion);
out.writeLong(appendEntries.getTerm());
out.writeObject(appendEntries.leaderId);
}
@Override
- public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
+ public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
short leaderRaftVersion = in.readShort();
long term = in.readLong();
String leaderId = (String) in.readObject();
public Proxy() {
}
- Proxy(AppendEntries appendEntries) {
+ Proxy(final AppendEntries appendEntries) {
this.appendEntries = appendEntries;
}
@Override
- public void writeExternal(ObjectOutput out) throws IOException {
+ public void writeExternal(final ObjectOutput out) throws IOException {
out.writeLong(appendEntries.getTerm());
out.writeObject(appendEntries.leaderId);
out.writeLong(appendEntries.prevLogTerm);
}
@Override
- public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
+ public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
long term = in.readLong();
String leaderId = (String) in.readObject();
long prevLogTerm = in.readLong();
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.controller.cluster.raft.messages;
import com.google.common.annotations.VisibleForTesting;
/**
* Reply for the AppendEntries message.
*/
-public class AppendEntriesReply extends AbstractRaftRPC {
+public final class AppendEntriesReply extends AbstractRaftRPC {
private static final long serialVersionUID = -7487547356392536683L;
// true if follower contained entry matching
private final short recipientRaftVersion;
@VisibleForTesting
- public AppendEntriesReply(String followerId, long term, boolean success, long logLastIndex, long logLastTerm,
- short payloadVersion) {
+ public AppendEntriesReply(final String followerId, final long term, final boolean success, final long logLastIndex,
+ final long logLastTerm, final short payloadVersion) {
this(followerId, term, success, logLastIndex, logLastTerm, payloadVersion, false, false,
RaftVersions.CURRENT_VERSION);
}
- public AppendEntriesReply(String followerId, long term, boolean success, long logLastIndex, long logLastTerm,
- short payloadVersion, boolean forceInstallSnapshot, boolean needsLeaderAddress,
- short recipientRaftVersion) {
+ public AppendEntriesReply(final String followerId, final long term, final boolean success, final long logLastIndex,
+ final long logLastTerm, final short payloadVersion, final boolean forceInstallSnapshot,
+ final boolean needsLeaderAddress, final short recipientRaftVersion) {
this(followerId, term, success, logLastIndex, logLastTerm, payloadVersion, forceInstallSnapshot,
needsLeaderAddress, RaftVersions.CURRENT_VERSION, recipientRaftVersion);
-
}
- private AppendEntriesReply(String followerId, long term, boolean success, long logLastIndex, long logLastTerm,
- short payloadVersion, boolean forceInstallSnapshot, boolean needsLeaderAddress, short raftVersion,
- short recipientRaftVersion) {
+ private AppendEntriesReply(final String followerId, final long term, final boolean success, final long logLastIndex,
+ final long logLastTerm, final short payloadVersion, final boolean forceInstallSnapshot,
+ final boolean needsLeaderAddress, final short raftVersion, final short recipientRaftVersion) {
super(term);
this.followerId = followerId;
this.success = success;
+ ", recipientRaftVersion=" + recipientRaftVersion + "]";
}
- private Object writeReplace() {
+ @Override
+ Object writeReplace() {
return recipientRaftVersion >= RaftVersions.FLUORINE_VERSION ? new Proxy2(this) : new Proxy(this);
}
public Proxy2() {
}
- Proxy2(AppendEntriesReply appendEntriesReply) {
+ Proxy2(final AppendEntriesReply appendEntriesReply) {
this.appendEntriesReply = appendEntriesReply;
}
@Override
- public void writeExternal(ObjectOutput out) throws IOException {
+ public void writeExternal(final ObjectOutput out) throws IOException {
out.writeShort(appendEntriesReply.raftVersion);
out.writeLong(appendEntriesReply.getTerm());
out.writeObject(appendEntriesReply.followerId);
}
@Override
- public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
+ public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
short raftVersion = in.readShort();
long term = in.readLong();
String followerId = (String) in.readObject();
public Proxy() {
}
- Proxy(AppendEntriesReply appendEntriesReply) {
+ Proxy(final AppendEntriesReply appendEntriesReply) {
this.appendEntriesReply = appendEntriesReply;
}
@Override
- public void writeExternal(ObjectOutput out) throws IOException {
+ public void writeExternal(final ObjectOutput out) throws IOException {
out.writeShort(appendEntriesReply.raftVersion);
out.writeLong(appendEntriesReply.getTerm());
out.writeObject(appendEntriesReply.followerId);
}
@Override
- public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
+ public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
short raftVersion = in.readShort();
long term = in.readLong();
String followerId = (String) in.readObject();
/**
* Message sent from a leader to install a snapshot chunk on a follower.
*/
-public class InstallSnapshot extends AbstractRaftRPC {
+public final class InstallSnapshot extends AbstractRaftRPC {
private static final long serialVersionUID = 1L;
private final String leaderId;
return serverConfig;
}
-
public <T> Object toSerializable(final short version) {
return this;
}
+ ", serverConfig=" + serverConfig.orElse(null) + "]";
}
- private Object writeReplace() {
+ @Override
+ Object writeReplace() {
return new Proxy(this);
}
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.controller.cluster.raft.messages;
import java.io.Externalizable;
import java.io.ObjectInput;
import java.io.ObjectOutput;
-public class InstallSnapshotReply extends AbstractRaftRPC {
+public final class InstallSnapshotReply extends AbstractRaftRPC {
private static final long serialVersionUID = 642227896390779503L;
// The followerId - this will be used to figure out which follower is
private final int chunkIndex;
private final boolean success;
- public InstallSnapshotReply(long term, String followerId, int chunkIndex, boolean success) {
+ public InstallSnapshotReply(final long term, final String followerId, final int chunkIndex, final boolean success) {
super(term);
this.followerId = followerId;
this.chunkIndex = chunkIndex;
+ ", success=" + success + "]";
}
- private Object writeReplace() {
+ @Override
+ Object writeReplace() {
return new Proxy(this);
}
public Proxy() {
}
- Proxy(InstallSnapshotReply installSnapshotReply) {
+ Proxy(final InstallSnapshotReply installSnapshotReply) {
this.installSnapshotReply = installSnapshotReply;
}
@Override
- public void writeExternal(ObjectOutput out) throws IOException {
+ public void writeExternal(final ObjectOutput out) throws IOException {
out.writeLong(installSnapshotReply.getTerm());
out.writeObject(installSnapshotReply.followerId);
out.writeInt(installSnapshotReply.chunkIndex);
}
@Override
- public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
+ public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
long term = in.readLong();
String followerId = (String) in.readObject();
int chunkIndex = in.readInt();
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.controller.cluster.raft.messages;
import java.io.Externalizable;
/**
* Invoked by candidates to gather votes (§5.2).
*/
-public class RequestVote extends AbstractRaftRPC {
+public final class RequestVote extends AbstractRaftRPC {
private static final long serialVersionUID = -6967509186297108657L;
// candidate requesting vote
// term of candidate’s last log entry (§5.4)
private final long lastLogTerm;
- public RequestVote(long term, String candidateId, long lastLogIndex, long lastLogTerm) {
+ public RequestVote(final long term, final String candidateId, final long lastLogIndex, final long lastLogTerm) {
super(term);
this.candidateId = candidateId;
this.lastLogIndex = lastLogIndex;
+ "]";
}
- private Object writeReplace() {
+ @Override
+ Object writeReplace() {
return new Proxy(this);
}
public Proxy() {
}
- Proxy(RequestVote requestVote) {
+ Proxy(final RequestVote requestVote) {
this.requestVote = requestVote;
}
@Override
- public void writeExternal(ObjectOutput out) throws IOException {
+ public void writeExternal(final ObjectOutput out) throws IOException {
out.writeLong(requestVote.getTerm());
out.writeObject(requestVote.candidateId);
out.writeLong(requestVote.lastLogIndex);
}
@Override
- public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
+ public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
long term = in.readLong();
String candidateId = (String) in.readObject();
long lastLogIndex = in.readLong();
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.controller.cluster.raft.messages;
import java.io.Externalizable;
// true means candidate received vote
private final boolean voteGranted;
- public RequestVoteReply(long term, boolean voteGranted) {
+ public RequestVoteReply(final long term, final boolean voteGranted) {
super(term);
this.voteGranted = voteGranted;
}
return "RequestVoteReply [term=" + getTerm() + ", voteGranted=" + voteGranted + "]";
}
- private Object writeReplace() {
+ @Override
+ Object writeReplace() {
return new Proxy(this);
}
public Proxy() {
}
- Proxy(RequestVoteReply requestVoteReply) {
+ Proxy(final RequestVoteReply requestVoteReply) {
this.requestVoteReply = requestVoteReply;
}
@Override
- public void writeExternal(ObjectOutput out) throws IOException {
+ public void writeExternal(final ObjectOutput out) throws IOException {
out.writeLong(requestVoteReply.getTerm());
out.writeBoolean(requestVoteReply.voteGranted);
}
@Override
- public void readExternal(ObjectInput in) throws IOException {
+ public void readExternal(final ObjectInput in) throws IOException {
long term = in.readLong();
boolean voteGranted = in.readBoolean();