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 28 package org.apache.hc.client5.http; 29 30 import java.util.List; 31 import java.util.Map; 32 33 import org.apache.hc.client5.http.auth.AuthChallenge; 34 import org.apache.hc.client5.http.auth.AuthScheme; 35 import org.apache.hc.client5.http.auth.ChallengeType; 36 import org.apache.hc.core5.annotation.Contract; 37 import org.apache.hc.core5.annotation.ThreadingBehavior; 38 import org.apache.hc.core5.http.protocol.HttpContext; 39 40 /** 41 * Strategy to select auth schemes in order of preference based on auth challenges 42 * presented by the opposite endpoint (target server or a proxy). 43 * <p> 44 * Implementations of this interface must be thread-safe. Access to shared data must be 45 * synchronized as methods of this interface may be executed from multiple threads. 46 * 47 * @since 4.2 48 */ 49 @Contract(threading = ThreadingBehavior.STATELESS) 50 public interface AuthenticationStrategy { 51 52 /** 53 * Returns an list of {@link AuthScheme}s to handle the given {@link AuthChallenge}s 54 * in their order of preference. 55 * 56 * @param challengeType challenge type. 57 * @param challenges map of challenges keyed by lowercase auth scheme names. 58 * @param context HTTP context. 59 * @return authentication auth schemes that can be used for authentication. Can be empty. 60 * 61 * @since 5.0 62 */ 63 List<AuthScheme> select( 64 ChallengeType challengeType, 65 Map<String, AuthChallenge> challenges, 66 HttpContext context); 67 68 }