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.util.Map;
46 import java.util.Set;
47
48 import org.eclipse.jgit.lib.ObjectId;
49 import org.eclipse.jgit.lib.Ref;
50 import org.eclipse.jgit.lib.Repository;
51 import org.eclipse.jgit.revwalk.RevWalk;
52
53 /**
54 * Implementation of {@link org.eclipse.jgit.transport.AdvertiseRefsHook} that advertises the same refs for
55 * upload-pack and receive-pack.
56 *
57 * @since 2.0
58 */
59 public abstract class AbstractAdvertiseRefsHook implements AdvertiseRefsHook {
60 /** {@inheritDoc} */
61 @Override
62 public void advertiseRefs(UploadPack uploadPack)
63 throws ServiceMayNotContinueException {
64 uploadPack.setAdvertisedRefs(getAdvertisedRefs(
65 uploadPack.getRepository(), uploadPack.getRevWalk()));
66 }
67
68 /** {@inheritDoc} */
69 @Override
70 public void advertiseRefs(BaseReceivePack receivePack)
71 throws ServiceMayNotContinueException {
72 Map<String, Ref> refs = getAdvertisedRefs(receivePack.getRepository(),
73 receivePack.getRevWalk());
74 Set<ObjectId> haves = getAdvertisedHaves(receivePack.getRepository(),
75 receivePack.getRevWalk());
76 receivePack.setAdvertisedRefs(refs, haves);
77 }
78
79 /**
80 * Get the refs to advertise.
81 *
82 * @param repository
83 * repository instance.
84 * @param revWalk
85 * open rev walk on the repository.
86 * @return set of refs to advertise.
87 * @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
88 * abort; the message will be sent to the user.
89 */
90 protected abstract Map<String, Ref> getAdvertisedRefs(
91 Repository repository, RevWalk revWalk)
92 throws ServiceMayNotContinueException;
93
94 /**
95 * Get the additional haves to advertise.
96 *
97 * @param repository
98 * repository instance.
99 * @param revWalk
100 * open rev walk on the repository.
101 * @return set of additional haves; see
102 * {@link org.eclipse.jgit.transport.ReceivePack#getAdvertisedObjects()}.
103 * @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
104 * abort; the message will be sent to the user.
105 */
106 protected Set<ObjectId> getAdvertisedHaves(
107 Repository repository, RevWalk revWalk)
108 throws ServiceMayNotContinueException {
109 return null;
110 }
111 }