org.spearce.jgit/src/org/spearce/jgit/transport/PostReceiveHook.java

   1 /*
   2  * Copyright (C) 2008, Google Inc.
   3  *
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or
   7  * without modification, are permitted provided that the following
   8  * conditions are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  *
  13  * - Redistributions in binary form must reproduce the above
  14  *   copyright notice, this list of conditions and the following
  15  *   disclaimer in the documentation and/or other materials provided
  16  *   with the distribution.
  17  *
  18  * - Neither the name of the Git Development Community nor the
  19  *   names of its contributors may be used to endorse or promote
  20  *   products derived from this software without specific prior
  21  *   written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  24  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  33  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  35  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 package org.spearce.jgit.transport;
  39
  40 import java.util.Collection;
  41
  42 /**
  43  * Hook invoked by {@link ReceivePack} after all updates are executed.
  44  * <p>
  45  * The hook is called after all commands have been processed. Only commands with
  46  * a status of {@link ReceiveCommand.Result#OK} are passed into the hook. To get
  47  * all commands within the hook, see {@link ReceivePack#getAllCommands()}.
  48  * <p>
  49  * Any post-receive hook implementation should not update the status of a
  50  * command, as the command has already completed or failed, and the status has
  51  * already been returned to the client.
  52  * <p>
  53  * Hooks should execute quickly, as they block the server and the client from
  54  * completing the connection.
  55  */
  56 public interface PostReceiveHook {
  57         /** A simple no-op hook. */
  58         public static final PostReceiveHook NULL = new PostReceiveHook() {
  59                 public void onPostReceive(final ReceivePack rp,
  60                                 final Collection<ReceiveCommand> commands) {
  61                         // Do nothing.
  62                 }
  63         };
  64
  65         /**
  66          * Invoked after all commands are executed and status has been returned.
  67          *
  68          * @param rp
  69          *            the process handling the current receive. Hooks may obtain
  70          *            details about the destination repository through this handle.
  71          * @param commands
  72          *            unmodifiable set of successfully completed commands. May be
  73          *            the empty set.
  74          */
  75         public void onPostReceive(ReceivePack rp,
  76                         Collection<ReceiveCommand> commands);
  77 }