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 /**
  12  * Reply for the AppendEntriesRpc message
  13  */
  14 public class AppendEntriesReply extends AbstractRaftRPC {
  15     private static final long serialVersionUID = -7487547356392536683L;
  16
  17     // true if follower contained entry matching
  18     // prevLogIndex and prevLogTerm
  19     private final boolean success;
  20
  21     // The index of the last entry in the followers log
  22     // This will be used to set the matchIndex for the follower on the
  23     // Leader
  24     private final long logLastIndex;
  25
  26     private final long logLastTerm;
  27
  28     // The followerId - this will be used to figure out which follower is
  29     // responding
  30     private final String followerId;
  31
  32     private final short payloadVersion;
  33
  34     private final boolean forceInstallSnapshot;
  35
  36     public AppendEntriesReply(String followerId, long term, boolean success, long logLastIndex, long logLastTerm,
  37             short payloadVersion) {
  38         this(followerId, term, success, logLastIndex, logLastTerm, payloadVersion, false);
  39     }
  40
  41     public AppendEntriesReply(String followerId, long term, boolean success, long logLastIndex, long logLastTerm,
  42                               short payloadVersion, boolean forceInstallSnapshot) {
  43         super(term);
  44
  45         this.followerId = followerId;
  46         this.success = success;
  47         this.logLastIndex = logLastIndex;
  48         this.logLastTerm = logLastTerm;
  49         this.payloadVersion = payloadVersion;
  50         this.forceInstallSnapshot = forceInstallSnapshot;
  51     }
  52
  53
  54     @Override
  55     public long getTerm() {
  56         return term;
  57     }
  58
  59     public boolean isSuccess() {
  60         return success;
  61     }
  62
  63     public long getLogLastIndex() {
  64         return logLastIndex;
  65     }
  66
  67     public long getLogLastTerm() {
  68         return logLastTerm;
  69     }
  70
  71     public String getFollowerId() {
  72         return followerId;
  73     }
  74
  75     public short getPayloadVersion() {
  76         return payloadVersion;
  77     }
  78
  79     @Override
  80     public String toString() {
  81         StringBuilder builder = new StringBuilder();
  82         builder.append("AppendEntriesReply [success=").append(success).append(", logLastIndex=").append(logLastIndex)
  83                 .append(", logLastTerm=").append(logLastTerm).append(", followerId=").append(followerId)
  84                 .append(", payloadVersion=").append(", forceInstallSnapshot=").append(forceInstallSnapshot)
  85                 .append(payloadVersion).append("]");
  86         return builder.toString();
  87     }
  88
  89     public boolean isForceInstallSnapshot() {
  90         return forceInstallSnapshot;
  91     }
  92 }