1 /*
2 * ====================================================================
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with
6 * this work for additional information regarding copyright ownership.
7 * The ASF licenses this file to You under the Apache License, Version 2.0
8 * (the "License"); you may not use this file except in compliance with
9 * the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ====================================================================
19 *
20 * This software consists of voluntary contributions made by many
21 * individuals on behalf of the Apache Software Foundation. For more
22 * information on the Apache Software Foundation, please see
23 * <http://www.apache.org/>.
24 *
25 */
26
27 package org.apache.http.auth;
28
29 import org.apache.http.Header;
30 import org.apache.http.HttpRequest;
31 import org.apache.http.protocol.HttpContext;
32
33 /**
34 * This interface represents an extended authentication scheme
35 * that requires access to {@link HttpContext} in order to
36 * generate an authorization string.
37 *
38 * TODO: Fix AuthScheme interface in the next major version
39 *
40 * @since 4.1
41 */
42
43 public interface ContextAwareAuthScheme extends AuthScheme {
44
45 /**
46 * Produces an authorization string for the given set of
47 * {@link Credentials}.
48 *
49 * @param credentials The set of credentials to be used for athentication
50 * @param request The request being authenticated
51 * @param context HTTP context
52 * @throws AuthenticationException if authorization string cannot
53 * be generated due to an authentication failure
54 *
55 * @return the authorization string
56 */
57 Header authenticate(
58 Credentials credentials,
59 HttpRequest request,
60 HttpContext context) throws AuthenticationException;
61
62 }