michael@0: /*
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *      http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  *  Unless required by applicable law or agreed to in writing, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.client;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.auth.AuthScope;
michael@0: import ch.boye.httpclientandroidlib.auth.Credentials;
michael@0: 
michael@0: /**
michael@0:  * Abstract credentials provider that maintains a collection of user
michael@0:  * credentials.
michael@0:  * <p>
michael@0:  * Implementations of this interface must be thread-safe. Access to shared
michael@0:  * data must be synchronized as methods of this interface may be executed
michael@0:  * from multiple threads.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface CredentialsProvider {
michael@0: 
michael@0:     /**
michael@0:      * Sets the {@link Credentials credentials} for the given authentication
michael@0:      * scope. Any previous credentials for the given scope will be overwritten.
michael@0:      *
michael@0:      * @param authscope the {@link AuthScope authentication scope}
michael@0:      * @param credentials the authentication {@link Credentials credentials}
michael@0:      * for the given scope.
michael@0:      *
michael@0:      * @see #getCredentials(AuthScope)
michael@0:      */
michael@0:     void setCredentials(AuthScope authscope, Credentials credentials);
michael@0: 
michael@0:     /**
michael@0:      * Get the {@link Credentials credentials} for the given authentication scope.
michael@0:      *
michael@0:      * @param authscope the {@link AuthScope authentication scope}
michael@0:      * @return the credentials
michael@0:      *
michael@0:      * @see #setCredentials(AuthScope, Credentials)
michael@0:      */
michael@0:     Credentials getCredentials(AuthScope authscope);
michael@0: 
michael@0:     /**
michael@0:      * Clears all credentials.
michael@0:      */
michael@0:     void clear();
michael@0: 
michael@0: }