1 /*
2 * Copyright (C) 2012, Google Inc.
3 * and other copyright owners as documented in the project's IP log.
4 * * This program and the accompanying materials are made available
5 * under the terms of the Eclipse Distribution License v1.0 which
6 * accompanies this distribution, is reproduced below, and is
7 * available at http://www.eclipse.org/org/documents/edl-v10.php
8 *
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
13 * conditions are met:
14 *
15 * - Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 *
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials provided
21 * with the distribution.
22 *
23 * - Neither the name of the Eclipse Foundation, Inc. nor the
24 * names of its contributors may be used to endorse or promote
25 * products derived from this software without specific prior
26 * written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
29 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
30 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
31 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
33 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
35 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
36 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
37 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
38 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
40 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 */
42
43 package org.eclipse.jgit.transport;
44
45 import java.io.IOException;
46
47 /**
48 * Hook to allow callers to take over advertising refs to the client.
49 *
50 * @since 2.0
51 */
52 public interface AdvertiseRefsHook {
53 /**
54 * A simple hook that advertises the default refs.
55 * <p>
56 * The method implementations do nothing to preserve the default behavior;
57 * see {@link UploadPack#setAdvertisedRefs(java.util.Map)} and
58 * {@link ReceivePack#setAdvertisedRefs(java.util.Map,java.util.Set)}.
59 */
60 AdvertiseRefsHook DEFAULT = new AdvertiseRefsHook() {
61 @Override
62 public void advertiseRefs(UploadPack uploadPack) {
63 // Do nothing.
64 }
65
66 @Override
67 public void advertiseRefs(ReceivePack receivePack) {
68 // Do nothing.
69 }
70 };
71
72 /**
73 * Advertise refs for upload-pack.
74 *
75 * @param uploadPack
76 * instance on which to call
77 * {@link org.eclipse.jgit.transport.UploadPack#setAdvertisedRefs(java.util.Map)}
78 * if necessary.
79 * @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
80 * abort; the message will be sent to the user.
81 */
82 void advertiseRefs(UploadPack uploadPack)
83 throws ServiceMayNotContinueException;
84
85 /**
86 * Advertise refs for receive-pack.
87 *
88 * @param receivePack
89 * instance on which to call
90 * {@link org.eclipse.jgit.transport.ReceivePack#setAdvertisedRefs(java.util.Map,java.util.Set)}
91 * if necessary.
92 * @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
93 * abort; the message will be sent to the user.
94 * @throws IOException
95 * @since 5.6
96 */
97 void advertiseRefs(ReceivePack receivePack)
98 throws ServiceMayNotContinueException, IOException;
99 }