X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2Fmessages%2FAppendEntries.java;h=017794679c1e2deb4a5ece3c25f641cca32799ef;hp=d2ea0c50cd6203fd6b142793612e4e0546000185;hb=79e6240ad565717e2fba62a339f11fcbd239f440;hpb=4f295e3104c4b0c3fccc4f7ac8010dbddf613ef7 diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntries.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntries.java index d2ea0c50cd..017794679c 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntries.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntries.java @@ -8,19 +8,15 @@ package org.opendaylight.controller.cluster.raft.messages; -import com.google.protobuf.GeneratedMessage; +import java.io.Externalizable; import java.io.IOException; -import java.io.ObjectInputStream; -import java.io.ObjectOutputStream; +import java.io.ObjectInput; +import java.io.ObjectOutput; import java.util.ArrayList; -import java.util.Iterator; import java.util.List; -import java.util.Map; -import org.opendaylight.controller.cluster.raft.RaftVersions; import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry; -import org.opendaylight.controller.cluster.raft.ReplicatedLogImplEntry; +import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry; import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload; -import org.opendaylight.controller.protobuff.messages.cluster.raft.AppendEntriesMessages; /** * Invoked by leader to replicate log entries (§5.3); also used as @@ -29,11 +25,6 @@ import org.opendaylight.controller.protobuff.messages.cluster.raft.AppendEntries public class AppendEntries extends AbstractRaftRPC { private static final long serialVersionUID = 1L; - public static final Class LEGACY_SERIALIZABLE_CLASS = - AppendEntriesMessages.AppendEntries.class; - - private static final org.slf4j.Logger LOG = org.slf4j.LoggerFactory.getLogger(AppendEntries.class); - // So that follower can redirect clients private final String leaderId; @@ -43,9 +34,8 @@ public class AppendEntries extends AbstractRaftRPC { // term of prevLogIndex entry private final long prevLogTerm; - // log entries to store (empty for heartbeat; - // may send more than one for efficiency) - private transient List entries; + // log entries to store (empty for heart beat - may send more than one for efficiency) + private final List entries; // leader's commitIndex private final long leaderCommit; @@ -53,8 +43,10 @@ public class AppendEntries extends AbstractRaftRPC { // index which has been replicated successfully to all followers, -1 if none private final long replicatedToAllIndex; - public AppendEntries(long term, String leaderId, long prevLogIndex, - long prevLogTerm, List entries, long leaderCommit, long replicatedToAllIndex) { + private final short payloadVersion; + + public AppendEntries(long term, String leaderId, long prevLogIndex, long prevLogTerm, + List entries, long leaderCommit, long replicatedToAllIndex, short payloadVersion) { super(term); this.leaderId = leaderId; this.prevLogIndex = prevLogIndex; @@ -62,28 +54,7 @@ public class AppendEntries extends AbstractRaftRPC { this.entries = entries; this.leaderCommit = leaderCommit; this.replicatedToAllIndex = replicatedToAllIndex; - } - - private void writeObject(ObjectOutputStream out) throws IOException { - out.writeShort(RaftVersions.CURRENT_VERSION); - out.defaultWriteObject(); - - out.writeInt(entries.size()); - for(ReplicatedLogEntry e: entries) { - out.writeObject(e); - } - } - - private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { - in.readShort(); // version - - in.defaultReadObject(); - - int size = in.readInt(); - entries = new ArrayList<>(size); - for(int i = 0; i < size; i++) { - entries.add((ReplicatedLogEntry) in.readObject()); - } + this.payloadVersion = payloadVersion; } public String getLeaderId() { @@ -110,110 +81,79 @@ public class AppendEntries extends AbstractRaftRPC { return replicatedToAllIndex; } + public short getPayloadVersion() { + return payloadVersion; + } @Override public String toString() { StringBuilder builder = new StringBuilder(); - builder.append("AppendEntries [term=").append(term).append(", leaderId=").append(leaderId) - .append(", prevLogIndex=").append(prevLogIndex).append(", prevLogTerm=").append(prevLogTerm) - .append(", entries=").append(entries).append(", leaderCommit=").append(leaderCommit) - .append(", replicatedToAllIndex=").append(replicatedToAllIndex).append("]"); + builder.append("AppendEntries [leaderId=").append(leaderId).append(", prevLogIndex=").append(prevLogIndex) + .append(", prevLogTerm=").append(prevLogTerm).append(", leaderCommit=").append(leaderCommit) + .append(", replicatedToAllIndex=").append(replicatedToAllIndex).append(", payloadVersion=") + .append(payloadVersion).append(", entries=").append(entries).append("]"); return builder.toString(); } - public Object toSerializable() { - return toSerializable(RaftVersions.CURRENT_VERSION); - } - - public Object toSerializable(short version) { - if(version < RaftVersions.LITHIUM_VERSION) { - return toLegacySerializable(); - } else { - return this; - } + private Object writeReplace() { + return new Proxy(this); } - @SuppressWarnings({ "rawtypes", "unchecked" }) - private Object toLegacySerializable() { - AppendEntriesMessages.AppendEntries.Builder to = AppendEntriesMessages.AppendEntries.newBuilder(); - to.setTerm(this.getTerm()) - .setLeaderId(this.getLeaderId()) - .setPrevLogTerm(this.getPrevLogTerm()) - .setPrevLogIndex(this.getPrevLogIndex()) - .setLeaderCommit(this.getLeaderCommit()); - - for (ReplicatedLogEntry logEntry : this.getEntries()) { - - AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Builder arBuilder = - AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.newBuilder(); - - AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload.Builder arpBuilder = - AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload.newBuilder(); + private static class Proxy implements Externalizable { + private static final long serialVersionUID = 1L; - //get the client specific payload extensions and add them to the payload builder - Map map = logEntry.getData().encode(); - Iterator> iter = map.entrySet().iterator(); + private AppendEntries appendEntries; - while (iter.hasNext()) { - Map.Entry entry = iter.next(); - arpBuilder.setExtension(entry.getKey(), entry.getValue()); - } - - arpBuilder.setClientPayloadClassName(logEntry.getData().getClientPayloadClassName()); - - arBuilder.setData(arpBuilder).setIndex(logEntry.getIndex()).setTerm(logEntry.getTerm()); - to.addLogEntries(arBuilder); + // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't + // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection. + @SuppressWarnings("checkstyle:RedundantModifier") + public Proxy() { } - return to.build(); - } - - public static AppendEntries fromSerializable(Object serialized) { - if(serialized instanceof AppendEntries) { - return (AppendEntries)serialized; - } - else { - return fromLegacySerializable((AppendEntriesMessages.AppendEntries) serialized); + Proxy(AppendEntries appendEntries) { + this.appendEntries = appendEntries; } - } - private static AppendEntries fromLegacySerializable(AppendEntriesMessages.AppendEntries from) { - List logEntryList = new ArrayList<>(); - for (AppendEntriesMessages.AppendEntries.ReplicatedLogEntry leProtoBuff : from.getLogEntriesList()) { - - Payload payload = null ; - try { - if(leProtoBuff.getData() != null && leProtoBuff.getData().getClientPayloadClassName() != null) { - String clientPayloadClassName = leProtoBuff.getData().getClientPayloadClassName(); - payload = (Payload) Class.forName(clientPayloadClassName).newInstance(); - payload = payload.decode(leProtoBuff.getData()); - } else { - LOG.error("Payload is null or payload does not have client payload class name"); - } - - } catch (InstantiationException e) { - LOG.error("InstantiationException when instantiating "+leProtoBuff.getData().getClientPayloadClassName(), e); - } catch (IllegalAccessException e) { - LOG.error("IllegalAccessException when accessing "+leProtoBuff.getData().getClientPayloadClassName(), e); - } catch (ClassNotFoundException e) { - LOG.error("ClassNotFoundException when loading "+leProtoBuff.getData().getClientPayloadClassName(), e); + @Override + public void writeExternal(ObjectOutput out) throws IOException { + out.writeLong(appendEntries.getTerm()); + out.writeObject(appendEntries.leaderId); + out.writeLong(appendEntries.prevLogTerm); + out.writeLong(appendEntries.prevLogIndex); + out.writeLong(appendEntries.leaderCommit); + out.writeLong(appendEntries.replicatedToAllIndex); + out.writeShort(appendEntries.payloadVersion); + + out.writeInt(appendEntries.entries.size()); + for (ReplicatedLogEntry e: appendEntries.entries) { + out.writeLong(e.getIndex()); + out.writeLong(e.getTerm()); + out.writeObject(e.getData()); } - ReplicatedLogEntry logEntry = new ReplicatedLogImplEntry( - leProtoBuff.getIndex(), leProtoBuff.getTerm(), payload); - logEntryList.add(logEntry); } - AppendEntries to = new AppendEntries(from.getTerm(), - from.getLeaderId(), - from.getPrevLogIndex(), - from.getPrevLogTerm(), - logEntryList, - from.getLeaderCommit(), -1); + @Override + public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException { + long term = in.readLong(); + String leaderId = (String) in.readObject(); + long prevLogTerm = in.readLong(); + long prevLogIndex = in.readLong(); + long leaderCommit = in.readLong(); + long replicatedToAllIndex = in.readLong(); + short payloadVersion = in.readShort(); + + int size = in.readInt(); + List entries = new ArrayList<>(size); + for (int i = 0; i < size; i++) { + entries.add(new SimpleReplicatedLogEntry(in.readLong(), in.readLong(), (Payload) in.readObject())); + } - return to; - } + appendEntries = new AppendEntries(term, leaderId, prevLogIndex, prevLogTerm, entries, leaderCommit, + replicatedToAllIndex, payloadVersion); + } - public static boolean isSerializedType(Object message) { - return message instanceof AppendEntries || LEGACY_SERIALIZABLE_CLASS.isInstance(message); + private Object readResolve() { + return appendEntries; + } } }