001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027package org.apache.http.client;
028
029import org.apache.http.auth.AuthScope;
030import org.apache.http.auth.Credentials;
031
032/**
033 * Abstract credentials provider that maintains a collection of user
034 * credentials.
035 * <p>
036 * Implementations of this interface must be thread-safe. Access to shared
037 * data must be synchronized as methods of this interface may be executed
038 * from multiple threads.
039 *
040 * @since 4.0
041 */
042public interface CredentialsProvider {
043
044    /**
045     * Sets the {@link Credentials credentials} for the given authentication
046     * scope. Any previous credentials for the given scope will be overwritten.
047     *
048     * @param authscope the {@link AuthScope authentication scope}
049     * @param credentials the authentication {@link Credentials credentials}
050     * for the given scope.
051     *
052     * @see #getCredentials(AuthScope)
053     */
054    void setCredentials(AuthScope authscope, Credentials credentials);
055
056    /**
057     * Get the {@link Credentials credentials} for the given authentication scope.
058     *
059     * @param authscope the {@link AuthScope authentication scope}
060     * @return the credentials
061     *
062     * @see #setCredentials(AuthScope, Credentials)
063     */
064    Credentials getCredentials(AuthScope authscope);
065
066    /**
067     * Clears all credentials.
068     */
069    void clear();
070
071}