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