View Javadoc
1   /*
2    * Copyright (C) 2019, Google LLC.
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  package org.eclipse.jgit.transport;
44  
45  import java.util.Collections;
46  import java.util.List;
47  import java.util.stream.Collectors;
48  
49  /**
50   * {@link org.eclipse.jgit.transport.ProtocolV2Hook} that delegates to a list of
51   * other hooks.
52   * <p>
53   * Hooks are run in the order passed to the constructor. If running a method on
54   * one hook throws an exception, execution of remaining hook methods is aborted.
55   *
56   * @since 5.5
57   */
58  public class ProtocolV2HookChain implements ProtocolV2Hook {
59  	private final List<? extends ProtocolV2Hook> hooks;
60  
61  	/**
62  	 * Create a new hook chaining the given hooks together.
63  	 *
64  	 * @param hooks
65  	 *            hooks to execute, in order.
66  	 * @return a new hook chain of the given hooks.
67  	 */
68  	public static ProtocolV2Hook newChain(
69  			List<? extends ProtocolV2Hook> hooks) {
70  		List<? extends ProtocolV2Hook> newHooks = hooks.stream()
71  				.filter(hook -> !hook.equals(ProtocolV2Hook.DEFAULT))
72  				.collect(Collectors.toList());
73  
74  		if (newHooks.isEmpty()) {
75  			return ProtocolV2Hook.DEFAULT;
76  		} else if (newHooks.size() == 1) {
77  			return newHooks.get(0);
78  		} else {
79  			return new ProtocolV2HookChain(newHooks);
80  		}
81  	}
82  
83  	@Override
84  	public void onCapabilities(CapabilitiesV2Request req)
85  			throws ServiceMayNotContinueException {
86  		for (ProtocolV2Hook hook : hooks) {
87  			hook.onCapabilities(req);
88  		}
89  	}
90  
91  	@Override
92  	public void onLsRefs(LsRefsV2Request req)
93  			throws ServiceMayNotContinueException {
94  		for (ProtocolV2Hook hook : hooks) {
95  			hook.onLsRefs(req);
96  		}
97  	}
98  
99  	@Override
100 	public void onFetch(FetchV2Request req)
101 			throws ServiceMayNotContinueException {
102 		for (ProtocolV2Hook hook : hooks) {
103 			hook.onFetch(req);
104 		}
105 	}
106 
107 	private ProtocolV2HookChain(List<? extends ProtocolV2Hook> hooks) {
108 		this.hooks = Collections.unmodifiableList(hooks);
109 	}
110 }