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
|
/*
* Copyright (C) 2008, Google Inc.
* and other copyright owners as documented in the project's IP log.
*
* This program and the accompanying materials are made available
* under the terms of the Eclipse Distribution License v1.0 which
* accompanies this distribution, is reproduced below, and is
* available at http://www.eclipse.org/org/documents/edl-v10.php
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* - Neither the name of the Eclipse Foundation, Inc. nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.eclipse.jgit.transport;
import java.util.Collection;
/**
* Hook invoked by {@link org.eclipse.jgit.transport.ReceivePack} before any
* updates are executed.
* <p>
* The hook is called with any commands that are deemed valid after parsing them
* from the client and applying the standard receive configuration options to
* them:
* <ul>
* <li><code>receive.denyDenyDeletes</code></li>
* <li><code>receive.denyNonFastForwards</code></li>
* </ul>
* This means the hook will not receive a non-fast-forward update command if
* denyNonFastForwards is set to true in the configuration file. To get all
* commands within the hook, see
* {@link org.eclipse.jgit.transport.ReceivePack#getAllCommands()}.
* <p>
* As the hook is invoked prior to the commands being executed, the hook may
* choose to block any command by setting its result status with
* {@link org.eclipse.jgit.transport.ReceiveCommand#setResult(ReceiveCommand.Result)}.
* <p>
* The hook may also choose to perform the command itself (or merely pretend
* that it has performed the command), by setting the result status to
* {@link org.eclipse.jgit.transport.ReceiveCommand.Result#OK}.
* <p>
* Hooks should run quickly, as they block the caller thread and the client
* process from completing.
* <p>
* Hooks may send optional messages back to the client via methods on
* {@link org.eclipse.jgit.transport.ReceivePack}. Implementors should be aware
* that not all network transports support this output, so some (or all)
* messages may simply be discarded. These messages should be advisory only.
*/
public interface PreReceiveHook {
/** A simple no-op hook. */
PreReceiveHook NULL = new PreReceiveHook() {
@Override
public void onPreReceive(final ReceivePack rp,
final Collection<ReceiveCommand> commands) {
// Do nothing.
}
};
/**
* Invoked just before commands are executed.
* <p>
* See the class description for how this method can impact execution.
*
* @param rp
* the process handling the current receive. Hooks may obtain
* details about the destination repository through this handle.
* @param commands
* unmodifiable set of valid commands still pending execution.
* May be the empty set.
*/
void onPreReceive(ReceivePack rp, Collection<ReceiveCommand> commands);
}
|
