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.auth;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.Header;
michael@0: import ch.boye.httpclientandroidlib.HttpRequest;
michael@0: import ch.boye.httpclientandroidlib.protocol.HttpContext;
michael@0: 
michael@0: /**
michael@0:  * This interface represents an extended  authentication scheme
michael@0:  * that requires access to {@link HttpContext} in order to
michael@0:  * generate an authorization string.
michael@0:  *
michael@0:  * TODO: Fix AuthScheme interface in the next major version
michael@0:  *
michael@0:  * @since 4.1
michael@0:  */
michael@0: 
michael@0: public interface ContextAwareAuthScheme extends AuthScheme {
michael@0: 
michael@0:     /**
michael@0:      * Produces an authorization string for the given set of
michael@0:      * {@link Credentials}.
michael@0:      *
michael@0:      * @param credentials The set of credentials to be used for athentication
michael@0:      * @param request The request being authenticated
michael@0:      * @param context HTTP context
michael@0:      * @throws AuthenticationException if authorization string cannot
michael@0:      *   be generated due to an authentication failure
michael@0:      *
michael@0:      * @return the authorization string
michael@0:      */
michael@0:     Header authenticate(
michael@0:             Credentials credentials,
michael@0:             HttpRequest request,
michael@0:             HttpContext context) throws AuthenticationException;
michael@0: 
michael@0: }