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