1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/auth/ContextAwareAuthScheme.java Wed Dec 31 06:09:35 2014 +0100 1.3 @@ -0,0 +1,62 @@ 1.4 +/* 1.5 + * ==================================================================== 1.6 + * 1.7 + * Licensed to the Apache Software Foundation (ASF) under one or more 1.8 + * contributor license agreements. See the NOTICE file distributed with 1.9 + * this work for additional information regarding copyright ownership. 1.10 + * The ASF licenses this file to You under the Apache License, Version 2.0 1.11 + * (the "License"); you may not use this file except in compliance with 1.12 + * 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, software 1.17 + * distributed under the License is distributed on an "AS IS" BASIS, 1.18 + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1.19 + * See the License for the specific language governing permissions and 1.20 + * limitations under the License. 1.21 + * ==================================================================== 1.22 + * 1.23 + * This software consists of voluntary contributions made by many 1.24 + * individuals on behalf of the Apache Software Foundation. For more 1.25 + * information on the Apache Software Foundation, please see 1.26 + * <http://www.apache.org/>. 1.27 + * 1.28 + */ 1.29 + 1.30 +package ch.boye.httpclientandroidlib.auth; 1.31 + 1.32 +import ch.boye.httpclientandroidlib.Header; 1.33 +import ch.boye.httpclientandroidlib.HttpRequest; 1.34 +import ch.boye.httpclientandroidlib.protocol.HttpContext; 1.35 + 1.36 +/** 1.37 + * This interface represents an extended authentication scheme 1.38 + * that requires access to {@link HttpContext} in order to 1.39 + * generate an authorization string. 1.40 + * 1.41 + * TODO: Fix AuthScheme interface in the next major version 1.42 + * 1.43 + * @since 4.1 1.44 + */ 1.45 + 1.46 +public interface ContextAwareAuthScheme extends AuthScheme { 1.47 + 1.48 + /** 1.49 + * Produces an authorization string for the given set of 1.50 + * {@link Credentials}. 1.51 + * 1.52 + * @param credentials The set of credentials to be used for athentication 1.53 + * @param request The request being authenticated 1.54 + * @param context HTTP context 1.55 + * @throws AuthenticationException if authorization string cannot 1.56 + * be generated due to an authentication failure 1.57 + * 1.58 + * @return the authorization string 1.59 + */ 1.60 + Header authenticate( 1.61 + Credentials credentials, 1.62 + HttpRequest request, 1.63 + HttpContext context) throws AuthenticationException; 1.64 + 1.65 +}