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.errors.RepositoryNotFoundException;
47 import org.eclipse.jgit.lib.Repository;
48 import org.eclipse.jgit.transport.ServiceMayNotContinueException;
49
50 /**
51 * Locate a Git {@link org.eclipse.jgit.lib.Repository} by name from the URL.
52 *
53 * @param <C>
54 * type of connection.
55 */
56 public interface RepositoryResolver<C> {
57 /**
58 * Resolver configured to open nothing.
59 */
60 public static final RepositoryResolver<?> NONE = new RepositoryResolver<Object>() {
61 @Override
62 public Repository open(Object req, String name)
63 throws RepositoryNotFoundException {
64 throw new RepositoryNotFoundException(name);
65 }
66 };
67
68 /**
69 * Locate and open a reference to a {@link Repository}.
70 * <p>
71 * The caller is responsible for closing the returned Repository.
72 *
73 * @param req
74 * the current request, may be used to inspect session state
75 * including cookies or user authentication.
76 * @param name
77 * name of the repository, as parsed out of the URL.
78 * @return the opened repository instance, never null.
79 * @throws RepositoryNotFoundException
80 * the repository does not exist or the name is incorrectly
81 * formatted as a repository name.
82 * @throws ServiceNotAuthorizedException
83 * the repository may exist, but HTTP access is not allowed
84 * without authentication, i.e. this corresponds to an HTTP 401
85 * Unauthorized.
86 * @throws ServiceNotEnabledException
87 * the repository may exist, but HTTP access is not allowed on the
88 * target repository, for the current user.
89 * @throws ServiceMayNotContinueException
90 * the repository may exist, but HTTP access is not allowed for
91 * the current request. The exception message contains a detailed
92 * message that should be shown to the user.
93 */
94 Repository open(C req, String name) throws RepositoryNotFoundException,
95 ServiceNotAuthorizedException, ServiceNotEnabledException,
96 ServiceMayNotContinueException;
97 }