com.jsunsoft.http

Class HttpRequestBuilder<T>

java.lang.Object

com.jsunsoft.http.HttpRequestBuilder<T>

Type Parameters:

T - Type of expected successful response

public final class HttpRequestBuilder<T>
extends Object

Builder to create BasicHttpRequest instance

Builder objects are not immutable they can't be shared.

Method Summary

Modifier and Type	Method and Description
HttpRequestBuilder<T>	addContentType(org.apache.http.entity.ContentType contentType) Sets content type to header
HttpRequestBuilder<T>	addDefaultHeader(org.apache.http.Header header) Header needs to be the same for all requests
HttpRequestBuilder<T>	addDefaultHeader(String name, String value) Header needs to be the same for all requests
HttpRequestBuilder<T>	addDefaultHeaders(Collection<? extends org.apache.http.Header> headers) Header needs to be the same for all requests
HttpRequestBuilder<T>	addDefaultHeaders(org.apache.http.Header... headers) Header needs to be the same for all requests
HttpRequestBuilder<T>	addDefaultRequestParameter(Collection<? extends org.apache.http.NameValuePair> defaultRequestParameters) Parameters needs to be add for all requests.
HttpRequestBuilder<T>	addDefaultRequestParameter(Map<String,String> defaultParameters) Parameters needs to be add for all requests.
HttpRequestBuilder<T>	addDefaultRequestParameter(org.apache.http.NameValuePair... nameValues) Parameters needs to be add for all requests.
HttpRequestBuilder<T>	addDefaultRequestParameter(String name, String value) Parameter needs to be add for all requests.
HttpRequestBuilder<T>	addHttpClientCustomizer(Consumer<org.apache.http.impl.client.HttpClientBuilder> httpClientCustomizer) The method takes the Consumer instance which gives the HttpClientBuilder instance to customize the CloseableHttpClient before the http-request is built
HttpRequestBuilder<T>	basicAuth(String username, String password) Basic Authentication - sending the Authorization header.
HttpRequest<T>	build() Build Http request
HttpRequestBuilder<T>	connectionConfig(ConnectionConfig connectionConfig) Configured connection parameters by instance connectionConfig
HttpRequestBuilder<T>	connectionRequestTimeout(int connectionRequestTimeout)
HttpRequestBuilder<T>	connectTimeout(int connectTimeout)
static HttpRequestBuilder<?>	create(HttpMethod httpMethod, String uri) Created Builder to build BasicHttpRequest to get request
static <T> HttpRequestBuilder<T>	create(HttpMethod httpMethod, String uri, Class<T> type) Created Builder to build BasicHttpRequest to get request
static <T> HttpRequestBuilder<T>	create(HttpMethod httpMethod, String uri, TypeReference<T> typeReference) Created Builder to build BasicHttpRequest to get request
static HttpRequestBuilder<?>	create(HttpMethod httpMethod, URI uri) Created Builder to build BasicHttpRequest to get request
static <T> HttpRequestBuilder<T>	create(HttpMethod httpMethod, URI uri, Class<T> type) Created Builder to build BasicHttpRequest to get request
static <T> HttpRequestBuilder<T>	create(HttpMethod httpMethod, URI uri, TypeReference<T> typeReference) Created Builder to build BasicHttpRequest to get request
static HttpRequestBuilder<?>	createGet(String uri) Created Builder to build BasicHttpRequest to get request
static <T> HttpRequestBuilder<T>	createGet(String uri, Class<T> type) Created Builder to build BasicHttpRequest to get request
static <T> HttpRequestBuilder<T>	createGet(String uri, TypeReference<T> typeReference) Created Builder to build BasicHttpRequest to get request
static HttpRequestBuilder<?>	createGet(URI uri) Created Builder to build BasicHttpRequest to get request
static <T> HttpRequestBuilder<T>	createGet(URI uri, Class<T> type) Created Builder to build BasicHttpRequest to get request
static <T> HttpRequestBuilder<T>	createGet(URI uri, TypeReference<T> typeReference) Created Builder to build BasicHttpRequest to get request
static HttpRequestBuilder<?>	createPost(String uri) Created Builder to build BasicHttpRequest to post request
static <T> HttpRequestBuilder<T>	createPost(String uri, Class<T> type) Created Builder to build BasicHttpRequest to post request
static <T> HttpRequestBuilder<T>	createPost(String uri, TypeReference<T> typeReference) Created Builder to build BasicHttpRequest to post request
static HttpRequestBuilder<?>	createPost(URI uri) Created Builder to build BasicHttpRequest to post request
static <T> HttpRequestBuilder<T>	createPost(URI uri, Class<T> type) Created Builder to build BasicHttpRequest to post request
static <T> HttpRequestBuilder<T>	createPost(URI uri, TypeReference<T> typeReference) Created Builder to build BasicHttpRequest to post request
HttpRequestBuilder<T>	dateDeserializeContext(DateDeserializeContext dateDeserializeContext) Default date patterns to deserialize: for date is 'dd/MM/yyyy', for time is 'HH:mm:ss', for date time is 'dd/MM/yyyy HH:mm:ss'.
HttpRequestBuilder<T>	enableDefaultRedirectStrategy() By default, only GET requests resulting in a redirect are automatically followed.
HttpRequestBuilder<T>	enableLaxRedirectStrategy() By default, only GET requests resulting in a redirect are automatically followed.
HttpRequestBuilder<T>	excludeCookies() Disable cookies including in request.
HttpRequestBuilder<T>	hostnameVerifier(HostnameVerifier hostnameVerifier) Sets HostnameVerifier
HttpRequestBuilder<T>	includeCookies(Supplier<String> cookiesSupplier) If method is called and requestSupplier non null enabled cookies including to request.
HttpRequestBuilder<T>	maxPoolSize(int maxPoolSize)
HttpRequestBuilder<T>	proxy(org.apache.http.HttpHost proxy) Added proxy host.
HttpRequestBuilder<T>	proxy(String host, int port)
HttpRequestBuilder<T>	proxy(URI proxyUri) Added proxy by proxyUri.
HttpRequestBuilder<T>	redirectStrategy(org.apache.http.client.RedirectStrategy redirectStrategy) By default disabled.
HttpRequestBuilder<T>	responseDeserializer(ResponseDeserializer<T> responseDeserializer)
HttpRequestBuilder<T>	responseDeserializerF(Function<Type,ResponseDeserializer<T>> responseDeserializerFunction)
HttpRequestBuilder<T>	responseDeserializerS(Supplier<ResponseDeserializer<T>> responseDeserializerSupplier)
HttpRequestBuilder<T>	socketTimeOut(int socketTimeOut)
HttpRequestBuilder<T>	sslContext(SSLContext sslContext) Sets SSLContext
HttpRequestBuilder<T>	trustAllCertificates() Accept all certificates
HttpRequestBuilder<T>	trustAllHosts() Accept all hosts
HttpRequestBuilder<T>	useDefaultProxy() Instruct HttpClient to use the standard JRE proxy selector to obtain proxy.

Methods inherited from class java.lang.Object

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

Method Detail

responseDeserializer

public HttpRequestBuilder<T> responseDeserializer(ResponseDeserializer<T> responseDeserializer)

Parameters:

responseDeserializer - deserializer of response. By default DefaultResponseDeserializer

Returns:

HttpRequestBuilder instance

See Also:

ResponseDeserializer

responseDeserializerS

public HttpRequestBuilder<T> responseDeserializerS(Supplier<ResponseDeserializer<T>> responseDeserializerSupplier)

Parameters:

responseDeserializerSupplier - supplier for resolve response deserializer. By default response deserializer is DefaultResponseDeserializer

Returns:

HttpRequestBuilder instance

See Also:

ResponseDeserializer

responseDeserializerF

public HttpRequestBuilder<T> responseDeserializerF(Function<Type,ResponseDeserializer<T>> responseDeserializerFunction)

Parameters:

responseDeserializerFunction - function for resolve response deserializer. By default response deserializer is DefaultResponseDeserializer

Returns:

HttpRequestBuilder instance

See Also:

ResponseDeserializer

dateDeserializeContext

public HttpRequestBuilder<T> dateDeserializeContext(DateDeserializeContext dateDeserializeContext)

Default date patterns to deserialize: for date is 'dd/MM/yyyy', for time is 'HH:mm:ss', for date time is 'dd/MM/yyyy HH:mm:ss'.

You can specify your patterns by add DateDeserializeContext instance

Parameters:

dateDeserializeContext - context to resolve date pattern to deserialize

Returns:

HttpRequestBuilder instance

includeCookies

public HttpRequestBuilder<T> includeCookies(Supplier<String> cookiesSupplier)

If method is called and requestSupplier non null enabled cookies including to request. By default disabled.

Parameters:

cookiesSupplier - supplier instance to cookies.

Returns:

HttpRequestBuilder instance

excludeCookies

public HttpRequestBuilder<T> excludeCookies()

Disable cookies including in request. By default disabled.

Returns:

HttpRequestBuilder instance

connectTimeout

public HttpRequestBuilder<T> connectTimeout(int connectTimeout)

Parameters:

connectTimeout - see documentation of ConnectionConfig.connectTimeout(int)

Returns:

HttpRequestBuilder instance

socketTimeOut

public HttpRequestBuilder<T> socketTimeOut(int socketTimeOut)

Parameters:

socketTimeOut - see documentation of ConnectionConfig.socketTimeOut(int)

Returns:

HttpRequestBuilder instance

connectionRequestTimeout

public HttpRequestBuilder<T> connectionRequestTimeout(int connectionRequestTimeout)

Parameters:

connectionRequestTimeout - see documentation of ConnectionConfig.connectionRequestTimeout(int)

Returns:

HttpRequestBuilder instance

maxPoolSize

public HttpRequestBuilder<T> maxPoolSize(int maxPoolSize)

Parameters:

maxPoolSize - see documentation of ConnectionConfig.maxPoolSize(int)

Returns:

HttpRequestBuilder instance

enableLaxRedirectStrategy

public HttpRequestBuilder<T> enableLaxRedirectStrategy()

By default, only GET requests resulting in a redirect are automatically followed. If a POST requests is answered with either HTTP 301 Moved Permanently or with 302 Found – the redirect is not automatically followed.

If the 301 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.

By default disabled.

Returns:

HttpRequestBuilder instance

See Also:

LaxRedirectStrategy

enableDefaultRedirectStrategy

public HttpRequestBuilder<T> enableDefaultRedirectStrategy()

By default, only GET requests resulting in a redirect are automatically followed. If a POST requests is answered with either HTTP 301 Moved Permanently or with 302 Found – the redirect is not automatically followed.

If the 301 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.

By default disabled.

Returns:

HttpRequestBuilder instance

See Also:

DefaultRedirectStrategy

redirectStrategy

public HttpRequestBuilder<T> redirectStrategy(org.apache.http.client.RedirectStrategy redirectStrategy)

By default disabled.

Parameters:

redirectStrategy - RedirectStrategy instance

Returns:

HttpRequestBuilder instance

See Also:

RedirectStrategy

addDefaultHeader

public HttpRequestBuilder<T> addDefaultHeader(String name,
                                              String value)

Header needs to be the same for all requests

Parameters:

name - name of header. Can't be null

value - value of header

Returns:

HttpRequestBuilder instance

addDefaultHeader

public HttpRequestBuilder<T> addDefaultHeader(org.apache.http.Header header)

Header needs to be the same for all requests

Parameters:

header - header instance

Returns:

HttpRequestBuilder instance

addDefaultHeaders

public HttpRequestBuilder<T> addDefaultHeaders(org.apache.http.Header... headers)

Header needs to be the same for all requests

Parameters:

headers - varargs of headers

Returns:

HttpRequestBuilder instance

addDefaultHeaders

public HttpRequestBuilder<T> addDefaultHeaders(Collection<? extends org.apache.http.Header> headers)

Header needs to be the same for all requests

Parameters:

headers - collections of headers

Returns:

HttpRequestBuilder instance

addContentType

public HttpRequestBuilder<T> addContentType(org.apache.http.entity.ContentType contentType)

Sets content type to header

Parameters:

contentType - content type of request header

Returns:

HttpRequestBuilder instance

connectionConfig

public HttpRequestBuilder<T> connectionConfig(ConnectionConfig connectionConfig)

Configured connection parameters by instance connectionConfig

Note: this instance redefines parameters socketTimeOut, connectTimeout, connectionRequestTimeout and maxPoolPerRoute.

Parameters:

connectionConfig - instance to configure

Returns:

HttpRequestBuilder instance

proxy

public HttpRequestBuilder<T> proxy(org.apache.http.HttpHost proxy)

Added proxy host. By default is null. If has proxy instance method useDefaultProxy() will be ignored

Parameters:

proxy - HttpHost instance to proxy

Returns:

HttpRequestBuilder instance

proxy

public HttpRequestBuilder<T> proxy(URI proxyUri)

Added proxy by proxyUri. By default is null. If has proxy instance method useDefaultProxy() will be ignored.

Parameters:

proxyUri - URI instance to proxy

Returns:

HttpRequestBuilder instance

proxy

public HttpRequestBuilder<T> proxy(String host,
                                   int port)

Parameters:

host - host of proxy

port - port of proxy

Returns:

HttpRequestBuilder instance

useDefaultProxy

public HttpRequestBuilder<T> useDefaultProxy()

Instruct HttpClient to use the standard JRE proxy selector to obtain proxy.

Returns:

HttpRequestBuilder instance

addDefaultRequestParameter

public HttpRequestBuilder<T> addDefaultRequestParameter(String name,
                                                        String value)

Parameter needs to be add for all requests.

Parameters:

name - key

value - value

Returns:

HttpRequestBuilder instance

addDefaultRequestParameter

public HttpRequestBuilder<T> addDefaultRequestParameter(org.apache.http.NameValuePair... nameValues)

Parameters needs to be add for all requests.

Parameters:

nameValues - nameValues

Returns:

HttpRequestBuilder instance

addDefaultRequestParameter

public HttpRequestBuilder<T> addDefaultRequestParameter(Map<String,String> defaultParameters)

Parameters needs to be add for all requests.

Parameters:

defaultParameters - defaultParameters

Returns:

HttpRequestBuilder instance

addDefaultRequestParameter

public HttpRequestBuilder<T> addDefaultRequestParameter(Collection<? extends org.apache.http.NameValuePair> defaultRequestParameters)

Parameters needs to be add for all requests.

Parameters:

defaultRequestParameters - defaultRequestParameters

Returns:

HttpRequestBuilder instance

sslContext

public HttpRequestBuilder<T> sslContext(SSLContext sslContext)

Sets SSLContext

Parameters:

sslContext - SSLContext instance

Returns:

HttpRequestBuilder instance

hostnameVerifier

public HttpRequestBuilder<T> hostnameVerifier(HostnameVerifier hostnameVerifier)

Sets HostnameVerifier

Parameters:

hostnameVerifier - HostnameVerifier instance

Returns:

HttpRequestBuilder instance

trustAllCertificates

public HttpRequestBuilder<T> trustAllCertificates()

Accept all certificates

Returns:

HttpRequestBuilder instance

Throws:

HttpRequestBuildException - when can't build ssl.

trustAllHosts

public HttpRequestBuilder<T> trustAllHosts()

Accept all hosts

Returns:

HttpRequestBuilder instance

basicAuth

public HttpRequestBuilder<T> basicAuth(String username,
                                       String password)

Basic Authentication - sending the Authorization header.

Parameters:

username - username

password - password

Returns:

HttpRequestBuilder instance

addHttpClientCustomizer

public HttpRequestBuilder<T> addHttpClientCustomizer(Consumer<org.apache.http.impl.client.HttpClientBuilder> httpClientCustomizer)

The method takes the Consumer instance which gives the HttpClientBuilder instance to customize the CloseableHttpClient before the http-request is built

Parameters:

httpClientCustomizer - consumer instance

Returns:

HttpRequestBuilder instance

build

public HttpRequest<T> build()

Build Http request

Returns:

HttpRequest instance by build parameters

createPost

public static <T> HttpRequestBuilder<T> createPost(String uri,
                                                   TypeReference<T> typeReference)

Created Builder to build BasicHttpRequest to post request

Type Parameters:

T - Type of expected successful response

Parameters:

uri - uri to request

typeReference - instance to resolve successful response type if type is Generic. Example new TypeReference<java.util.List<String>>(){}

Returns:

Builder instance

createGet

public static <T> HttpRequestBuilder<T> createGet(String uri,
                                                  TypeReference<T> typeReference)

Created Builder to build BasicHttpRequest to get request

Type Parameters:

T - Type of expected successful response

Parameters:

uri - uri to request

typeReference - instance to resolve successful response type if type is Generic. Example new TypeReference<java.util.List<String>>(){}

Returns:

Builder instance

createPost

public static <T> HttpRequestBuilder<T> createPost(String uri,
                                                   Class<T> type)

Created Builder to build BasicHttpRequest to post request

Type Parameters:

T - Type of expected successful response

Parameters:

uri - uri to request

type - Class type to resolve successful response type. Example String.class

Returns:

Builder instance

createGet

public static <T> HttpRequestBuilder<T> createGet(String uri,
                                                  Class<T> type)

Created Builder to build BasicHttpRequest to get request

Type Parameters:

T - Type of expected successful response

Parameters:

uri - uri to request

type - Class type to resolve successful response type. Example String.class

Returns:

Builder instance

createPost

public static HttpRequestBuilder<?> createPost(String uri)

Created Builder to build BasicHttpRequest to post request

Parameters:

uri - uri to request

Returns:

Builder instance by type HttpRequestBuilder<Void>

createGet

public static HttpRequestBuilder<?> createGet(String uri)

Created Builder to build BasicHttpRequest to get request

Parameters:

uri - uri to request

Returns:

Builder instance by type HttpRequestBuilder<Void>

createPost

public static <T> HttpRequestBuilder<T> createPost(URI uri,
                                                   TypeReference<T> typeReference)

Created Builder to build BasicHttpRequest to post request

Type Parameters:

T - Type of expected successful response

Parameters:

uri - URI instance to request

typeReference - instance to resolve successful response type if type is Generic. Example new TypeReference<java.util.List<String>>(){}

Returns:

Builder instance

createGet

public static <T> HttpRequestBuilder<T> createGet(URI uri,
                                                  TypeReference<T> typeReference)

Created Builder to build BasicHttpRequest to get request

Type Parameters:

T - Type of expected successful response

Parameters:

uri - URI instance to request

typeReference - instance to resolve successful response type if type is Generic. Example new TypeReference<java.util.List<String>>(){}

Returns:

Builder instance

createPost

public static <T> HttpRequestBuilder<T> createPost(URI uri,
                                                   Class<T> type)

Created Builder to build BasicHttpRequest to post request

Type Parameters:

T - Type of expected successful response

Parameters:

uri - URI instance to request

type - Class type to resolve successful response type. Example String.class

Returns:

Builder instance

createGet

public static <T> HttpRequestBuilder<T> createGet(URI uri,
                                                  Class<T> type)

Created Builder to build BasicHttpRequest to get request

Type Parameters:

T - Type of expected successful response

Parameters:

uri - URI instance to request

type - Class type to resolve successful response type. Example String.class

Returns:

Builder instance

createPost

public static HttpRequestBuilder<?> createPost(URI uri)

Created Builder to build BasicHttpRequest to post request

Parameters:

uri - URI instance to request

Returns:

Builder instance by type HttpRequestBuilder<Void>

createGet

public static HttpRequestBuilder<?> createGet(URI uri)

Created Builder to build BasicHttpRequest to get request

Parameters:

uri - URI instance to request

Returns:

Builder instance by type HttpRequestBuilder<Void>

create

public static HttpRequestBuilder<?> create(HttpMethod httpMethod,
                                           URI uri)

Created Builder to build BasicHttpRequest to get request

Parameters:

httpMethod - HTTP Method

uri - uri URI instance to request

Returns:

Builder instance by type HttpRequestBuilder<Void>

create

public static <T> HttpRequestBuilder<T> create(HttpMethod httpMethod,
                                               URI uri,
                                               Class<T> type)

Created Builder to build BasicHttpRequest to get request

Type Parameters:

T - Type of expected successful response

Parameters:

httpMethod - HTTP Method

uri - URI instance to request

type - Class type to resolve successful response type. Example String.class

Returns:

Builder instance

create

public static <T> HttpRequestBuilder<T> create(HttpMethod httpMethod,
                                               URI uri,
                                               TypeReference<T> typeReference)

Created Builder to build BasicHttpRequest to get request

Type Parameters:

T - Type of expected successful response

Parameters:

httpMethod - HTTP Method

uri - URI instance to request

typeReference - instance to resolve successful response type if type is Generic. Example new TypeReference<java.util.List<String>>(){}

Returns:

Builder instance

create

public static HttpRequestBuilder<?> create(HttpMethod httpMethod,
                                           String uri)

Created Builder to build BasicHttpRequest to get request

Parameters:

httpMethod - HTTP Method

uri - uri to request

Returns:

Builder instance by type HttpRequestBuilder<Void>

create

public static <T> HttpRequestBuilder<T> create(HttpMethod httpMethod,
                                               String uri,
                                               Class<T> type)

Created Builder to build BasicHttpRequest to get request

Type Parameters:

T - Type of expected successful response

Parameters:

httpMethod - HTTP Method

uri - uri to request

type - Class type to resolve successful response type. Example String.class

Returns:

Builder instance

create

public static <T> HttpRequestBuilder<T> create(HttpMethod httpMethod,
                                               String uri,
                                               TypeReference<T> typeReference)

Created Builder to build BasicHttpRequest to get request

Type Parameters:

T - Type of expected successful response

Parameters:

httpMethod - HTTP Method

uri - uri to request

typeReference - instance to resolve successful response type if type is Generic. Example new TypeReference<java.util.List<String>>(){}

Returns:

Builder instance