View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with 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,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
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  }