1 /*
2 * Copyright (C) 2011, 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.transport;
45
46 import java.util.Collection;
47
48 import org.eclipse.jgit.lib.ObjectId;
49
50 /**
51 * Hook invoked by {@link org.eclipse.jgit.transport.UploadPack} before during
52 * critical phases.
53 * <p>
54 * If any hook function throws
55 * {@link org.eclipse.jgit.transport.ServiceMayNotContinueException} then
56 * processing stops immediately and the exception is thrown up the call stack.
57 * Most phases of UploadPack will try to report the exception's message text to
58 * the end-user over the client's protocol connection.
59 */
60 public interface PreUploadHook {
61 /** A simple no-op hook. */
62 PreUploadHook NULL = new PreUploadHook() {
63 @Override
64 public void onBeginNegotiateRound(UploadPack up,
65 Collection<? extends ObjectId> wants, int cntOffered)
66 throws ServiceMayNotContinueException {
67 // Do nothing.
68 }
69
70 @Override
71 public void onEndNegotiateRound(UploadPack up,
72 Collection<? extends ObjectId> wants, int cntCommon,
73 int cntNotFound, boolean ready)
74 throws ServiceMayNotContinueException {
75 // Do nothing.
76 }
77
78 @Override
79 public void onSendPack(UploadPack up,
80 Collection<? extends ObjectId> wants,
81 Collection<? extends ObjectId> haves)
82 throws ServiceMayNotContinueException {
83 // Do nothing.
84 }
85 };
86
87 /**
88 * Invoked before negotiation round is started.
89 *
90 * @param up
91 * the upload pack instance handling the connection.
92 * @param wants
93 * the list of wanted objects.
94 * @param cntOffered
95 * number of objects the client has offered.
96 * @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
97 * abort; the message will be sent to the user.
98 */
99 void onBeginNegotiateRound(UploadPack up,
100 Collection<? extends ObjectId> wants, int cntOffered)
101 throws ServiceMayNotContinueException;
102
103 /**
104 * Invoked after a negotiation round is completed.
105 *
106 * @param up
107 * the upload pack instance handling the connection.
108 * @param wants
109 * the list of wanted objects.
110 * @param cntCommon
111 * number of objects this round found to be common. In a smart
112 * HTTP transaction this includes the objects that were
113 * previously found to be common.
114 * @param cntNotFound
115 * number of objects in this round the local repository does not
116 * have, but that were offered as potential common bases.
117 * @param ready
118 * true if a pack is ready to be sent (the commit graph was
119 * successfully cut).
120 * @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
121 * abort; the message will be sent to the user.
122 */
123 void onEndNegotiateRound(UploadPack up,
124 Collection<? extends ObjectId> wants, int cntCommon,
125 int cntNotFound, boolean ready)
126 throws ServiceMayNotContinueException;
127
128 /**
129 * Invoked just before a pack will be sent to the client.
130 *
131 * @param up
132 * the upload pack instance handling the connection.
133 * @param wants
134 * the list of wanted objects. These may be RevObject or
135 * RevCommit if the processed parsed them. Implementors should
136 * not rely on the values being parsed.
137 * @param haves
138 * the list of common objects. Empty on an initial clone request.
139 * These may be RevObject or RevCommit if the processed parsed
140 * them. Implementors should not rely on the values being parsed.
141 * @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
142 * abort; the message will be sent to the user.
143 */
144 void onSendPack(UploadPack up, Collection<? extends ObjectId> wants,
145 Collection<? extends ObjectId> haves)
146 throws ServiceMayNotContinueException;
147 }