1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/AuthenticationHandler.java Wed Dec 31 06:09:35 2014 +0100 1.3 @@ -0,0 +1,98 @@ 1.4 +/* 1.5 + * ==================================================================== 1.6 + * Licensed to the Apache Software Foundation (ASF) under one 1.7 + * or more contributor license agreements. See the NOTICE file 1.8 + * distributed with this work for additional information 1.9 + * regarding copyright ownership. The ASF licenses this file 1.10 + * to you under the Apache License, Version 2.0 (the 1.11 + * "License"); you may not use this file except in compliance 1.12 + * with the License. You may obtain a copy of the License at 1.13 + * 1.14 + * http://www.apache.org/licenses/LICENSE-2.0 1.15 + * 1.16 + * Unless required by applicable law or agreed to in writing, 1.17 + * software distributed under the License is distributed on an 1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 1.19 + * KIND, either express or implied. See the License for the 1.20 + * specific language governing permissions and limitations 1.21 + * under the License. 1.22 + * ==================================================================== 1.23 + * 1.24 + * This software consists of voluntary contributions made by many 1.25 + * individuals on behalf of the Apache Software Foundation. For more 1.26 + * information on the Apache Software Foundation, please see 1.27 + * <http://www.apache.org/>. 1.28 + * 1.29 + */ 1.30 + 1.31 +package ch.boye.httpclientandroidlib.client; 1.32 + 1.33 +import java.util.Map; 1.34 + 1.35 +import ch.boye.httpclientandroidlib.Header; 1.36 +import ch.boye.httpclientandroidlib.HttpResponse; 1.37 +import ch.boye.httpclientandroidlib.auth.AuthScheme; 1.38 +import ch.boye.httpclientandroidlib.auth.AuthenticationException; 1.39 +import ch.boye.httpclientandroidlib.auth.MalformedChallengeException; 1.40 +import ch.boye.httpclientandroidlib.protocol.HttpContext; 1.41 + 1.42 +/** 1.43 +/** 1.44 + * A handler for determining if an HTTP response represents an authentication 1.45 + * challenge that was sent back to the client as a result of authentication 1.46 + * failure. 1.47 + * <p> 1.48 + * Implementations of this interface must be thread-safe. Access to shared 1.49 + * data must be synchronized as methods of this interface may be executed 1.50 + * from multiple threads. 1.51 + * 1.52 + * @since 4.0 1.53 + */ 1.54 +public interface AuthenticationHandler { 1.55 + 1.56 + /** 1.57 + * Determines if the given HTTP response response represents 1.58 + * an authentication challenge that was sent back as a result 1.59 + * of authentication failure 1.60 + * @param response HTTP response. 1.61 + * @param context HTTP context. 1.62 + * @return <code>true</code> if user authentication is required, 1.63 + * <code>false</code> otherwise. 1.64 + */ 1.65 + boolean isAuthenticationRequested( 1.66 + HttpResponse response, 1.67 + HttpContext context); 1.68 + 1.69 + /** 1.70 + * Extracts from the given HTTP response a collection of authentication 1.71 + * challenges, each of which represents an authentication scheme supported 1.72 + * by the authentication host. 1.73 + * 1.74 + * @param response HTTP response. 1.75 + * @param context HTTP context. 1.76 + * @return a collection of challenges keyed by names of corresponding 1.77 + * authentication schemes. 1.78 + * @throws MalformedChallengeException if one of the authentication 1.79 + * challenges is not valid or malformed. 1.80 + */ 1.81 + Map<String, Header> getChallenges( 1.82 + HttpResponse response, 1.83 + HttpContext context) throws MalformedChallengeException; 1.84 + 1.85 + /** 1.86 + * Selects one authentication challenge out of all available and 1.87 + * creates and generates {@link AuthScheme} instance capable of 1.88 + * processing that challenge. 1.89 + * @param challenges collection of challenges. 1.90 + * @param response HTTP response. 1.91 + * @param context HTTP context. 1.92 + * @return authentication scheme to use for authentication. 1.93 + * @throws AuthenticationException if an authentication scheme 1.94 + * could not be selected. 1.95 + */ 1.96 + AuthScheme selectScheme( 1.97 + Map<String, Header> challenges, 1.98 + HttpResponse response, 1.99 + HttpContext context) throws AuthenticationException; 1.100 + 1.101 +}