1 /*
2 * Copyright (C) 2010, Christian Halstrick <christian.halstrick@sap.com>,
3 * Copyright (C) 2010, Stefan Lay <stefan.lay@sap.com>
4 * and other copyright owners as documented in the project's IP log.
5 *
6 * This program and the accompanying materials are made available
7 * under the terms of the Eclipse Distribution License v1.0 which
8 * accompanies this distribution, is reproduced below, and is
9 * available at http://www.eclipse.org/org/documents/edl-v10.php
10 *
11 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
15 * conditions are met:
16 *
17 * - Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials provided
23 * with the distribution.
24 *
25 * - Neither the name of the Eclipse Foundation, Inc. nor the
26 * names of its contributors may be used to endorse or promote
27 * products derived from this software without specific prior
28 * written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 */
44
45 package org.eclipse.jgit.transport;
46
47 import java.util.List;
48
49 import org.eclipse.jgit.errors.UnsupportedCredentialItem;
50
51 /**
52 * Provide credentials for use in connecting to Git repositories.
53 *
54 * Implementors are strongly encouraged to support at least the minimal
55 * {@link CredentialItem.Username} and {@link CredentialItem.Password} items.
56 * More sophisticated implementors may implement additional types, such as
57 * {@link CredentialItem.StringType}.
58 *
59 * CredentialItems are usually presented in bulk, allowing implementors to
60 * combine them into a single UI widget and streamline the authentication
61 * process for an end-user.
62 *
63 * @see UsernamePasswordCredentialsProvider
64 */
65 public abstract class CredentialsProvider {
66 private static volatile CredentialsProvider defaultProvider;
67
68 /** @return the default credentials provider, or null. */
69 public static CredentialsProvider getDefault() {
70 return defaultProvider;
71 }
72
73 /**
74 * Set the default credentials provider.
75 *
76 * @param p
77 * the new default provider, may be null to select no default.
78 */
79 public static void setDefault(CredentialsProvider p) {
80 defaultProvider = p;
81 }
82
83 /**
84 * Check if the provider is interactive with the end-user.
85 *
86 * An interactive provider may try to open a dialog box, or prompt for input
87 * on the terminal, and will wait for a user response. A non-interactive
88 * provider will either populate CredentialItems, or fail.
89 *
90 * @return {@code true} if the provider is interactive with the end-user.
91 */
92 public abstract boolean isInteractive();
93
94 /**
95 * Check if the provider can supply the necessary {@link CredentialItem}s.
96 *
97 * @param items
98 * the items the application requires to complete authentication.
99 * @return {@code true} if this {@link CredentialsProvider} supports all of
100 * the items supplied.
101 */
102 public abstract boolean supports(CredentialItem... items);
103
104 /**
105 * Ask for the credential items to be populated.
106 *
107 * @param uri
108 * the URI of the remote resource that needs authentication.
109 * @param items
110 * the items the application requires to complete authentication.
111 * @return {@code true} if the request was successful and values were
112 * supplied; {@code false} if the user canceled the request and did
113 * not supply all requested values.
114 * @throws UnsupportedCredentialItem
115 * if one of the items supplied is not supported.
116 */
117 public abstract boolean get(URIish uri, CredentialItem... items)
118 throws UnsupportedCredentialItem;
119
120 /**
121 * Ask for the credential items to be populated.
122 *
123 * @param uri
124 * the URI of the remote resource that needs authentication.
125 * @param items
126 * the items the application requires to complete authentication.
127 * @return {@code true} if the request was successful and values were
128 * supplied; {@code false} if the user canceled the request and did
129 * not supply all requested values.
130 * @throws UnsupportedCredentialItem
131 * if one of the items supplied is not supported.
132 */
133 public boolean get(URIish uri, List<CredentialItem> items)
134 throws UnsupportedCredentialItem {
135 return get(uri, items.toArray(new CredentialItem[items.size()]));
136 }
137
138 /**
139 * Reset the credentials provider for the given URI
140 *
141 * @param uri
142 */
143 public void reset(URIish uri) {
144 // default does nothing
145 }
146 }