1 /*
2 * Copyright (C) 2016, Google Inc.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.internal.ketch;
45
46 import java.util.Date;
47
48 import org.eclipse.jgit.annotations.Nullable;
49 import org.eclipse.jgit.lib.ObjectId;
50
51 /**
52 * A snapshot of a replica.
53 *
54 * @see LeaderSnapshot
55 */
56 public class ReplicaSnapshot {
57 final KetchReplica replica;
58 ObjectId accepted;
59 ObjectId committed;
60 KetchReplica.State state;
61 String error;
62 long retryAtMillis;
63
64 ReplicaSnapshot(KetchReplica replica) {
65 this.replica = replica;
66 }
67
68 /** @return the replica this snapshot describes the state of. */
69 public KetchReplica getReplica() {
70 return replica;
71 }
72
73 /** @return current state of the replica. */
74 public KetchReplica.State getState() {
75 return state;
76 }
77
78 /** @return last known Git commit at {@code refs/txn/accepted}. */
79 @Nullable
80 public ObjectId getAccepted() {
81 return accepted;
82 }
83
84 /** @return last known Git commit at {@code refs/txn/committed}. */
85 @Nullable
86 public ObjectId getCommitted() {
87 return committed;
88 }
89
90 /**
91 * @return if {@link #getState()} == {@link KetchReplica.State#OFFLINE} an
92 * optional human-readable message from the transport system
93 * explaining the failure.
94 */
95 @Nullable
96 public String getErrorMessage() {
97 return error;
98 }
99
100 /**
101 * @return time (usually in the future) when the leader will retry
102 * communication with the offline or lagging replica; null if no
103 * retry is scheduled or necessary.
104 */
105 @Nullable
106 public Date getRetryAt() {
107 return retryAtMillis > 0 ? new Date(retryAtMillis) : null;
108 }
109 }