mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/AuthenticationHandler.java@fc2d59ddac77 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/AuthenticationHandler.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 | * Licensed to the Apache Software Foundation (ASF) under one |
| michael@0 | 4 | * or more contributor license agreements. See the NOTICE file |
| michael@0 | 5 | * distributed with this work for additional information |
| michael@0 | 6 | * regarding copyright ownership. The ASF licenses this file |
| michael@0 | 7 | * to you under the Apache License, Version 2.0 (the |
| michael@0 | 8 | * "License"); you may not use this file except in compliance |
| michael@0 | 9 | * with 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, |
| michael@0 | 14 | * software distributed under the License is distributed on an |
| michael@0 | 15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| michael@0 | 16 | * KIND, either express or implied. See the License for the |
| michael@0 | 17 | * specific language governing permissions and limitations |
| michael@0 | 18 | * under the License. |
| michael@0 | 19 | * ==================================================================== |
| michael@0 | 20 | * |
| michael@0 | 21 | * This software consists of voluntary contributions made by many |
| michael@0 | 22 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 23 | * information on the Apache Software Foundation, please see |
| michael@0 | 24 | * <http://www.apache.org/>. |
| michael@0 | 25 | * |
| michael@0 | 26 | */ |
| michael@0 | 27 | |
| michael@0 | 28 | package ch.boye.httpclientandroidlib.client; |
| michael@0 | 29 | |
| michael@0 | 30 | import java.util.Map; |
| michael@0 | 31 | |
| michael@0 | 32 | import ch.boye.httpclientandroidlib.Header; |
| michael@0 | 33 | import ch.boye.httpclientandroidlib.HttpResponse; |
| michael@0 | 34 | import ch.boye.httpclientandroidlib.auth.AuthScheme; |
| michael@0 | 35 | import ch.boye.httpclientandroidlib.auth.AuthenticationException; |
| michael@0 | 36 | import ch.boye.httpclientandroidlib.auth.MalformedChallengeException; |
| michael@0 | 37 | import ch.boye.httpclientandroidlib.protocol.HttpContext; |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | /** |
| michael@0 | 41 | * A handler for determining if an HTTP response represents an authentication |
| michael@0 | 42 | * challenge that was sent back to the client as a result of authentication |
| michael@0 | 43 | * failure. |
| michael@0 | 44 | * <p> |
| michael@0 | 45 | * Implementations of this interface must be thread-safe. Access to shared |
| michael@0 | 46 | * data must be synchronized as methods of this interface may be executed |
| michael@0 | 47 | * from multiple threads. |
| michael@0 | 48 | * |
| michael@0 | 49 | * @since 4.0 |
| michael@0 | 50 | */ |
| michael@0 | 51 | public interface AuthenticationHandler { |
| michael@0 | 52 | |
| michael@0 | 53 | /** |
| michael@0 | 54 | * Determines if the given HTTP response response represents |
| michael@0 | 55 | * an authentication challenge that was sent back as a result |
| michael@0 | 56 | * of authentication failure |
| michael@0 | 57 | * @param response HTTP response. |
| michael@0 | 58 | * @param context HTTP context. |
| michael@0 | 59 | * @return <code>true</code> if user authentication is required, |
| michael@0 | 60 | * <code>false</code> otherwise. |
| michael@0 | 61 | */ |
| michael@0 | 62 | boolean isAuthenticationRequested( |
| michael@0 | 63 | HttpResponse response, |
| michael@0 | 64 | HttpContext context); |
| michael@0 | 65 | |
| michael@0 | 66 | /** |
| michael@0 | 67 | * Extracts from the given HTTP response a collection of authentication |
| michael@0 | 68 | * challenges, each of which represents an authentication scheme supported |
| michael@0 | 69 | * by the authentication host. |
| michael@0 | 70 | * |
| michael@0 | 71 | * @param response HTTP response. |
| michael@0 | 72 | * @param context HTTP context. |
| michael@0 | 73 | * @return a collection of challenges keyed by names of corresponding |
| michael@0 | 74 | * authentication schemes. |
| michael@0 | 75 | * @throws MalformedChallengeException if one of the authentication |
| michael@0 | 76 | * challenges is not valid or malformed. |
| michael@0 | 77 | */ |
| michael@0 | 78 | Map<String, Header> getChallenges( |
| michael@0 | 79 | HttpResponse response, |
| michael@0 | 80 | HttpContext context) throws MalformedChallengeException; |
| michael@0 | 81 | |
| michael@0 | 82 | /** |
| michael@0 | 83 | * Selects one authentication challenge out of all available and |
| michael@0 | 84 | * creates and generates {@link AuthScheme} instance capable of |
| michael@0 | 85 | * processing that challenge. |
| michael@0 | 86 | * @param challenges collection of challenges. |
| michael@0 | 87 | * @param response HTTP response. |
| michael@0 | 88 | * @param context HTTP context. |
| michael@0 | 89 | * @return authentication scheme to use for authentication. |
| michael@0 | 90 | * @throws AuthenticationException if an authentication scheme |
| michael@0 | 91 | * could not be selected. |
| michael@0 | 92 | */ |
| michael@0 | 93 | AuthScheme selectScheme( |
| michael@0 | 94 | Map<String, Header> challenges, |
| michael@0 | 95 | HttpResponse response, |
| michael@0 | 96 | HttpContext context) throws AuthenticationException; |
| michael@0 | 97 | |
| michael@0 | 98 | } |
