com.jsunsoft.http

Class ClientBuilder

java.lang.Object

com.jsunsoft.http.ClientBuilder

public class ClientBuilder
extends Object

Builder for CloseableHttpClient.

HttpClients are heavy-weight objects that manage the client-side communication infrastructure. Initialization as well as disposal of a CloseableHttpClient instance may be a rather expensive operation. It is therefore advised to construct only a small number of CloseableHttpClient instances in the application.

Method Summary

Modifier and Type	Method and Description
ClientBuilder	addContentType(org.apache.hc.core5.http.ContentType contentType) Sets content type to header
ClientBuilder	addDefaultConnectionConfigCustomizer(Consumer<org.apache.hc.client5.http.config.ConnectionConfig.Builder> defaultConnectionConfigBuilderConsumer)
ClientBuilder	addDefaultHeader(org.apache.hc.core5.http.Header header) Header needs to be the same for all requests which go through the built CloseableHttpClient
ClientBuilder	addDefaultHeader(String name, String value) Header needs to be the same for all requests which go through the built CloseableHttpClient
ClientBuilder	addDefaultHeaders(Collection<? extends org.apache.hc.core5.http.Header> headers) Headers need to be the same for all requests which go through the built CloseableHttpClient
ClientBuilder	addDefaultHeaders(org.apache.hc.core5.http.Header... headers) Headers need to be the same for all requests which go through the built CloseableHttpClient
ClientBuilder	addDefaultRequestConfigCustomizer(Consumer<org.apache.hc.client5.http.config.RequestConfig.Builder> defaultRequestConfigBuilderConsumer)
ClientBuilder	addHttpClientCustomizer(Consumer<org.apache.hc.client5.http.impl.classic.HttpClientBuilder> httpClientCustomizer) The method takes the Consumer instance which gives the HttpClientBuilder instance to customize the CloseableHttpClient before the http-request is built
org.apache.hc.client5.http.impl.classic.CloseableHttpClient	build() Build CloseableHttpClient
static ClientBuilder	create()
ClientBuilder	enableDefaultRedirectStrategy()
ClientBuilder	hostnameVerifier(HostnameVerifier hostnameVerifier) Sets HostnameVerifier
ClientBuilder	proxy(org.apache.hc.core5.http.HttpHost proxy) Added proxy host.
ClientBuilder	proxy(String host, int port)
ClientBuilder	proxy(URI proxyUri) Added proxy by proxyUri.
ClientBuilder	redirectStrategy(org.apache.hc.client5.http.protocol.RedirectStrategy redirectStrategy) By default disabled.
ClientBuilder	setConnectionRequestTimeout(int connectionRequestTimeout)
ClientBuilder	setConnectionRequestTimeout(org.apache.hc.core5.util.Timeout connectionRequestTimeout) The timeout in milliseconds used when requesting a connection from the connection manager.
ClientBuilder	setConnectTimeout(int connectTimeout)
ClientBuilder	setConnectTimeout(org.apache.hc.core5.util.Timeout connectTimeout) Determines the timeout in milliseconds until a connection is established.
ClientBuilder	setDefaultMaxPoolSizePerRoute(int defaultMaxPoolSizePerRoute)
ClientBuilder	setMaxPoolSize(int maxPoolSize)
ClientBuilder	setMaxPoolSizePerRoute(org.apache.hc.core5.http.HttpHost httpHost, int maxRoutePoolSize) Set the connection pool default max size of concurrent connections to a specific route
ClientBuilder	setResponseTimeout(int responseTimeout)
ClientBuilder	setResponseTimeout(org.apache.hc.core5.util.Timeout responseTimeout) Determines the timeout until arrival of a response from the opposite endpoint.
ClientBuilder	setSocketTimeout(int socketTimeOutMillis)
ClientBuilder	setSocketTimeout(org.apache.hc.core5.util.Timeout socketTimeOut) Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets.
ClientBuilder	sslContext(SSLContext sslContext) Sets SSLContext
ClientBuilder	trustAllCertificates() Accept all certificates
ClientBuilder	trustAllHosts() Accept all hosts
ClientBuilder	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

setConnectTimeout

public ClientBuilder setConnectTimeout(org.apache.hc.core5.util.Timeout connectTimeout)

Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).

Default: 10 seconds

Note: Can be overridden by addDefaultConnectionConfigCustomizer(java.util.function.Consumer<org.apache.hc.client5.http.config.ConnectionConfig.Builder>)

Parameters:

connectTimeout - The Connection Timeout (http.connection.timeout) – the time to establish the connection with the remote host.

Returns:

ClientBuilder instance

See Also:

ConnectionConfig.Builder#setConnectTimeout(Timeout)

setConnectTimeout

public ClientBuilder setConnectTimeout(int connectTimeout)

See Also:

setConnectTimeout(Timeout)

setResponseTimeout

public ClientBuilder setResponseTimeout(org.apache.hc.core5.util.Timeout responseTimeout)

Determines the timeout until arrival of a response from the opposite endpoint.

A timeout value of zero is interpreted as an infinite timeout.

Please note that response timeout may be unsupported by HTTP transports with message multiplexing.

Default: 30 seconds

Note: Can be overridden by addDefaultRequestConfigCustomizer(java.util.function.Consumer<org.apache.hc.client5.http.config.RequestConfig.Builder>)

Parameters:

responseTimeout - The timeout waiting for data – after the connection was established.

Returns:

ClientBuilder instance

See Also:

RequestConfig.Builder#setResponseTimeout(Timeout)

setResponseTimeout

public ClientBuilder setResponseTimeout(int responseTimeout)

See Also:

setResponseTimeout(Timeout)

setConnectionRequestTimeout

public ClientBuilder setConnectionRequestTimeout(org.apache.hc.core5.util.Timeout connectionRequestTimeout)

The timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).

Default: 30 seconds

Note: Can be overridden by addDefaultRequestConfigCustomizer(java.util.function.Consumer<org.apache.hc.client5.http.config.RequestConfig.Builder>)

Parameters:

connectionRequestTimeout - The Connection Manager Timeout (http.connection-manager.timeout) – the time to wait for a connection from the connection manager/pool.

Returns:

ClientBuilder instance

See Also:

RequestConfig.Builder#setConnectionRequestTimeout, addDefaultRequestConfigCustomizer(java.util.function.Consumer<org.apache.hc.client5.http.config.RequestConfig.Builder>)

setConnectionRequestTimeout

public ClientBuilder setConnectionRequestTimeout(int connectionRequestTimeout)

See Also:

setConnectionRequestTimeout(org.apache.hc.core5.util.Timeout)

addDefaultRequestConfigCustomizer

public ClientBuilder addDefaultRequestConfigCustomizer(Consumer<org.apache.hc.client5.http.config.RequestConfig.Builder> defaultRequestConfigBuilderConsumer)

Parameters:

defaultRequestConfigBuilderConsumer - the consumer instance which provides RequestConfig.Builder to customize default request config

Returns:

ClientBuilder instance

setSocketTimeout

public ClientBuilder setSocketTimeout(org.apache.hc.core5.util.Timeout socketTimeOut)

Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).

Default: 30000ms

Note: Can be overridden by addDefaultConnectionConfigCustomizer(Consumer)

Parameters:

socketTimeOut - The Socket Timeout (http.socket.timeout) – the time waiting for data – after the connection was established; maximum time of inactivity between two data packets.

Returns:

ClientBuilder instance

See Also:

ConnectionConfig.Builder#setSocketTimeout, addDefaultConnectionConfigCustomizer(Consumer)

setSocketTimeout

public ClientBuilder setSocketTimeout(int socketTimeOutMillis)

See Also:

setSocketTimeout(org.apache.hc.core5.util.Timeout)

addDefaultConnectionConfigCustomizer

public ClientBuilder addDefaultConnectionConfigCustomizer(Consumer<org.apache.hc.client5.http.config.ConnectionConfig.Builder> defaultConnectionConfigBuilderConsumer)

Parameters:

defaultConnectionConfigBuilderConsumer - the consumer instance which provides ConnectionConfig.Builder to customize default request config

Returns:

ClientBuilder instance

addHttpClientCustomizer

public ClientBuilder addHttpClientCustomizer(Consumer<org.apache.hc.client5.http.impl.classic.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:

ClientBuilder instance

setMaxPoolSize

public ClientBuilder setMaxPoolSize(int maxPoolSize)

Parameters:

maxPoolSize - see documentation of HostPoolConfig.setMaxPoolSize(int)

Returns:

ClientBuilder instance

setDefaultMaxPoolSizePerRoute

public ClientBuilder setDefaultMaxPoolSizePerRoute(int defaultMaxPoolSizePerRoute)

Parameters:

defaultMaxPoolSizePerRoute - see documentation of HostPoolConfig.setDefaultMaxPoolSizePerRoute(int)

Returns:

ClientBuilder instance

setMaxPoolSizePerRoute

public ClientBuilder setMaxPoolSizePerRoute(org.apache.hc.core5.http.HttpHost httpHost,
                                            int maxRoutePoolSize)

Set the connection pool default max size of concurrent connections to a specific route

Parameters:

httpHost - httpHost

maxRoutePoolSize - maxRoutePoolSize

Returns:

ClientBuilder instance

enableDefaultRedirectStrategy

public ClientBuilder enableDefaultRedirectStrategy()

Returns:

ClientBuilder instance

See Also:

DefaultRedirectStrategy

redirectStrategy

public ClientBuilder redirectStrategy(org.apache.hc.client5.http.protocol.RedirectStrategy redirectStrategy)

By default disabled.

Parameters:

redirectStrategy - RedirectStrategy instance

Returns:

ClientBuilder instance

See Also:

RedirectStrategy

addDefaultHeader

public ClientBuilder addDefaultHeader(String name,
                                      String value)

Header needs to be the same for all requests which go through the built CloseableHttpClient

Parameters:

name - name of header. Can't be null

value - value of header

Returns:

ClientBuilder instance

addDefaultHeader

public ClientBuilder addDefaultHeader(org.apache.hc.core5.http.Header header)

Header needs to be the same for all requests which go through the built CloseableHttpClient

Parameters:

header - header instance. Can't be null

Returns:

ClientBuilder instance

addDefaultHeaders

public ClientBuilder addDefaultHeaders(org.apache.hc.core5.http.Header... headers)

Headers need to be the same for all requests which go through the built CloseableHttpClient

Parameters:

headers - varargs of headers. Can't be null

Returns:

ClientBuilder instance

addDefaultHeaders

public ClientBuilder addDefaultHeaders(Collection<? extends org.apache.hc.core5.http.Header> headers)

Headers need to be the same for all requests which go through the built CloseableHttpClient

Parameters:

headers - collections of headers

Returns:

ClientBuilder instance

addContentType

public ClientBuilder addContentType(org.apache.hc.core5.http.ContentType contentType)

Sets content type to header

Parameters:

contentType - content type of request header

Returns:

ClientBuilder instance

proxy

public ClientBuilder proxy(org.apache.hc.core5.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:

ClientBuilder instance

proxy

public ClientBuilder 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:

ClientBuilder instance

proxy

public ClientBuilder proxy(String host,
                           int port)

Parameters:

host - host of proxy

port - port of proxy

Returns:

ClientBuilder instance

useDefaultProxy

public ClientBuilder useDefaultProxy()

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

Returns:

ClientBuilder instance

sslContext

public ClientBuilder sslContext(SSLContext sslContext)

Sets SSLContext

Parameters:

sslContext - SSLContext instance

Returns:

ClientBuilder instance

hostnameVerifier

public ClientBuilder hostnameVerifier(HostnameVerifier hostnameVerifier)

Sets HostnameVerifier

Parameters:

hostnameVerifier - HostnameVerifier instance

Returns:

ClientBuilder instance

trustAllCertificates

public ClientBuilder trustAllCertificates()

Accept all certificates

Returns:

ClientBuilder instance

Throws:

HttpRequestBuildException - when can't build ssl.

trustAllHosts

public ClientBuilder trustAllHosts()

Accept all hosts

Returns:

ClientBuilder instance

build

public org.apache.hc.client5.http.impl.classic.CloseableHttpClient build()

Build CloseableHttpClient

Returns:

CloseableHttpClient instance by build parameters

create

public static ClientBuilder create()