X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2Fmessages%2FInstallSnapshot.java;h=3cd470f6cc6d3c7186dc4fb20324482b216153d7;hb=8e1d3c4f9001fbc8a5d3d3bea57916c5099078b2;hp=b64e902f3ff9f93e782c4114e6e690bbef971b0a;hpb=97542f208267cb5392fc8c8d9baf6c1d3ee4ae32;p=controller.git 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 b64e902f3f..3cd470f6cc 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 @@ -5,21 +5,24 @@ * 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.base.Optional; +import com.google.common.annotations.VisibleForTesting; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.io.Externalizable; import java.io.IOException; import java.io.ObjectInput; import java.io.ObjectOutput; +import java.util.Optional; +import java.util.OptionalInt; +import org.opendaylight.controller.cluster.raft.RaftVersions; import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload; /** * Message sent from a leader to install a snapshot chunk on a follower. */ -public class InstallSnapshot extends AbstractRaftRPC { +public final class InstallSnapshot extends AbstractRaftRPC { + @java.io.Serial private static final long serialVersionUID = 1L; private final String leaderId; @@ -28,15 +31,20 @@ public class InstallSnapshot extends AbstractRaftRPC { private final byte[] data; private final int chunkIndex; private final int totalChunks; - private final Optional lastChunkHashCode; + @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "Handled via writeReplace()") + private final OptionalInt lastChunkHashCode; + @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "Handled via writeReplace()") 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) { + private final short recipientRaftVersion; + + @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(final long term, final String leaderId, final long lastIncludedIndex, + final long lastIncludedTerm, final byte[] data, final int chunkIndex, final int totalChunks, + final OptionalInt lastChunkHashCode, final Optional serverConfig, + final short recipientRaftVersion) { super(term); this.leaderId = leaderId; this.lastIncludedIndex = lastIncludedIndex; @@ -46,12 +54,15 @@ public class InstallSnapshot extends AbstractRaftRPC { this.totalChunks = totalChunks; this.lastChunkHashCode = lastChunkHashCode; this.serverConfig = serverConfig; + this.recipientRaftVersion = recipientRaftVersion; } - public InstallSnapshot(long term, String leaderId, long lastIncludedIndex, - long lastIncludedTerm, byte[] data, int chunkIndex, int totalChunks) { - this(term, leaderId, lastIncludedIndex, lastIncludedTerm, data, chunkIndex, totalChunks, - Optional.absent(), Optional.absent()); + @VisibleForTesting + public InstallSnapshot(final long term, final String leaderId, final long lastIncludedIndex, + final long lastIncludedTerm, final byte[] data, final int chunkIndex, + final int totalChunks) { + this(term, leaderId, lastIncludedIndex, lastIncludedTerm, data, chunkIndex, totalChunks, OptionalInt.empty(), + Optional.empty(), RaftVersions.CURRENT_VERSION); } public String getLeaderId() { @@ -66,9 +77,10 @@ public class InstallSnapshot extends AbstractRaftRPC { 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.") + @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; } @@ -81,7 +93,7 @@ public class InstallSnapshot extends AbstractRaftRPC { return totalChunks; } - public Optional getLastChunkHashCode() { + public OptionalInt getLastChunkHashCode() { return lastChunkHashCode; } @@ -89,24 +101,21 @@ public class InstallSnapshot extends AbstractRaftRPC { return serverConfig; } - - public Object toSerializable(short version) { - return this; - } - @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() + "]"; + + ", serverConfig=" + serverConfig.orElse(null) + "]"; } - private Object writeReplace() { - return new Proxy(this); + @Override + Object writeReplace() { + return recipientRaftVersion <= RaftVersions.FLUORINE_VERSION ? new Proxy(this) : new IS(this); } private static class Proxy implements Externalizable { + @java.io.Serial private static final long serialVersionUID = 1L; private InstallSnapshot installSnapshot; @@ -117,12 +126,12 @@ public class InstallSnapshot extends AbstractRaftRPC { public Proxy() { } - Proxy(InstallSnapshot installSnapshot) { + Proxy(final InstallSnapshot installSnapshot) { this.installSnapshot = installSnapshot; } @Override - public void writeExternal(ObjectOutput out) throws IOException { + public void writeExternal(final ObjectOutput out) throws IOException { out.writeLong(installSnapshot.getTerm()); out.writeObject(installSnapshot.leaderId); out.writeLong(installSnapshot.lastIncludedIndex); @@ -132,19 +141,19 @@ public class InstallSnapshot extends AbstractRaftRPC { out.writeByte(installSnapshot.lastChunkHashCode.isPresent() ? 1 : 0); if (installSnapshot.lastChunkHashCode.isPresent()) { - out.writeInt(installSnapshot.lastChunkHashCode.get().intValue()); + out.writeInt(installSnapshot.lastChunkHashCode.orElseThrow()); } out.writeByte(installSnapshot.serverConfig.isPresent() ? 1 : 0); if (installSnapshot.serverConfig.isPresent()) { - out.writeObject(installSnapshot.serverConfig.get()); + out.writeObject(installSnapshot.serverConfig.orElseThrow()); } out.writeObject(installSnapshot.data); } @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 lastIncludedIndex = in.readLong(); @@ -152,24 +161,17 @@ public class InstallSnapshot extends AbstractRaftRPC { int chunkIndex = in.readInt(); int totalChunks = in.readInt(); - Optional lastChunkHashCode = Optional.absent(); - boolean chunkHashCodePresent = in.readByte() == 1; - if (chunkHashCodePresent) { - lastChunkHashCode = Optional.of(in.readInt()); - } - - Optional serverConfig = Optional.absent(); - boolean serverConfigPresent = in.readByte() == 1; - if (serverConfigPresent) { - serverConfig = Optional.of((ServerConfigurationPayload)in.readObject()); - } + OptionalInt lastChunkHashCode = in.readByte() == 1 ? OptionalInt.of(in.readInt()) : OptionalInt.empty(); + Optional serverConfig = in.readByte() == 1 + ? Optional.of((ServerConfigurationPayload)in.readObject()) : Optional.empty(); byte[] data = (byte[])in.readObject(); installSnapshot = new InstallSnapshot(term, leaderId, lastIncludedIndex, lastIncludedTerm, data, - chunkIndex, totalChunks, lastChunkHashCode, serverConfig); + chunkIndex, totalChunks, lastChunkHashCode, serverConfig, RaftVersions.CURRENT_VERSION); } + @java.io.Serial private Object readResolve() { return installSnapshot; }