Make RequestVote immutable and change AbstractRPC#term to private

RequestVote has setters which aren't used. This class should be
immutable with final fields.

RequestVote also overrides getTerm from AbstractRPC as do a couple other
classes. This is unnecessary. Also AbstractRPC#term was changed from
protected to private.

Change-Id: Ie8891b49a37c9580abe7e52e288861c37de26fcd
Signed-off-by: Tom Pantelis <tpanteli@brocade.com>

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AbstractRaftRPC.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AbstractRaftRPC.java
index 3c9ebf47fd7178eca126ce962504153ca7f8ad21..bb343897206bc92e93e217217c6785b4a5b24af1 100644 (file)
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AbstractRaftRPC.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AbstractRaftRPC.java
@@ -12,7 +12,7 @@ public class AbstractRaftRPC implements RaftRPC {
     private static final long serialVersionUID = -6061342433962854822L;
 
     // term
-    protected long term;
+    private long term;
 
     protected AbstractRaftRPC(long term){
         this.term = term;

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntriesReply.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntriesReply.java
index 521a4512c7e49beef57ca56d2ac9f41e0d10a914..00a9e6fd7b37781237f0a9d49d600d74fba61485 100644 (file)
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntriesReply.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntriesReply.java
@@ -50,12 +50,6 @@ public class AppendEntriesReply extends AbstractRaftRPC {
         this.forceInstallSnapshot = forceInstallSnapshot;
     }
 
-
-    @Override
-    public long getTerm() {
-        return term;
-    }
-
     public boolean isSuccess() {
         return success;
     }
@@ -76,17 +70,14 @@ public class AppendEntriesReply extends AbstractRaftRPC {
         return payloadVersion;
     }
 
-    @Override
-    public String toString() {
-        StringBuilder builder = new StringBuilder();
-        builder.append("AppendEntriesReply [success=").append(success).append(", logLastIndex=").append(logLastIndex)
-                .append(", logLastTerm=").append(logLastTerm).append(", followerId=").append(followerId)
-                .append(", payloadVersion=").append(", forceInstallSnapshot=").append(forceInstallSnapshot)
-                .append(payloadVersion).append("]");
-        return builder.toString();
-    }
-
     public boolean isForceInstallSnapshot() {
         return forceInstallSnapshot;
     }
+
+    @Override
+    public String toString() {
+        return "AppendEntriesReply [term=" + getTerm() + ", success=" + success + ", followerId=" + followerId
+                + ", logLastIndex=" + logLastIndex + ", logLastTerm=" + logLastTerm + ", forceInstallSnapshot="
+                + forceInstallSnapshot + ", payloadVersion=" + payloadVersion + "]";
+    }
 }

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 13636f36d7594322432377b5156fece4d6279bd6..9757a0b8bd494dd5a31713f546e51878a1737b50 100644 (file)
--- 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
@@ -107,7 +107,7 @@ public class InstallSnapshot extends AbstractRaftRPC {
     @Override
     public String toString() {
         StringBuilder builder = new StringBuilder();
-        builder.append("InstallSnapshot [term=").append(term).append(", leaderId=").append(leaderId)
+        builder.append("InstallSnapshot [term=").append(getTerm()).append(", leaderId=").append(leaderId)
                 .append(", lastIncludedIndex=").append(lastIncludedIndex).append(", lastIncludedTerm=")
                 .append(lastIncludedTerm).append(", data=").append(data).append(", chunkIndex=").append(chunkIndex)
                 .append(", totalChunks=").append(totalChunks).append(", lastChunkHashCode=").append(lastChunkHashCode)

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshotReply.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshotReply.java
index 77efa53dfd9c627ff3b585e67471f21a47cce123..1d502cc6f4a460d7b94beceb158b8826bedd40b4 100644 (file)
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshotReply.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshotReply.java
@@ -40,7 +40,7 @@ public class InstallSnapshotReply extends AbstractRaftRPC {
     @Override
     public String toString() {
         StringBuilder builder = new StringBuilder();
-        builder.append("InstallSnapshotReply [term=").append(term).append(", followerId=").append(followerId)
+        builder.append("InstallSnapshotReply [term=").append(getTerm()).append(", followerId=").append(followerId)
                 .append(", chunkIndex=").append(chunkIndex).append(", success=").append(success).append("]");
         return builder.toString();
     }

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 8f162ae254ac1d9faaefbc89e8d6bed33dbd1b85..fc6d48906a73b63f34eaf053792b2c3a0cb1c3c0 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
@@ -15,31 +15,21 @@ public 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(long term, String candidateId, long lastLogIndex, long lastLogTerm) {
         super(term);
         this.candidateId = candidateId;
         this.lastLogIndex = lastLogIndex;
         this.lastLogTerm = lastLogTerm;
     }
 
-    // added for testing while serialize-messages=on
-    public RequestVote() {
-    }
-
-    @Override
-    public long getTerm() {
-        return term;
-    }
-
     public String getCandidateId() {
         return candidateId;
     }
@@ -52,22 +42,10 @@ public class RequestVote extends AbstractRaftRPC {
         return lastLogTerm;
     }
 
-    public void setCandidateId(String candidateId) {
-        this.candidateId = candidateId;
-    }
-
-    public void setLastLogIndex(long lastLogIndex) {
-        this.lastLogIndex = lastLogIndex;
-    }
-
-    public void setLastLogTerm(long lastLogTerm) {
-        this.lastLogTerm = lastLogTerm;
-    }
-
     @Override
     public String toString() {
         StringBuilder builder = new StringBuilder();
-        builder.append("RequestVote [term=").append(term).append(", candidateId=").append(candidateId)
+        builder.append("RequestVote [term=").append(getTerm()).append(", candidateId=").append(candidateId)
                 .append(", lastLogIndex=").append(lastLogIndex).append(", lastLogTerm=").append(lastLogTerm)
                 .append("]");
         return builder.toString();

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RequestVoteReply.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RequestVoteReply.java
index 865d4c287bd7b63cd051ef46b8db2b959f69d4b1..e1b18ae5e1855de69a67e4d140a3bf2be4bdc2fa 100644 (file)
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RequestVoteReply.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RequestVoteReply.java
@@ -19,11 +19,6 @@ public class RequestVoteReply extends AbstractRaftRPC {
         this.voteGranted = voteGranted;
     }
 
-    @Override
-    public long getTerm() {
-        return term;
-    }
-
     public boolean isVoteGranted() {
         return voteGranted;
     }
@@ -31,7 +26,7 @@ public class RequestVoteReply extends AbstractRaftRPC {
     @Override
     public String toString() {
         StringBuilder builder = new StringBuilder();
-        builder.append("RequestVoteReply [term=").append(term).append(", voteGranted=").append(voteGranted).append("]");
+        builder.append("RequestVoteReply [term=").append(getTerm()).append(", voteGranted=").append(voteGranted).append("]");
         return builder.toString();
     }
 }