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.auth; 028 029import org.apache.http.Header; 030import org.apache.http.HttpRequest; 031import org.apache.http.protocol.HttpContext; 032 033/** 034 * This interface represents an extended authentication scheme 035 * that requires access to {@link HttpContext} in order to 036 * generate an authorization string. 037 * 038 * TODO: Fix AuthScheme interface in the next major version 039 * 040 * @since 4.1 041 */ 042 043public interface ContextAwareAuthScheme extends AuthScheme { 044 045 /** 046 * Produces an authorization string for the given set of 047 * {@link Credentials}. 048 * 049 * @param credentials The set of credentials to be used for athentication 050 * @param request The request being authenticated 051 * @param context HTTP context 052 * @throws AuthenticationException if authorization string cannot 053 * be generated due to an authentication failure 054 * 055 * @return the authorization string 056 */ 057 Header authenticate( 058 Credentials credentials, 059 HttpRequest request, 060 HttpContext context) throws AuthenticationException; 061 062}