Bump versions to 7.0.1-SNAPSHOT
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / base / messages / FollowerInitialSyncUpStatus.java
1 /*
2  * Copyright (c) 2015 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 package org.opendaylight.controller.cluster.raft.base.messages;
9
10 import static java.util.Objects.requireNonNull;
11
12 import org.eclipse.jdt.annotation.NonNull;
13
14 /**
15  * The FollowerInitialSyncUpStatus is sent by a Follower to inform any RaftActor subclass whether the Follower
16  * is at least at the same commitIndex as the Leader was when it sent the follower the very first heart beat.
17  * This status can be used to determine if a Follower has caught up with the current Leader in an upgrade scenario
18  * for example.
19  */
20 public final class FollowerInitialSyncUpStatus {
21     private final boolean initialSyncDone;
22     private final String name;
23
24     public FollowerInitialSyncUpStatus(final boolean initialSyncDone, final @NonNull String name) {
25         this.initialSyncDone = initialSyncDone;
26         this.name = requireNonNull(name);
27     }
28
29     public boolean isInitialSyncDone() {
30         return initialSyncDone;
31     }
32
33     public @NonNull String getName() {
34         return name;
35     }
36 }