All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.github.alexdlaird.http.HttpClient Maven / Gradle / Ivy

Go to download

A Java wrapper for ngrok

The newest version!
/*
 * Copyright (c) 2021-2024 Alex Laird
 *
 * SPDX-License-Identifier: MIT
 */

package com.github.alexdlaird.http;

import java.net.HttpURLConnection;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;

/**
 * A simple interface for executing HTTP requests.
 */
public interface HttpClient {

    /**
     * Perform GET operation against an endpoint.
     *
     * @param url               The URL on which to perform the operation.
     * @param parameters        An arbitrary number of parameters to add to the URL.
     * @param additionalHeaders Additional headers for the request.
     * @param clazz             The class for the Response's body.
     * @param                The response body type.
     * @return The results of the query.
     * @throws HttpClientException An error has occurred while executing the HTTP request.
     */
     Response get(final String url, final List parameters,
                        final Map additionalHeaders, final Class clazz);

    /**
     * See {@link #get(String, List, Map, Class)}.
     */
    default  Response get(final String url, final Class clazz) {
        return get(url, List.of(), Map.of(), clazz);
    }

    /**
     * Perform GET operation that downloads a file to the given path.
     *
     * @param url               The URL on which to perform the operation.
     * @param parameters        An arbitrary number of parameters to add to the URL.
     * @param additionalHeaders Additional headers for the request.
     * @param dest              The destination to which the file will be downloaded.
     * @param retries           The retry attempt index, if download fails.
     * @throws InterruptedException The thread is interrupted during retries.
     * @throws HttpClientException  An error has occurred while executing the HTTP request.
     */
    void get(final String url, final List parameters,
             final Map additionalHeaders, final Path dest, final int retries)
        throws InterruptedException;

    /**
     * See {@link #get(String, List, Map, Path, int)}.
     */
    default void get(final String url, final List parameters,
                     final Map additionalHeaders, final Path dest)
        throws InterruptedException {
        get(url, parameters, additionalHeaders, dest, 0);
    }

    /**
     * Perform POST operation against an endpoint.
     *
     * @param url               The URL on which to perform the operation.
     * @param request           The element to be serialized into the request body.
     * @param parameters        An arbitrary number of parameters to add to the URL.
     * @param additionalHeaders Additional headers for the request.
     * @param clazz             The class for the Response's body.
     * @param                The Request type.
     * @param                The Response body type.
     * @return The results of the query.
     * @throws HttpClientException An error has occurred while executing the HTTP request.
     */
     Response post(final String url, final R request, final List parameters,
                            final Map additionalHeaders, final Class clazz);

    /**
     * See {@link #post(String, Object, List, Map, Class)}.
     */
    default  Response post(final String url, final R request, final Class clazz) {
        return post(url, request, List.of(), Map.of(), clazz);
    }

    /**
     * Perform PUT operation against an endpoint.
     *
     * @param url               The URL on which to perform the operation.
     * @param request           The element to be serialized into the request body.
     * @param parameters        An arbitrary number of parameters to add to the URL.
     * @param additionalHeaders Additional headers for the request.
     * @param clazz             The class for the Response's body.
     * @param                The Request type.
     * @param                The Response body type.
     * @return The results of the query.
     * @throws HttpClientException An error has occurred while executing the HTTP request.
     */
     Response put(final String url, final R request, final List parameters,
                           final Map additionalHeaders, final Class clazz);

    /**
     * See {@link #put(String, Object, List, Map, Class)}.
     */
    default  Response put(final String url, final R request, final Class clazz) {
        return put(url, request, List.of(), Map.of(), clazz);
    }

    /**
     * Perform DELETE operation against an endpoint.
     *
     * @param url               The URL on which to perform the operation.
     * @param parameters        An arbitrary number of parameters to add to the URL.
     * @param additionalHeaders Additional headers for the request.
     * @param clazz             The class for the Response's body.
     * @param                The Response body type.
     * @return The results of the query.
     * @throws HttpClientException An error has occurred while executing the HTTP request.
     */
     Response delete(final String url, final List parameters,
                           final Map additionalHeaders, final Class clazz);

    /**
     * See {@link #delete(String, List, Map, Class)}.
     */
    default Response delete(final String url, final List parameters,
                                 final Map additionalHeaders) {
        return delete(url, parameters, additionalHeaders, Map.class);
    }

    /**
     * See {@link #delete(String, List, Map)}.
     */
    default Response delete(final String url) {
        return delete(url, List.of(), Map.of());
    }

    /**
     * Override this method if you could like to extend {@link DefaultHttpClient} and perform customer HTTP operations
     * before {@link HttpURLConnection#connect()} is called on the instance of the passed in connection.
     *
     * @param httpUrlConnection The URL connection to modify.
     */
    default void modifyConnection(final HttpURLConnection httpUrlConnection) {
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy