1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27 package org.apache.http.impl.client;
28
29 import java.util.Map;
30 import java.util.concurrent.ConcurrentHashMap;
31
32 import org.apache.http.annotation.ThreadSafe;
33 import org.apache.http.auth.AuthScope;
34 import org.apache.http.auth.Credentials;
35 import org.apache.http.client.CredentialsProvider;
36 import org.apache.http.util.Args;
37
38 /**
39 * Default implementation of {@link CredentialsProvider}.
40 *
41 * @since 4.0
42 */
43 @ThreadSafe
44 public class BasicCredentialsProvider implements CredentialsProvider {
45
46 private final ConcurrentHashMap<AuthScope, Credentials> credMap;
47
48 /**
49 * Default constructor.
50 */
51 public BasicCredentialsProvider() {
52 super();
53 this.credMap = new ConcurrentHashMap<AuthScope, Credentials>();
54 }
55
56 public void setCredentials(
57 final AuthScope authscope,
58 final Credentials credentials) {
59 Args.notNull(authscope, "Authentication scope");
60 credMap.put(authscope, credentials);
61 }
62
63 /**
64 * Find matching {@link Credentials credentials} for the given authentication scope.
65 *
66 * @param map the credentials hash map
67 * @param authscope the {@link AuthScope authentication scope}
68 * @return the credentials
69 *
70 */
71 private static Credentials matchCredentials(
72 final Map<AuthScope, Credentials> map,
73 final AuthScope authscope) {
74 // see if we get a direct hit
75 Credentials creds = map.get(authscope);
76 if (creds == null) {
77 // Nope.
78 // Do a full scan
79 int bestMatchFactor = -1;
80 AuthScope bestMatch = null;
81 for (final AuthScope current: map.keySet()) {
82 final int factor = authscope.match(current);
83 if (factor > bestMatchFactor) {
84 bestMatchFactor = factor;
85 bestMatch = current;
86 }
87 }
88 if (bestMatch != null) {
89 creds = map.get(bestMatch);
90 }
91 }
92 return creds;
93 }
94
95 public Credentials getCredentials(final AuthScope authscope) {
96 Args.notNull(authscope, "Authentication scope");
97 return matchCredentials(this.credMap, authscope);
98 }
99
100 public void clear() {
101 this.credMap.clear();
102 }
103
104 @Override
105 public String toString() {
106 return credMap.toString();
107 }
108
109 }