de.undercouch.gradle.tasks.download.internal.HttpClientFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gradle-download-task Show documentation

Adds a download task to Gradle that displays progress information

The newest version!

// Copyright 2016 Michel Kraemer
//
// Licensed 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.

package de.undercouch.gradle.tasks.download.internal;

import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.core5.http.HttpHost;
import org.gradle.api.logging.Logger;

import java.util.Map;

/**
 * Factory for Apache {@link CloseableHttpClient} objects
 * @author Michel Kraemer
 */
public interface HttpClientFactory {
    /**
     * Creates an HTTP client for the given host
     * @param httpHost the host to connect to
     * @param acceptAnyCertificate true if HTTPS certificate verification
     * errors should be ignored and any certificate (even an invalid one)
     * should be accepted
     * @param retries the number of retries to perform if an HTTP request fails
     * @param connectTimeoutMs the maximum number of milliseconds to wait until
     * a connection is established. A value of 0 (zero) means infinite timeout.
     * A negative value is interpreted as undefined.
     * @param headers the HTTP headers specified by the user
     * @param logger the project's logger
     * @param quiet {@code true} if the quiet flag is set
     * @return the HTTP client
     */
    CloseableHttpClient createHttpClient(HttpHost httpHost, boolean acceptAnyCertificate,
            int retries, int connectTimeoutMs, Map headers,
            Logger logger, boolean quiet);
}