Force AbstractRaftRPC to use Externalizable proxy pattern

[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / messages / RequestVote.java

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RequestVote.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RequestVote.java
index 310968de950bf2f5e4ff31bcbcc3d7718ad618a8..b23c76d06f9213d516f0f2a7345f85034c157333 100644 (file)
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RequestVote.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RequestVote.java
@@ -5,41 +5,35 @@
  * 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.Serializable;
+import java.io.Externalizable;
+import java.io.IOException;
+import java.io.ObjectInput;
+import java.io.ObjectOutput;
 
 /**
  * Invoked by candidates to gather votes (§5.2).
  */
-public class RequestVote extends AbstractRaftRPC implements Serializable{
+public final class RequestVote extends AbstractRaftRPC {
+    private static final long serialVersionUID = -6967509186297108657L;
 
     // candidate requesting vote
-    private String candidateId;
+    private final String candidateId;
 
     // index of candidate’s last log entry (§5.4)
-    private long lastLogIndex;
+    private final long lastLogIndex;
 
     // term of candidate’s last log entry (§5.4)
-    private long lastLogTerm;
+    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;
         this.lastLogTerm = lastLogTerm;
     }
 
-    // added for testing while serialize-messages=on
-    public RequestVote() {
-    }
-
-    public long getTerm() {
-        return term;
-    }
-
     public String getCandidateId() {
         return candidateId;
     }
@@ -52,15 +46,55 @@ public class RequestVote extends AbstractRaftRPC implements Serializable{
         return lastLogTerm;
     }
 
-    public void setCandidateId(String candidateId) {
-        this.candidateId = candidateId;
+    @Override
+    public String toString() {
+        return "RequestVote [term=" + getTerm()
+                + ", candidateId=" + candidateId
+                + ", lastLogIndex=" + lastLogIndex
+                + ", lastLogTerm=" + lastLogTerm
+                + "]";
     }
 
-    public void setLastLogIndex(long lastLogIndex) {
-        this.lastLogIndex = lastLogIndex;
+    @Override
+    Object writeReplace() {
+        return new Proxy(this);
     }
 
-    public void setLastLogTerm(long lastLogTerm) {
-        this.lastLogTerm = lastLogTerm;
+    private static class Proxy implements Externalizable {
+        private static final long serialVersionUID = 1L;
+
+        private RequestVote requestVote;
+
+        // 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() {
+        }
+
+        Proxy(final RequestVote requestVote) {
+            this.requestVote = requestVote;
+        }
+
+        @Override
+        public void writeExternal(final ObjectOutput out) throws IOException {
+            out.writeLong(requestVote.getTerm());
+            out.writeObject(requestVote.candidateId);
+            out.writeLong(requestVote.lastLogIndex);
+            out.writeLong(requestVote.lastLogTerm);
+        }
+
+        @Override
+        public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
+            long term = in.readLong();
+            String candidateId = (String) in.readObject();
+            long lastLogIndex = in.readLong();
+            long lastLogTerm = in.readLong();
+
+            requestVote = new RequestVote(term, candidateId, lastLogIndex, lastLogTerm);
+        }
+
+        private Object readResolve() {
+            return requestVote;
+        }
     }
 }