Package co.arago.hiro.client.connection.httpclient

Class DefaultHttpClientHandler.Conf<T extends DefaultHttpClientHandler.Conf<T>>

java.lang.Object

co.arago.hiro.client.connection.httpclient.DefaultHttpClientHandler.Conf<T>

All Implemented Interfaces:

HttpClientHandler.ConfTemplate<T>

Direct Known Subclasses:

DefaultHttpClientHandler.Builder

Enclosing class:

DefaultHttpClientHandler

public abstract static class DefaultHttpClientHandler.Conf<T extends DefaultHttpClientHandler.Conf<T>>
extends java.lang.Object
implements HttpClientHandler.ConfTemplate<T>

Constructor Summary

Constructors

Constructor	Description
Conf()

Method Summary

Modifier and Type	Method	Description
abstract HttpClientHandler	build()
java.lang.Boolean	getAcceptAllCerts()
java.lang.Long	getConnectTimeout()
java.net.CookieManager	getCookieManager()
java.net.http.HttpClient	getHttpClient()
java.lang.Boolean	getHttpClientAutoClose()
int	getMaxBinaryLogLength()
int	getMaxConnectionPool()
HttpClientHandler.ProxySpec	getProxy()
long	getShutdownTimeout()
javax.net.ssl.SSLContext	getSslContext()
javax.net.ssl.SSLParameters	getSslParameters()
boolean	isFollowRedirects()
protected abstract T	self()
T	setAcceptAllCerts(java.lang.Boolean acceptAllCerts)	Skip SSL certificate verification.
T	setConnectTimeout(java.lang.Long connectTimeout)
T	setCookieManager(java.net.CookieManager cookieManager)	Instance of an externally configured CookieManager.
T	setFollowRedirects(boolean followRedirects)
T	setHttpClient(java.net.http.HttpClient httpClient)	Instance of an externally configured http client.
T	setHttpClientAutoClose(boolean httpClientAutoClose)	Close internal httpClient automatically, even when it has been set externally.
T	setMaxBinaryLogLength(int maxBinaryLogLength)	Maximum size to log binary data in logfiles.
T	setMaxConnectionPool(int maxConnectionPool)	Set the maximum of open connections for this HttpClient (This sets the fixedThreadPool for the Executor of the HttpClient).
T	setProxy(HttpClientHandler.ProxySpec proxy)
T	setShutdownTimeout(long shutdownTimeout)
T	setSslContext(javax.net.ssl.SSLContext sslContext)
T	setSslParameters(javax.net.ssl.SSLParameters sslParameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

Conf

public Conf()

Method Detail

getProxy

public HttpClientHandler.ProxySpec getProxy()

Specified by:

getProxy in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setProxy

public T setProxy(HttpClientHandler.ProxySpec proxy)

Specified by:

setProxy in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

proxy - Simple proxy with one address and port

Returns:

self()

isFollowRedirects

public boolean isFollowRedirects()

Specified by:

isFollowRedirects in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setFollowRedirects

public T setFollowRedirects(boolean followRedirects)

Specified by:

setFollowRedirects in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

followRedirects - Enable Redirect.NORMAL. Default is true.

Returns:

self()

getConnectTimeout

public java.lang.Long getConnectTimeout()

Specified by:

getConnectTimeout in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setConnectTimeout

public T setConnectTimeout(java.lang.Long connectTimeout)

Specified by:

setConnectTimeout in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

connectTimeout - Connect timeout in milliseconds.

Returns:

self()

getShutdownTimeout

public long getShutdownTimeout()

Specified by:

getShutdownTimeout in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setShutdownTimeout

public T setShutdownTimeout(long shutdownTimeout)

Specified by:

setShutdownTimeout in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

shutdownTimeout - Time to wait in milliseconds for a complete shutdown of the Java 11 HttpClientImpl. If this is set to a value too low, you might need to wait elsewhere for the HttpClient to shut down properly. Default is 3000ms.

Returns:

self()

getAcceptAllCerts

public java.lang.Boolean getAcceptAllCerts()

Specified by:

getAcceptAllCerts in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setAcceptAllCerts

public T setAcceptAllCerts(java.lang.Boolean acceptAllCerts)

Skip SSL certificate verification. Leave this unset to use the default in HttpClient. Setting this to true installs a permissive SSLContext, setting it to false removes the SSLContext to use the default.

Specified by:

setAcceptAllCerts in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

acceptAllCerts - the toggle

Returns:

self()

getSslContext

public javax.net.ssl.SSLContext getSslContext()

Specified by:

getSslContext in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setSslContext

public T setSslContext(javax.net.ssl.SSLContext sslContext)

Specified by:

setSslContext in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

sslContext - The specific SSLContext to use.

Returns:

self()

See Also:

setAcceptAllCerts(Boolean)

getSslParameters

public javax.net.ssl.SSLParameters getSslParameters()

Specified by:

getSslParameters in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setSslParameters

public T setSslParameters(javax.net.ssl.SSLParameters sslParameters)

Specified by:

setSslParameters in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

sslParameters - The specific SSLParameters to use.

Returns:

self()

getHttpClient

public java.net.http.HttpClient getHttpClient()

Specified by:

getHttpClient in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setHttpClient

public T setHttpClient(java.net.http.HttpClient httpClient)

Instance of an externally configured http client. An internal HttpClient will be built with parameters given by this Builder if this is not set.

Specified by:

setHttpClient in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

httpClient - Instance of an HttpClient.

Returns:

self()

Implementation Note:

Be aware, that any httpClient given via this method will be marked as external and has to be closed externally as well. A call to DefaultHttpClientHandler.close() with an external httpclient will have no effect.

getCookieManager

public java.net.CookieManager getCookieManager()

Specified by:

getCookieManager in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setCookieManager

public T setCookieManager(java.net.CookieManager cookieManager)

Instance of an externally configured CookieManager. An internal CookieManager will be built if this is not set.

Specified by:

setCookieManager in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

cookieManager - Instance of a CookieManager.

Returns:

self()

getMaxConnectionPool

public int getMaxConnectionPool()

Specified by:

getMaxConnectionPool in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setMaxConnectionPool

public T setMaxConnectionPool(int maxConnectionPool)

Set the maximum of open connections for this HttpClient (This sets the fixedThreadPool for the Executor of the HttpClient).

Specified by:

setMaxConnectionPool in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

maxConnectionPool - Maximum size of the pool. Default is 8.

Returns:

self()

getMaxBinaryLogLength

public int getMaxBinaryLogLength()

Specified by:

getMaxBinaryLogLength in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setMaxBinaryLogLength

public T setMaxBinaryLogLength(int maxBinaryLogLength)

Maximum size to log binary data in logfiles. Default is 1024.

Specified by:

setMaxBinaryLogLength in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

maxBinaryLogLength - Size in bytes

Returns:

self()

getHttpClientAutoClose

public java.lang.Boolean getHttpClientAutoClose()

Specified by:

getHttpClientAutoClose in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

setHttpClientAutoClose

public T setHttpClientAutoClose(boolean httpClientAutoClose)

Close internal httpClient automatically, even when it has been set externally.

The default is to close the internal httpClient when it has been created internally and to not close the internal httpClient when it has been set via setHttpClient(HttpClient)

Specified by:

setHttpClientAutoClose in interface HttpClientHandler.ConfTemplate<T extends DefaultHttpClientHandler.Conf<T>>

Parameters:

httpClientAutoClose - true: enable, false: disable.

Returns:

self()

self

protected abstract T self()

build

public abstract HttpClientHandler build()