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