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%2FInstallSnapshot.java;h=b64e902f3ff9f93e782c4114e6e690bbef971b0a;hp=d2a6a0d0824b53895e860491c7958aa50132c65d;hb=97542f208267cb5392fc8c8d9baf6c1d3ee4ae32;hpb=9d5ec5cdd146a56bc03e35b6718e9492a5c8410a diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshot.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshot.java index d2a6a0d082..b64e902f3f 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshot.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshot.java @@ -9,36 +9,34 @@ package org.opendaylight.controller.cluster.raft.messages; import com.google.common.base.Optional; -import com.google.protobuf.ByteString; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.io.Externalizable; import java.io.IOException; import java.io.ObjectInput; import java.io.ObjectOutput; -import org.opendaylight.controller.cluster.raft.RaftVersions; import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload; -import org.opendaylight.controller.protobuff.messages.cluster.raft.InstallSnapshotMessages; -public class InstallSnapshot extends AbstractRaftRPC implements Externalizable { +/** + * Message sent from a leader to install a snapshot chunk on a follower. + */ +public class InstallSnapshot extends AbstractRaftRPC { private static final long serialVersionUID = 1L; - public static final Class SERIALIZABLE_CLASS = InstallSnapshotMessages.InstallSnapshot.class; - - private String leaderId; - private long lastIncludedIndex; - private long lastIncludedTerm; - private byte[] data; - private int chunkIndex; - private int totalChunks; - private Optional lastChunkHashCode; - private Optional serverConfig; - - /** - * Empty constructor to satisfy Externalizable. - */ - public InstallSnapshot() { - } + private final String leaderId; + private final long lastIncludedIndex; + private final long lastIncludedTerm; + private final byte[] data; + private final int chunkIndex; + private final int totalChunks; + private final Optional lastChunkHashCode; + private final Optional serverConfig; + + @SuppressFBWarnings(value = "EI_EXPOSE_REP2", justification = "Stores a reference to an externally mutable byte[] " + + "object but this is OK since this class is merely a DTO and does not process byte[] internally. " + + "Also it would be inefficient to create a copy as the byte[] could be large.") public InstallSnapshot(long term, String leaderId, long lastIncludedIndex, long lastIncludedTerm, byte[] data, - int chunkIndex, int totalChunks, Optional lastChunkHashCode, Optional serverConfig) { + int chunkIndex, int totalChunks, Optional lastChunkHashCode, + Optional serverConfig) { super(term); this.leaderId = leaderId; this.lastIncludedIndex = lastIncludedIndex; @@ -68,6 +66,9 @@ public class InstallSnapshot extends AbstractRaftRPC implements Externalizable { return lastIncludedTerm; } + @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Exposes a mutable object stored in a field but " + + "this is OK since this class is merely a DTO and does not process the byte[] internally. " + + "Also it would be inefficient to create a return copy as the byte[] could be large.") public byte[] getData() { return data; } @@ -88,105 +89,89 @@ public class InstallSnapshot extends AbstractRaftRPC implements Externalizable { return serverConfig; } - @Override - public void writeExternal(ObjectOutput out) throws IOException { - out.writeShort(RaftVersions.CURRENT_VERSION); - out.writeLong(getTerm()); - out.writeUTF(leaderId); - out.writeLong(lastIncludedIndex); - out.writeLong(lastIncludedTerm); - out.writeInt(chunkIndex); - out.writeInt(totalChunks); - - out.writeByte(lastChunkHashCode.isPresent() ? 1 : 0); - if(lastChunkHashCode.isPresent()) { - out.writeInt(lastChunkHashCode.get().intValue()); - } - out.writeByte(serverConfig.isPresent() ? 1 : 0); - if(serverConfig.isPresent()) { - out.writeObject(serverConfig.get()); - } - - out.writeObject(data); + public Object toSerializable(short version) { + return this; } @Override - public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException { - in.readShort(); // raft version - not currently used - setTerm(in.readLong()); - leaderId = in.readUTF(); - lastIncludedIndex = in.readLong(); - lastIncludedTerm = in.readLong(); - chunkIndex = in.readInt(); - totalChunks = in.readInt(); - - lastChunkHashCode = Optional.absent(); - boolean chunkHashCodePresent = in.readByte() == 1; - if(chunkHashCodePresent) { - lastChunkHashCode = Optional.of(in.readInt()); + public String toString() { + return "InstallSnapshot [term=" + getTerm() + ", leaderId=" + leaderId + ", lastIncludedIndex=" + + lastIncludedIndex + ", lastIncludedTerm=" + lastIncludedTerm + ", datasize=" + data.length + + ", Chunk=" + chunkIndex + "/" + totalChunks + ", lastChunkHashCode=" + lastChunkHashCode + + ", serverConfig=" + serverConfig.orNull() + "]"; + } + + private Object writeReplace() { + return new Proxy(this); + } + + private static class Proxy implements Externalizable { + private static final long serialVersionUID = 1L; + + private InstallSnapshot installSnapshot; + + // 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() { } - serverConfig = Optional.absent(); - boolean serverConfigPresent = in.readByte() == 1; - if(serverConfigPresent) { - serverConfig = Optional.of((ServerConfigurationPayload)in.readObject()); + Proxy(InstallSnapshot installSnapshot) { + this.installSnapshot = installSnapshot; } - data = (byte[])in.readObject(); - } + @Override + public void writeExternal(ObjectOutput out) throws IOException { + out.writeLong(installSnapshot.getTerm()); + out.writeObject(installSnapshot.leaderId); + out.writeLong(installSnapshot.lastIncludedIndex); + out.writeLong(installSnapshot.lastIncludedTerm); + out.writeInt(installSnapshot.chunkIndex); + out.writeInt(installSnapshot.totalChunks); + + out.writeByte(installSnapshot.lastChunkHashCode.isPresent() ? 1 : 0); + if (installSnapshot.lastChunkHashCode.isPresent()) { + out.writeInt(installSnapshot.lastChunkHashCode.get().intValue()); + } - public Object toSerializable(short version) { - if(version >= RaftVersions.BORON_VERSION) { - return this; - } else { - InstallSnapshotMessages.InstallSnapshot.Builder builder = InstallSnapshotMessages.InstallSnapshot.newBuilder() - .setTerm(this.getTerm()) - .setLeaderId(this.getLeaderId()) - .setChunkIndex(this.getChunkIndex()) - .setData(ByteString.copyFrom(getData())) - .setLastIncludedIndex(this.getLastIncludedIndex()) - .setLastIncludedTerm(this.getLastIncludedTerm()) - .setTotalChunks(this.getTotalChunks()); - - if(lastChunkHashCode.isPresent()){ - builder.setLastChunkHashCode(lastChunkHashCode.get()); + out.writeByte(installSnapshot.serverConfig.isPresent() ? 1 : 0); + if (installSnapshot.serverConfig.isPresent()) { + out.writeObject(installSnapshot.serverConfig.get()); } - return builder.build(); - } - } - @Override - public String toString() { - return "InstallSnapshot [term=" + getTerm() + ", leaderId=" + leaderId + ", lastIncludedIndex=" - + lastIncludedIndex + ", lastIncludedTerm=" + lastIncludedTerm + ", datasize=" + data.length - + ", Chunk=" + chunkIndex + "/" + totalChunks + ", lastChunkHashCode=" + lastChunkHashCode - + ", serverConfig=" + serverConfig.orNull() + "]"; - } + out.writeObject(installSnapshot.data); + } - public static InstallSnapshot fromSerializable (Object o) { - if(o instanceof InstallSnapshot) { - return (InstallSnapshot)o; - } else { - InstallSnapshotMessages.InstallSnapshot from = - (InstallSnapshotMessages.InstallSnapshot) o; + @Override + public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException { + long term = in.readLong(); + String leaderId = (String) in.readObject(); + long lastIncludedIndex = in.readLong(); + long lastIncludedTerm = in.readLong(); + int chunkIndex = in.readInt(); + int totalChunks = in.readInt(); Optional lastChunkHashCode = Optional.absent(); - if(from.hasLastChunkHashCode()){ - lastChunkHashCode = Optional.of(from.getLastChunkHashCode()); + boolean chunkHashCodePresent = in.readByte() == 1; + if (chunkHashCodePresent) { + lastChunkHashCode = Optional.of(in.readInt()); } - InstallSnapshot installSnapshot = new InstallSnapshot(from.getTerm(), - from.getLeaderId(), from.getLastIncludedIndex(), - from.getLastIncludedTerm(), from.getData().toByteArray(), - from.getChunkIndex(), from.getTotalChunks(), lastChunkHashCode, - Optional.absent()); + Optional serverConfig = Optional.absent(); + boolean serverConfigPresent = in.readByte() == 1; + if (serverConfigPresent) { + serverConfig = Optional.of((ServerConfigurationPayload)in.readObject()); + } - return installSnapshot; + byte[] data = (byte[])in.readObject(); + + installSnapshot = new InstallSnapshot(term, leaderId, lastIncludedIndex, lastIncludedTerm, data, + chunkIndex, totalChunks, lastChunkHashCode, serverConfig); } - } - public static boolean isSerializedType(Object message) { - return message instanceof InstallSnapshot || message instanceof InstallSnapshotMessages.InstallSnapshot; + private Object readResolve() { + return installSnapshot; + } } }