opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntriesReply.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.cluster.raft.messages;
  10
  11 import java.io.Externalizable;
  12 import java.io.IOException;
  13 import java.io.ObjectInput;
  14 import java.io.ObjectOutput;
  15 import org.opendaylight.controller.cluster.raft.RaftVersions;
  16
  17 /**
  18  * Reply for the AppendEntries message.
  19  */
  20 public class AppendEntriesReply extends AbstractRaftRPC {
  21     private static final long serialVersionUID = -7487547356392536683L;
  22
  23     // true if follower contained entry matching
  24     // prevLogIndex and prevLogTerm
  25     private final boolean success;
  26
  27     // The index of the last entry in the followers log
  28     // This will be used to set the matchIndex for the follower on the
  29     // Leader
  30     private final long logLastIndex;
  31
  32     private final long logLastTerm;
  33
  34     // The followerId - this will be used to figure out which follower is
  35     // responding
  36     private final String followerId;
  37
  38     private final short payloadVersion;
  39
  40     private final short raftVersion;
  41
  42     private final boolean forceInstallSnapshot;
  43
  44     public AppendEntriesReply(String followerId, long term, boolean success, long logLastIndex, long logLastTerm,
  45             short payloadVersion) {
  46         this(followerId, term, success, logLastIndex, logLastTerm, payloadVersion, false);
  47     }
  48
  49     public AppendEntriesReply(String followerId, long term, boolean success, long logLastIndex, long logLastTerm,
  50             short payloadVersion, boolean forceInstallSnapshot) {
  51         this(followerId, term, success, logLastIndex, logLastTerm, payloadVersion, forceInstallSnapshot,
  52                 RaftVersions.CURRENT_VERSION);
  53
  54     }
  55
  56     private AppendEntriesReply(String followerId, long term, boolean success, long logLastIndex, long logLastTerm,
  57                               short payloadVersion, boolean forceInstallSnapshot, short raftVersion) {
  58         super(term);
  59
  60         this.followerId = followerId;
  61         this.success = success;
  62         this.logLastIndex = logLastIndex;
  63         this.logLastTerm = logLastTerm;
  64         this.payloadVersion = payloadVersion;
  65         this.forceInstallSnapshot = forceInstallSnapshot;
  66         this.raftVersion = raftVersion;
  67     }
  68
  69     public boolean isSuccess() {
  70         return success;
  71     }
  72
  73     public long getLogLastIndex() {
  74         return logLastIndex;
  75     }
  76
  77     public long getLogLastTerm() {
  78         return logLastTerm;
  79     }
  80
  81     public String getFollowerId() {
  82         return followerId;
  83     }
  84
  85     public short getPayloadVersion() {
  86         return payloadVersion;
  87     }
  88
  89     public short getRaftVersion() {
  90         return raftVersion;
  91     }
  92
  93     public boolean isForceInstallSnapshot() {
  94         return forceInstallSnapshot;
  95     }
  96
  97     @Override
  98     public String toString() {
  99         return "AppendEntriesReply [term=" + getTerm() + ", success=" + success + ", followerId=" + followerId
 100                 + ", logLastIndex=" + logLastIndex + ", logLastTerm=" + logLastTerm + ", forceInstallSnapshot="
 101                 + forceInstallSnapshot + ", payloadVersion=" + payloadVersion + ", raftVersion=" + raftVersion + "]";
 102     }
 103
 104     private Object writeReplace() {
 105         return new Proxy(this);
 106     }
 107
 108     private static class Proxy implements Externalizable {
 109         private static final long serialVersionUID = 1L;
 110
 111         private AppendEntriesReply appendEntriesReply;
 112
 113         // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
 114         // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
 115         @SuppressWarnings("checkstyle:RedundantModifier")
 116         public Proxy() {
 117         }
 118
 119         Proxy(AppendEntriesReply appendEntriesReply) {
 120             this.appendEntriesReply = appendEntriesReply;
 121         }
 122
 123         @Override
 124         public void writeExternal(ObjectOutput out) throws IOException {
 125             out.writeShort(appendEntriesReply.raftVersion);
 126             out.writeLong(appendEntriesReply.getTerm());
 127             out.writeObject(appendEntriesReply.followerId);
 128             out.writeBoolean(appendEntriesReply.success);
 129             out.writeLong(appendEntriesReply.logLastIndex);
 130             out.writeLong(appendEntriesReply.logLastTerm);
 131             out.writeShort(appendEntriesReply.payloadVersion);
 132             out.writeBoolean(appendEntriesReply.forceInstallSnapshot);
 133         }
 134
 135         @Override
 136         public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
 137             short raftVersion = in.readShort();
 138             long term = in.readLong();
 139             String followerId = (String) in.readObject();
 140             boolean success = in.readBoolean();
 141             long logLastIndex = in.readLong();
 142             long logLastTerm = in.readLong();
 143             short payloadVersion = in.readShort();
 144             boolean forceInstallSnapshot = in.readBoolean();
 145
 146             appendEntriesReply = new AppendEntriesReply(followerId, term, success, logLastIndex, logLastTerm,
 147                     payloadVersion, forceInstallSnapshot, raftVersion);
 148         }
 149
 150         private Object readResolve() {
 151             return appendEntriesReply;
 152         }
 153     }
 154 }