1 /*
2 * Copyright (C) 2011, 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 import java.util.Collections;
48 import java.util.List;
49 import java.util.stream.Collectors;
50
51 import org.eclipse.jgit.lib.ObjectId;
52
53 /**
54 * {@link org.eclipse.jgit.transport.PreUploadHook} that delegates to a list of
55 * other hooks.
56 * <p>
57 * Hooks are run in the order passed to the constructor. If running a method on
58 * one hook throws an exception, execution of remaining hook methods is aborted.
59 */
60 public class PreUploadHookChain implements PreUploadHook {
61 private final List<PreUploadHook> hooks;
62
63 /**
64 * Create a new hook chaining the given hooks together.
65 *
66 * @param hooks
67 * hooks to execute, in order.
68 * @return a new hook chain of the given hooks.
69 */
70 public static PreUploadHook newChain(List<PreUploadHook> hooks) {
71 List<PreUploadHook> newHooks = hooks.stream()
72 .filter(hook -> !hook.equals(PreUploadHook.NULL))
73 .collect(Collectors.toList());
74
75 if (newHooks.isEmpty()) {
76 return PreUploadHook.NULL;
77 } else if (newHooks.size() == 1) {
78 return newHooks.get(0);
79 } else {
80 return new PreUploadHookChain(newHooks);
81 }
82 }
83
84 /** {@inheritDoc} */
85 @Override
86 public void onBeginNegotiateRound(UploadPack up,
87 Collection<? extends ObjectId> wants, int cntOffered)
88 throws ServiceMayNotContinueException {
89 for (PreUploadHook hook : hooks) {
90 hook.onBeginNegotiateRound(up, wants, cntOffered);
91 }
92 }
93
94 /** {@inheritDoc} */
95 @Override
96 public void onEndNegotiateRound(UploadPack up,
97 Collection<? extends ObjectId> wants, int cntCommon,
98 int cntNotFound, boolean ready)
99 throws ServiceMayNotContinueException {
100 for (PreUploadHook hook : hooks) {
101 hook.onEndNegotiateRound(up, wants, cntCommon, cntNotFound, ready);
102 }
103 }
104
105 /** {@inheritDoc} */
106 @Override
107 public void onSendPack(UploadPack up,
108 Collection<? extends ObjectId> wants,
109 Collection<? extends ObjectId> haves)
110 throws ServiceMayNotContinueException {
111 for (PreUploadHook hook : hooks) {
112 hook.onSendPack(up, wants, haves);
113 }
114 }
115
116 private PreUploadHookChain(List<PreUploadHook> hooks) {
117 this.hooks = Collections.unmodifiableList(hooks);
118 }
119 }