Module seppiko.commons.utils

Package org.seppiko.commons.utils.http

Class HttpClientUtil

java.lang.Object

org.seppiko.commons.utils.http.HttpClientUtil

Direct Known Subclasses:

AsyncHttpClientUtil

public class HttpClientUtil
extends Object

Http Client utility with java.net.http

Author:

Leonard Woo

Method Summary

Modifier and Type	Method	Description
protected static <T> HttpResponse.BodyHandler<?>	getBodyHandler(Class<T> type)	Response body checker
protected static <T> HttpRequest.BodyPublisher	getBodyPublisher(T requestBody)	Request body checker
static HttpRequest	getRequest(String url, HttpMethod method, int timeout, HttpHeaders headers, byte[] requestBody)	Get Request instance with byte array
static HttpRequest	getRequest(String url, HttpMethod method, int timeout, HttpHeaders headers, InputStream requestBody)	Get Request instance with InputStream
static HttpRequest	getRequest(String url, HttpMethod method, int timeout, HttpHeaders headers, String requestBody)	Get Request instance with String
protected static HttpRequest	getRequestRaw(URI uri, HttpMethod method, int timeout, Map<String,String> headers, HttpRequest.BodyPublisher requestBody)	Get HTTP request raw
static HttpResponse<byte[]>	getResponseByteArray(HttpRequest req, SSLContext sslContext, InetSocketAddress proxy)	Get Response instance with byte array body
static HttpResponse<InputStream>	getResponseInputStream(HttpRequest req, SSLContext sslContext, InetSocketAddress proxy)	Get Response instance with InputStream body
protected static <T> HttpResponse<T>	getResponseRaw(HttpRequest req, HttpResponse.BodyHandler<T> responseBodyHandler, SSLContext sslContext, InetSocketAddress proxy)	Get HTTP response raw
static HttpResponse<String>	getResponseString(HttpRequest req, SSLContext sslContext, InetSocketAddress proxy)	Get Response instance with String body

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getRequest

public static HttpRequest getRequest(String url,
 HttpMethod method,
 int timeout,
 HttpHeaders headers,
 String requestBody)
                              throws URISyntaxException,
IllegalArgumentException,
NullPointerException,
HttpRuntimeException

Get Request instance with String

Parameters:

url - URL String.

method - see HttpMethod.

timeout - Timeout.

headers - see HttpHeaders.

requestBody - Request body string.

Returns:

HttpRequest instance.

Throws:

URISyntaxException - URL is an illegal address.

IllegalArgumentException - something not supported or undefined.

NullPointerException - something is null.

HttpRuntimeException - Http request process exception.

getRequest

public static HttpRequest getRequest(String url,
 HttpMethod method,
 int timeout,
 HttpHeaders headers,
 InputStream requestBody)
                              throws URISyntaxException,
IllegalArgumentException,
NullPointerException,
HttpRuntimeException

Get Request instance with InputStream

Parameters:

url - URL String.

method - see HttpMethod.

timeout - Timeout.

headers - see HttpHeaders.

requestBody - Request body input stream.

Returns:

HttpRequest instance.

Throws:

URISyntaxException - URL is an illegal address.

IllegalArgumentException - something not supported or undefined.

NullPointerException - something is null.

HttpRuntimeException - Http request process exception.

getRequest

public static HttpRequest getRequest(String url,
 HttpMethod method,
 int timeout,
 HttpHeaders headers,
 byte[] requestBody)
                              throws URISyntaxException,
IllegalArgumentException,
NullPointerException,
HttpRuntimeException

Get Request instance with byte array

Parameters:

url - URL String.

method - see HttpMethod.

timeout - Timeout.

headers - see HttpHeaders.

requestBody - Request body byte array.

Returns:

HttpRequest instance.

Throws:

URISyntaxException - URL is an illegal address.

IllegalArgumentException - something not supported or undefined.

NullPointerException - something is null.

HttpRuntimeException - Http request process exception.

getResponseString

public static HttpResponse<String> getResponseString(HttpRequest req,
 SSLContext sslContext,
 InetSocketAddress proxy)
                                              throws HttpClientException,
HttpInterruptedException

Get Response instance with String body

Parameters:

req - HttpRequest instance.

sslContext - HTTP TLS Context, if unused set TLSUtil.NULL_SSL_CONTEXT. see TLSUtil.

proxy - Http proxy, Not null is enabled proxy.

Returns:

HttpResponse object, if NULL has failed.

Throws:

HttpClientException - get response exception.

HttpInterruptedException - if the operation is interrupted

getResponseByteArray

public static HttpResponse<byte[]> getResponseByteArray(HttpRequest req,
 SSLContext sslContext,
 InetSocketAddress proxy)
                                                 throws HttpClientException,
HttpInterruptedException

Get Response instance with byte array body

Parameters:

req - HttpRequest instance.

sslContext - HTTP TLS Context, if unused set TLSUtil.NULL_SSL_CONTEXT. see TLSUtil.

proxy - Http proxy, Not null is enabled proxy.

Returns:

HttpResponse object, if NULL has failed.

Throws:

HttpClientException - get response exception.

HttpInterruptedException - if the operation is interrupted.

getResponseInputStream

public static HttpResponse<InputStream> getResponseInputStream(HttpRequest req,
 SSLContext sslContext,
 InetSocketAddress proxy)
                                                        throws HttpClientException,
HttpInterruptedException

Get Response instance with InputStream body

Parameters:

req - HttpRequest instance.

sslContext - HTTP TLS Context, if unused set TLSUtil.NULL_SSL_CONTEXT. see TLSUtil.

proxy - Http proxy, Not null is enabled proxy.

Returns:

HttpResponse object, if NULL has failed.

Throws:

HttpClientException - get response exception.

HttpInterruptedException - if the operation is interrupted.

getRequestRaw

protected static HttpRequest getRequestRaw(URI uri,
 HttpMethod method,
 int timeout,
 Map<String,String> headers,
 HttpRequest.BodyPublisher requestBody)
                                    throws IllegalArgumentException,
IllegalStateException,
HttpTimeoutException

Get HTTP request raw

Parameters:

uri - request uri string.

method - request method, see HttpMethod.

timeout - request timeout.

headers - request headers, see HttpHeaders, if none is null.

requestBody - request body.

Returns:

HttpRequest object

Throws:

IllegalArgumentException - URI method or headers is not support or valid

IllegalStateException - if a URI has not been set

HttpTimeoutException - timeout is not valid

getResponseRaw

protected static <T> HttpResponse<T> getResponseRaw(HttpRequest req,
 HttpResponse.BodyHandler<T> responseBodyHandler,
 SSLContext sslContext,
 InetSocketAddress proxy)
                                             throws HttpInterruptedException,
HttpResponseException,
SecurityException

Get HTTP response raw

Type Parameters:

T - Response content type.

Parameters:

req - HTTP request

responseBodyHandler - Response body content type.

sslContext - HTTP TLS Context, if unused set TLSUtil.NULL_SSL_CONTEXT. see TLSUtil.

proxy - HTTP Proxy, Not null is enabled proxy.

Returns:

Http response instance.

Throws:

HttpInterruptedException - If the response is interrupted.

HttpResponseException - If the response has I/O error or not valid.

SecurityException - If a security manager has been installed, and it denies access to the URL in the given request, or proxy if one is configured.

getBodyPublisher

protected static <T> HttpRequest.BodyPublisher getBodyPublisher(T requestBody)
                                                         throws UnsupportedOperationException

Request body checker

Type Parameters:

T - body type.

Parameters:

requestBody - request body.

Returns:

BodyPublisher instance.

Throws:

UnsupportedOperationException - not found request body class type

getBodyHandler

protected static <T> HttpResponse.BodyHandler<?> getBodyHandler(Class<T> type)

Response body checker

Type Parameters:

T - class type.

Parameters:

type - response type.

Returns:

BodyHandler instance.