1 /*
2 * Copyright (C) 2008, 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 /**
49 * Hook invoked by {@link ReceivePack} before any updates are executed.
50 * <p>
51 * The hook is called with any commands that are deemed valid after parsing them
52 * from the client and applying the standard receive configuration options to
53 * them:
54 * <ul>
55 * <li><code>receive.denyDenyDeletes</code></li>
56 * <li><code>receive.denyNonFastForwards</code></li>
57 * </ul>
58 * This means the hook will not receive a non-fast-forward update command if
59 * denyNonFastForwards is set to true in the configuration file. To get all
60 * commands within the hook, see {@link ReceivePack#getAllCommands()}.
61 * <p>
62 * As the hook is invoked prior to the commands being executed, the hook may
63 * choose to block any command by setting its result status with
64 * {@link ReceiveCommand#setResult(ReceiveCommand.Result)}.
65 * <p>
66 * The hook may also choose to perform the command itself (or merely pretend
67 * that it has performed the command), by setting the result status to
68 * {@link ReceiveCommand.Result#OK}.
69 * <p>
70 * Hooks should run quickly, as they block the caller thread and the client
71 * process from completing.
72 * <p>
73 * Hooks may send optional messages back to the client via methods on
74 * {@link ReceivePack}. Implementors should be aware that not all network
75 * transports support this output, so some (or all) messages may simply be
76 * discarded. These messages should be advisory only.
77 */
78 public interface PreReceiveHook {
79 /** A simple no-op hook. */
80 public static final PreReceiveHook NULL = new PreReceiveHook() {
81 @Override
82 public void onPreReceive(final ReceivePack rp,
83 final Collection<ReceiveCommand> commands) {
84 // Do nothing.
85 }
86 };
87
88 /**
89 * Invoked just before commands are executed.
90 * <p>
91 * See the class description for how this method can impact execution.
92 *
93 * @param rp
94 * the process handling the current receive. Hooks may obtain
95 * details about the destination repository through this handle.
96 * @param commands
97 * unmodifiable set of valid commands still pending execution.
98 * May be the empty set.
99 */
100 public void onPreReceive(ReceivePack rp, Collection<ReceiveCommand> commands);
101 }