1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*
* Copyright (C) 2011, Google Inc. and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.transport;
import java.util.Collection;
import org.eclipse.jgit.lib.ObjectId;
/**
* Hook invoked by {@link org.eclipse.jgit.transport.UploadPack} before during
* critical phases.
* <p>
* If any hook function throws
* {@link org.eclipse.jgit.transport.ServiceMayNotContinueException} then
* processing stops immediately and the exception is thrown up the call stack.
* Most phases of UploadPack will try to report the exception's message text to
* the end-user over the client's protocol connection.
*/
public interface PreUploadHook {
/** A simple no-op hook. */
PreUploadHook NULL = new PreUploadHook() {
@Override
public void onBeginNegotiateRound(UploadPack up,
Collection<? extends ObjectId> wants, int cntOffered)
throws ServiceMayNotContinueException {
// Do nothing.
}
@Override
public void onEndNegotiateRound(UploadPack up,
Collection<? extends ObjectId> wants, int cntCommon,
int cntNotFound, boolean ready)
throws ServiceMayNotContinueException {
// Do nothing.
}
@Override
public void onSendPack(UploadPack up,
Collection<? extends ObjectId> wants,
Collection<? extends ObjectId> haves)
throws ServiceMayNotContinueException {
// Do nothing.
}
};
/**
* Invoked before negotiation round is started.
*
* @param up
* the upload pack instance handling the connection.
* @param wants
* the list of wanted objects.
* @param cntOffered
* number of objects the client has offered.
* @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
* abort; the message will be sent to the user.
*/
void onBeginNegotiateRound(UploadPack up,
Collection<? extends ObjectId> wants, int cntOffered)
throws ServiceMayNotContinueException;
/**
* Invoked after a negotiation round is completed.
*
* @param up
* the upload pack instance handling the connection.
* @param wants
* the list of wanted objects.
* @param cntCommon
* number of objects this round found to be common. In a smart
* HTTP transaction this includes the objects that were
* previously found to be common.
* @param cntNotFound
* number of objects in this round the local repository does not
* have, but that were offered as potential common bases.
* @param ready
* true if a pack is ready to be sent (the commit graph was
* successfully cut).
* @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
* abort; the message will be sent to the user.
*/
void onEndNegotiateRound(UploadPack up,
Collection<? extends ObjectId> wants, int cntCommon,
int cntNotFound, boolean ready)
throws ServiceMayNotContinueException;
/**
* Invoked just before a pack will be sent to the client.
*
* @param up
* the upload pack instance handling the connection.
* @param wants
* the list of wanted objects. These may be RevObject or
* RevCommit if the processed parsed them. Implementors should
* not rely on the values being parsed.
* @param haves
* the list of common objects. Empty on an initial clone request.
* These may be RevObject or RevCommit if the processed parsed
* them. Implementors should not rely on the values being parsed.
* @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
* abort; the message will be sent to the user.
*/
void onSendPack(UploadPack up, Collection<? extends ObjectId> wants,
Collection<? extends ObjectId> haves)
throws ServiceMayNotContinueException;
}
|
