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.client;
28  
29  import org.apache.http.auth.AuthScope;
30  import org.apache.http.auth.Credentials;
31  
32  /**
33   * Abstract credentials provider that maintains a collection of user
34   * credentials.
35   * <p>
36   * Implementations of this interface must be thread-safe. Access to shared
37   * data must be synchronized as methods of this interface may be executed
38   * from multiple threads.
39   *
40   * @since 4.0
41   */
42  public interface CredentialsProvider {
43  
44      /**
45       * Sets the {@link Credentials credentials} for the given authentication
46       * scope. Any previous credentials for the given scope will be overwritten.
47       *
48       * @param authscope the {@link AuthScope authentication scope}
49       * @param credentials the authentication {@link Credentials credentials}
50       * for the given scope.
51       *
52       * @see #getCredentials(AuthScope)
53       */
54      void setCredentials(AuthScope authscope, Credentials credentials);
55  
56      /**
57       * Get the {@link Credentials credentials} for the given authentication scope.
58       *
59       * @param authscope the {@link AuthScope authentication scope}
60       * @return the credentials
61       *
62       * @see #setCredentials(AuthScope, Credentials)
63       */
64      Credentials getCredentials(AuthScope authscope);
65  
66      /**
67       * Clears all credentials.
68       */
69      void clear();
70  
71  }