CredentialsProvider.java revision 417f3b92ba4549b2f22340e3107d869d2b9c5bb8
1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/CredentialsProvider.java $
3 * $Revision: 558124 $
4 * $Date: 2007-07-20 13:36:47 -0700 (Fri, 20 Jul 2007) $
5 *
6 * ====================================================================
7 *
8 *  Licensed to the Apache Software Foundation (ASF) under one or more
9 *  contributor license agreements.  See the NOTICE file distributed with
10 *  this work for additional information regarding copyright ownership.
11 *  The ASF licenses this file to You under the Apache License, Version 2.0
12 *  (the "License"); you may not use this file except in compliance with
13 *  the License.  You may obtain a copy of the License at
14 *
15 *      http://www.apache.org/licenses/LICENSE-2.0
16 *
17 *  Unless required by applicable law or agreed to in writing, software
18 *  distributed under the License is distributed on an "AS IS" BASIS,
19 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 *  See the License for the specific language governing permissions and
21 *  limitations under the License.
22 * ====================================================================
23 *
24 * This software consists of voluntary contributions made by many
25 * individuals on behalf of the Apache Software Foundation.  For more
26 * information on the Apache Software Foundation, please see
27 * <http://www.apache.org/>.
28 *
29 */
30
31package org.apache.http.client;
32
33import org.apache.http.auth.AuthScope;
34import org.apache.http.auth.Credentials;
35
36/**
37 * Abstract credentials provider.
38 *
39 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
40 *
41 * @since 4.0
42 */
43public interface CredentialsProvider {
44
45    /**
46     * Sets the {@link Credentials credentials} for the given authentication
47     * scope. Any previous credentials for the given scope will be overwritten.
48     *
49     * @param authscope the {@link AuthScope authentication scope}
50     * @param credentials the authentication {@link Credentials credentials}
51     * for the given scope.
52     *
53     * @see #getCredentials(AuthScope)
54     */
55    void setCredentials(AuthScope authscope, Credentials credentials);
56
57    /**
58     * Get the {@link Credentials credentials} for the given authentication scope.
59     *
60     * @param authscope the {@link AuthScope authentication scope}
61     * @return the credentials
62     *
63     * @see #setCredentials(AuthScope, Credentials)
64     */
65    Credentials getCredentials(AuthScope authscope);
66
67    /**
68     * Clears all credentials.
69     */
70    void clear();
71
72}
73