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