1 /*
2 * Copyright (C) 2014, Matthias Sohn <matthias.sohn@sap.com>
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 package org.eclipse.jgit.transport;
44
45 import java.util.ArrayList;
46 import java.util.Arrays;
47 import java.util.List;
48
49 import org.eclipse.jgit.errors.UnsupportedCredentialItem;
50
51 /**
52 * A credentials provider chaining multiple credentials providers
53 *
54 * @since 3.5
55 */
56 public class ChainingCredentialsProvider extends CredentialsProvider {
57
58 private List<CredentialsProvider> credentialProviders;
59
60 /**
61 * Create a new chaining credential provider. This provider tries to
62 * retrieve credentials from the chained credential providers in the order
63 * they are given here. If multiple providers support the requested items
64 * and have non-null credentials the first of them will be used.
65 *
66 * @param providers
67 * credential providers asked for credentials in the order given
68 * here
69 */
70 public ChainingCredentialsProvider(CredentialsProvider... providers) {
71 this.credentialProviders = new ArrayList<>(
72 Arrays.asList(providers));
73 }
74
75 /** {@inheritDoc} */
76 @Override
77 public boolean isInteractive() {
78 for (CredentialsProvider p : credentialProviders)
79 if (p.isInteractive())
80 return true;
81 return false;
82 }
83
84 /** {@inheritDoc} */
85 @Override
86 public boolean supports(CredentialItem... items) {
87 for (CredentialsProvider p : credentialProviders)
88 if (p.supports(items))
89 return true;
90 return false;
91 }
92
93 /**
94 * {@inheritDoc}
95 * <p>
96 * Populates the credential items with the credentials provided by the first
97 * credential provider in the list which populates them with non-null values
98 *
99 * @see org.eclipse.jgit.transport.CredentialsProvider#supports(org.eclipse.jgit.transport.CredentialItem[])
100 */
101 @Override
102 public boolean get(URIish uri, CredentialItem... items)
103 throws UnsupportedCredentialItem {
104 for (CredentialsProvider p : credentialProviders) {
105 if (p.supports(items)) {
106 if (!p.get(uri, items)) {
107 if (p.isInteractive()) {
108 return false; // user cancelled the request
109 }
110 continue;
111 }
112 if (isAnyNull(items)) {
113 continue;
114 }
115 return true;
116 }
117 }
118 return false;
119 }
120 }