1 /*
2 * Copyright (C) 2009-2010, 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.resolver;
45
46 import org.eclipse.jgit.lib.Repository;
47 import org.eclipse.jgit.transport.UploadPack;
48
49 /**
50 * Create and configure {@link org.eclipse.jgit.transport.UploadPack} service
51 * instance.
52 *
53 * @param <C>
54 * the connection type
55 */
56 public interface UploadPackFactory<C> {
57 /**
58 * A factory disabling the UploadPack service for all repositories.
59 */
60 public static final UploadPackFactory<?> DISABLED = new UploadPackFactory<Object>() {
61 @Override
62 public UploadPack create(Object req, Repository db)
63 throws ServiceNotEnabledException {
64 throw new ServiceNotEnabledException();
65 }
66 };
67
68 /**
69 * Create and configure a new UploadPack instance for a repository.
70 *
71 * @param req
72 * current request, in case information from the request may help
73 * configure the UploadPack instance.
74 * @param db
75 * the repository the upload would read from.
76 * @return the newly configured UploadPack instance, must not be null.
77 * @throws ServiceNotEnabledException
78 * this factory refuses to create the instance because it is not
79 * allowed on the target repository, by any user.
80 * @throws ServiceNotAuthorizedException
81 * this factory refuses to create the instance for this HTTP
82 * request and repository, such as due to a permission error.
83 */
84 UploadPack create(C req, Repository db) throws ServiceNotEnabledException,
85 ServiceNotAuthorizedException;
86 }