org.apache.hc.client5.http.auth.CredentialsProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of httpclient5 Show documentation

Apache HttpComponents Client

The newest version!

/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * .
 *
 */
package org.apache.hc.client5.http.auth;

import org.apache.hc.core5.http.protocol.HttpContext;

/**
 * Provider of authentication credentials.
 * 
 * Implementations of this interface must be thread-safe. Access to shared
 * data must be synchronized as methods of this interface may be executed
 * from multiple threads.
 * 
 *
 * @since 4.0
 */
public interface CredentialsProvider {

    /**
     * Returns {@link Credentials credentials} for the given authentication scope,
     * if available.
     *
     * @param authScope the {@link AuthScope authentication scope}
     * @param context the {@link HttpContext http context}
     * @return the credentials
     * @since 5.0
     */
    Credentials getCredentials(AuthScope authScope, HttpContext context);

}