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} after all updates are executed.
50 * <p>
51 * The hook is called after all commands have been processed. Only commands with
52 * a status of {@link ReceiveCommand.Result#OK} are passed into the hook. To get
53 * all commands within the hook, see {@link ReceivePack#getAllCommands()}.
54 * <p>
55 * Any post-receive hook implementation should not update the status of a
56 * command, as the command has already completed or failed, and the status has
57 * already been returned to the client.
58 * <p>
59 * Hooks should execute quickly, as they block the server and the client from
60 * completing the connection.
61 */
62 public interface PostReceiveHook {
63 /** A simple no-op hook. */
64 public static final PostReceiveHook NULL = new PostReceiveHook() {
65 @Override
66 public void onPostReceive(final ReceivePack rp,
67 final Collection<ReceiveCommand> commands) {
68 // Do nothing.
69 }
70 };
71
72 /**
73 * Invoked after all commands are executed and status has been returned.
74 *
75 * @param rp
76 * the process handling the current receive. Hooks may obtain
77 * details about the destination repository through this handle.
78 * @param commands
79 * unmodifiable set of successfully completed commands. May be
80 * the empty set.
81 */
82 public void onPostReceive(ReceivePack rp,
83 Collection<ReceiveCommand> commands);
84 }