Bug 3020: Add version to AppendEntries and AppendEntriesReply
[controller.git] / 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     public AppendEntriesReply(String followerId, long term, boolean success, long logLastIndex, long logLastTerm,
35             short payloadVersion) {
36         super(term);
37
38         this.followerId = followerId;
39         this.success = success;
40         this.logLastIndex = logLastIndex;
41         this.logLastTerm = logLastTerm;
42         this.payloadVersion = payloadVersion;
43     }
44
45     @Override
46     public long getTerm() {
47         return term;
48     }
49
50     public boolean isSuccess() {
51         return success;
52     }
53
54     public long getLogLastIndex() {
55         return logLastIndex;
56     }
57
58     public long getLogLastTerm() {
59         return logLastTerm;
60     }
61
62     public String getFollowerId() {
63         return followerId;
64     }
65
66     public short getPayloadVersion() {
67         return payloadVersion;
68     }
69
70     @Override
71     public String toString() {
72         StringBuilder builder = new StringBuilder();
73         builder.append("AppendEntriesReply [success=").append(success).append(", logLastIndex=").append(logLastIndex)
74                 .append(", logLastTerm=").append(logLastTerm).append(", followerId=").append(followerId)
75                 .append(", payloadVersion=").append(payloadVersion).append("]");
76         return builder.toString();
77     }
78 }