View Javadoc

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      @Override
57      public void setCredentials(
58              final AuthScope authscope,
59              final Credentials credentials) {
60          Args.notNull(authscope, "Authentication scope");
61          credMap.put(authscope, credentials);
62      }
63  
64      /**
65       * Find matching {@link Credentials credentials} for the given authentication scope.
66       *
67       * @param map the credentials hash map
68       * @param authscope the {@link AuthScope authentication scope}
69       * @return the credentials
70       *
71       */
72      private static Credentials matchCredentials(
73              final Map<AuthScope, Credentials> map,
74              final AuthScope authscope) {
75          // see if we get a direct hit
76          Credentials creds = map.get(authscope);
77          if (creds == null) {
78              // Nope.
79              // Do a full scan
80              int bestMatchFactor  = -1;
81              AuthScope bestMatch  = null;
82              for (final AuthScope current: map.keySet()) {
83                  final int factor = authscope.match(current);
84                  if (factor > bestMatchFactor) {
85                      bestMatchFactor = factor;
86                      bestMatch = current;
87                  }
88              }
89              if (bestMatch != null) {
90                  creds = map.get(bestMatch);
91              }
92          }
93          return creds;
94      }
95  
96      @Override
97      public Credentials getCredentials(final AuthScope authscope) {
98          Args.notNull(authscope, "Authentication scope");
99          return matchCredentials(this.credMap, authscope);
100     }
101 
102     @Override
103     public void clear() {
104         this.credMap.clear();
105     }
106 
107     @Override
108     public String toString() {
109         return credMap.toString();
110     }
111 
112 }