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 package org.apache.hc.client5.http.auth; 28 29 import org.apache.hc.core5.http.protocol.HttpContext; 30 31 /** 32 * Provider of authentication credentials. 33 * <p> 34 * Implementations of this interface must be thread-safe. Access to shared 35 * data must be synchronized as methods of this interface may be executed 36 * from multiple threads. 37 * </p> 38 * 39 * @since 4.0 40 */ 41 public interface CredentialsProvider { 42 43 /** 44 * Returns {@link Credentials credentials} for the given authentication scope, 45 * if available. 46 * 47 * @param authScope the {@link AuthScope authentication scope} 48 * @param context the {@link HttpContext http context} 49 * @return the credentials 50 * @since 5.0 51 */ 52 Credentials getCredentials(AuthScope authScope, HttpContext context); 53 54 }