Package org.asynchttpclient

Class DefaultAsyncHttpClientConfig

java.lang.Object

org.asynchttpclient.DefaultAsyncHttpClientConfig

All Implemented Interfaces:

AsyncHttpClientConfig

public class DefaultAsyncHttpClientConfig
extends Object
implements AsyncHttpClientConfig

Configuration class to use with a AsyncHttpClient. System property can be also used to configure this object default behavior by doing:
-Dorg.asynchttpclient.nameOfTheProperty

See Also:

for documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultAsyncHttpClientConfig.Builder	Builder for an AsyncHttpClient

Nested classes/interfaces inherited from interface org.asynchttpclient.AsyncHttpClientConfig

AsyncHttpClientConfig.ResponseBodyPartFactory

Method Summary

Modifier and Type	Method	Description
int	expiredCookieEvictionDelay()	Return the delay in milliseconds to evict expired cookies from CookieStore
int	getAcquireFreeChannelTimeout()	Return the maximum duration in milliseconds an AsyncHttpClient can wait to acquire a free channel
String	getAhcVersion()
@Nullable io.netty.buffer.ByteBufAllocator	getAllocator()
Map<io.netty.channel.ChannelOption<Object>,Object>	getChannelOptions()
@Nullable ChannelPool	getChannelPool()
int	getChunkedFileChunkSize()
Duration	getConnectionPoolCleanerPeriod()
@Nullable ConnectionSemaphoreFactory	getConnectionSemaphoreFactory()
Duration	getConnectionTtl()
Duration	getConnectTimeout()	Return the maximum time an AsyncHttpClient can wait when connecting to a remote host
CookieStore	getCookieStore()	Return cookie store that is used to store and retrieve cookies
@Nullable String[]	getEnabledCipherSuites()
@Nullable String[]	getEnabledProtocols()
@Nullable io.netty.channel.EventLoopGroup	getEventLoopGroup()
int	getHandshakeTimeout()
int	getHashedWheelTimerSize()
long	getHashedWheelTimerTickDuration()
@Nullable Consumer<io.netty.channel.Channel>	getHttpAdditionalChannelInitializer()
int	getHttpClientCodecInitialBufferSize()
int	getHttpClientCodecMaxChunkSize()
int	getHttpClientCodecMaxHeaderSize()
int	getHttpClientCodecMaxInitialLineLength()
List<IOExceptionFilter>	getIoExceptionFilters()	Return the list of IOException
int	getIoThreadsCount()
KeepAliveStrategy	getKeepAliveStrategy()
int	getMaxConnections()	Return the maximum number of connections an AsyncHttpClient can handle.
int	getMaxConnectionsPerHost()	Return the maximum number of connections per hosts an AsyncHttpClient can handle.
int	getMaxRedirects()	Get the maximum number of HTTP redirect
int	getMaxRequestRetry()	Return the number of time the library will retry when an IOException is throw by the remote server
@Nullable io.netty.util.Timer	getNettyTimer()
Duration	getPooledConnectionIdleTimeout()	Return the maximum time an AsyncHttpClient will keep connection in pool.
ProxyServerSelector	getProxyServerSelector()	An instance of ProxyServer used by an AsyncHttpClient
Duration	getReadTimeout()	Return the maximum time an AsyncHttpClient can stay idle.
@Nullable Realm	getRealm()	Return the current Realm
List<RequestFilter>	getRequestFilters()	Return the list of RequestFilter
Duration	getRequestTimeout()	Return the maximum time an AsyncHttpClient waits until the response is completed.
AsyncHttpClientConfig.ResponseBodyPartFactory	getResponseBodyPartFactory()
List<ResponseFilter>	getResponseFilters()	Return the list of ResponseFilter
Duration	getShutdownQuietPeriod()
Duration	getShutdownTimeout()
int	getSoLinger()
int	getSoRcvBuf()
int	getSoSndBuf()
@Nullable io.netty.handler.ssl.SslContext	getSslContext()	Return an instance of SslContext used for SSL connection.
@Nullable SslEngineFactory	getSslEngineFactory()
int	getSslSessionCacheSize()
int	getSslSessionTimeout()
@Nullable ThreadFactory	getThreadFactory()	Return the ThreadFactory an AsyncHttpClient use for handling asynchronous response.
String	getThreadPoolName()	Return the name of AsyncHttpClient, which is used for thread naming and debugging.
String	getUserAgent()	Return the USER_AGENT header value
int	getWebSocketMaxBufferSize()
int	getWebSocketMaxFrameSize()
@Nullable Consumer<io.netty.channel.Channel>	getWsAdditionalChannelInitializer()
boolean	isAggregateWebSocketFrameFragments()
boolean	isCompressionEnforced()	Is HTTP compression enforced.
boolean	isDisableHttpsEndpointIdentificationAlgorithm()
boolean	isDisableUrlEncodingForBoundRequests()
boolean	isDisableZeroCopy()
boolean	isEnableAutomaticDecompression()	If automatic content decompression is enabled.
boolean	isEnableWebSocketCompression()
boolean	isFilterInsecureCipherSuites()
boolean	isFollowRedirect()	Is HTTP redirect enabled
boolean	isKeepAlive()	Is the ChannelPool support enabled.
boolean	isKeepEncodingHeader()
boolean	isSoKeepAlive()
boolean	isSoReuseAddress()
boolean	isStrict302Handling()	In the case of a POST/Redirect/Get scenario where the server uses a 302 for the redirect, should AHC respond to the redirect with a GET or whatever the original method was.
boolean	isTcpNoDelay()
boolean	isUseInsecureTrustManager()
boolean	isUseLaxCookieEncoder()
boolean	isUseNativeTransport()
boolean	isUseOnlyEpollNativeTransport()
boolean	isUseOpenSsl()
boolean	isValidateResponseHeaders()

Methods inherited from class java.lang.Object

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

Method Detail

getAhcVersion

public String getAhcVersion()

Specified by:

getAhcVersion in interface AsyncHttpClientConfig

Returns:

the version of AHC

isFollowRedirect

public boolean isFollowRedirect()

Description copied from interface: AsyncHttpClientConfig

Is HTTP redirect enabled

Specified by:

isFollowRedirect in interface AsyncHttpClientConfig

Returns:

true if enabled.

getMaxRedirects

public int getMaxRedirects()

Description copied from interface: AsyncHttpClientConfig

Get the maximum number of HTTP redirect

Specified by:

getMaxRedirects in interface AsyncHttpClientConfig

Returns:

the maximum number of HTTP redirect

isStrict302Handling

public boolean isStrict302Handling()

Description copied from interface: AsyncHttpClientConfig

In the case of a POST/Redirect/Get scenario where the server uses a 302 for the redirect, should AHC respond to the redirect with a GET or whatever the original method was. Unless configured otherwise, for a 302, AHC, will use a GET for this case.

Specified by:

isStrict302Handling in interface AsyncHttpClientConfig

Returns:

true if strict 302 handling is to be used, otherwise false.

isCompressionEnforced

public boolean isCompressionEnforced()

Description copied from interface: AsyncHttpClientConfig

Is HTTP compression enforced.

Specified by:

isCompressionEnforced in interface AsyncHttpClientConfig

Returns:

true if compression is enforced

isEnableAutomaticDecompression

public boolean isEnableAutomaticDecompression()

Description copied from interface: AsyncHttpClientConfig

If automatic content decompression is enabled.

Specified by:

isEnableAutomaticDecompression in interface AsyncHttpClientConfig

Returns:

true if content decompression is enabled

getUserAgent

public String getUserAgent()

Description copied from interface: AsyncHttpClientConfig

Return the USER_AGENT header value

Specified by:

getUserAgent in interface AsyncHttpClientConfig

Returns:

the USER_AGENT header value

getRealm

@Nullable
public @Nullable Realm getRealm()

Description copied from interface: AsyncHttpClientConfig

Return the current Realm

Specified by:

getRealm in interface AsyncHttpClientConfig

Returns:

the current Realm

getMaxRequestRetry

public int getMaxRequestRetry()

Description copied from interface: AsyncHttpClientConfig

Return the number of time the library will retry when an IOException is throw by the remote server

Specified by:

getMaxRequestRetry in interface AsyncHttpClientConfig

Returns:

the number of time the library will retry when an IOException is throw by the remote server

isDisableUrlEncodingForBoundRequests

public boolean isDisableUrlEncodingForBoundRequests()

Specified by:

isDisableUrlEncodingForBoundRequests in interface AsyncHttpClientConfig

Returns:

the disableUrlEncodingForBoundRequests

isUseLaxCookieEncoder

public boolean isUseLaxCookieEncoder()

Specified by:

isUseLaxCookieEncoder in interface AsyncHttpClientConfig

Returns:

true if AHC is to use a LAX cookie encoder, e.g. accept illegal chars in cookie value

isDisableZeroCopy

public boolean isDisableZeroCopy()

Specified by:

isDisableZeroCopy in interface AsyncHttpClientConfig

isKeepEncodingHeader

public boolean isKeepEncodingHeader()

Specified by:

isKeepEncodingHeader in interface AsyncHttpClientConfig

getProxyServerSelector

public ProxyServerSelector getProxyServerSelector()

Description copied from interface: AsyncHttpClientConfig

An instance of ProxyServer used by an AsyncHttpClient

Specified by:

getProxyServerSelector in interface AsyncHttpClientConfig

Returns:

instance of ProxyServer

isAggregateWebSocketFrameFragments

public boolean isAggregateWebSocketFrameFragments()

Specified by:

isAggregateWebSocketFrameFragments in interface AsyncHttpClientConfig

isEnableWebSocketCompression

public boolean isEnableWebSocketCompression()

Specified by:

isEnableWebSocketCompression in interface AsyncHttpClientConfig

getWebSocketMaxBufferSize

public int getWebSocketMaxBufferSize()

Specified by:

getWebSocketMaxBufferSize in interface AsyncHttpClientConfig

getWebSocketMaxFrameSize

public int getWebSocketMaxFrameSize()

Specified by:

getWebSocketMaxFrameSize in interface AsyncHttpClientConfig

getConnectTimeout

public Duration getConnectTimeout()

Description copied from interface: AsyncHttpClientConfig

Return the maximum time an AsyncHttpClient can wait when connecting to a remote host

Specified by:

getConnectTimeout in interface AsyncHttpClientConfig

Returns:

the maximum time an AsyncHttpClient can wait when connecting to a remote host

getRequestTimeout

public Duration getRequestTimeout()

Description copied from interface: AsyncHttpClientConfig

Return the maximum time an AsyncHttpClient waits until the response is completed.

Specified by:

getRequestTimeout in interface AsyncHttpClientConfig

Returns:

the maximum time an AsyncHttpClient waits until the response is completed.

getReadTimeout

public Duration getReadTimeout()

Description copied from interface: AsyncHttpClientConfig

Return the maximum time an AsyncHttpClient can stay idle.

Specified by:

getReadTimeout in interface AsyncHttpClientConfig

Returns:

the maximum time an AsyncHttpClient can stay idle.

getShutdownQuietPeriod

public Duration getShutdownQuietPeriod()

Specified by:

getShutdownQuietPeriod in interface AsyncHttpClientConfig

getShutdownTimeout

public Duration getShutdownTimeout()

Specified by:

getShutdownTimeout in interface AsyncHttpClientConfig

isKeepAlive

public boolean isKeepAlive()

Description copied from interface: AsyncHttpClientConfig

Is the ChannelPool support enabled.

Specified by:

isKeepAlive in interface AsyncHttpClientConfig

Returns:

true if keep-alive is enabled

getPooledConnectionIdleTimeout

public Duration getPooledConnectionIdleTimeout()

Description copied from interface: AsyncHttpClientConfig

Return the maximum time an AsyncHttpClient will keep connection in pool.

Specified by:

getPooledConnectionIdleTimeout in interface AsyncHttpClientConfig

Returns:

the maximum time an AsyncHttpClient will keep connection in pool.

getConnectionPoolCleanerPeriod

public Duration getConnectionPoolCleanerPeriod()

Specified by:

getConnectionPoolCleanerPeriod in interface AsyncHttpClientConfig

Returns:

the period to clean the pool of dead and idle connections.

getConnectionTtl

public Duration getConnectionTtl()

Specified by:

getConnectionTtl in interface AsyncHttpClientConfig

Returns:

the maximum time an AsyncHttpClient will keep connection in the pool, or negative value to keep connection while possible.

getMaxConnections

public int getMaxConnections()

Description copied from interface: AsyncHttpClientConfig

Return the maximum number of connections an AsyncHttpClient can handle.

Specified by:

getMaxConnections in interface AsyncHttpClientConfig

Returns:

the maximum number of connections an AsyncHttpClient can handle.

getMaxConnectionsPerHost

public int getMaxConnectionsPerHost()

Description copied from interface: AsyncHttpClientConfig

Return the maximum number of connections per hosts an AsyncHttpClient can handle.

Specified by:

getMaxConnectionsPerHost in interface AsyncHttpClientConfig

Returns:

the maximum number of connections per host an AsyncHttpClient can handle.

getAcquireFreeChannelTimeout

public int getAcquireFreeChannelTimeout()

Description copied from interface: AsyncHttpClientConfig

Return the maximum duration in milliseconds an AsyncHttpClient can wait to acquire a free channel

Specified by:

getAcquireFreeChannelTimeout in interface AsyncHttpClientConfig

Returns:

Return the maximum duration in milliseconds an AsyncHttpClient can wait to acquire a free channel

getChannelPool

@Nullable
public @Nullable ChannelPool getChannelPool()

Specified by:

getChannelPool in interface AsyncHttpClientConfig

getConnectionSemaphoreFactory

@Nullable
public @Nullable ConnectionSemaphoreFactory getConnectionSemaphoreFactory()

Specified by:

getConnectionSemaphoreFactory in interface AsyncHttpClientConfig

getKeepAliveStrategy

public KeepAliveStrategy getKeepAliveStrategy()

Specified by:

getKeepAliveStrategy in interface AsyncHttpClientConfig

isValidateResponseHeaders

public boolean isValidateResponseHeaders()

Specified by:

isValidateResponseHeaders in interface AsyncHttpClientConfig

isUseOpenSsl

public boolean isUseOpenSsl()

Specified by:

isUseOpenSsl in interface AsyncHttpClientConfig

isUseInsecureTrustManager

public boolean isUseInsecureTrustManager()

Specified by:

isUseInsecureTrustManager in interface AsyncHttpClientConfig

isDisableHttpsEndpointIdentificationAlgorithm

public boolean isDisableHttpsEndpointIdentificationAlgorithm()

Specified by:

isDisableHttpsEndpointIdentificationAlgorithm in interface AsyncHttpClientConfig

Returns:

true to disable all HTTPS behaviors AT ONCE, such as hostname verification and SNI

getHandshakeTimeout

public int getHandshakeTimeout()

Specified by:

getHandshakeTimeout in interface AsyncHttpClientConfig

getEnabledProtocols

@Nullable
public @Nullable String[] getEnabledProtocols()

Specified by:

getEnabledProtocols in interface AsyncHttpClientConfig

Returns:

the array of enabled protocols

getEnabledCipherSuites

@Nullable
public @Nullable String[] getEnabledCipherSuites()

Specified by:

getEnabledCipherSuites in interface AsyncHttpClientConfig

Returns:

the array of enabled cipher suites

isFilterInsecureCipherSuites

public boolean isFilterInsecureCipherSuites()

Specified by:

isFilterInsecureCipherSuites in interface AsyncHttpClientConfig

Returns:

if insecure cipher suites must be filtered out (only used when not explicitly passing enabled cipher suites)

getSslSessionCacheSize

public int getSslSessionCacheSize()

Specified by:

getSslSessionCacheSize in interface AsyncHttpClientConfig

Returns:

the size of the SSL session cache, 0 means using the default value

getSslSessionTimeout

public int getSslSessionTimeout()

Specified by:

getSslSessionTimeout in interface AsyncHttpClientConfig

Returns:

the SSL session timeout in seconds, 0 means using the default value

getSslContext

@Nullable
public @Nullable io.netty.handler.ssl.SslContext getSslContext()

Description copied from interface: AsyncHttpClientConfig

Return an instance of SslContext used for SSL connection.

Specified by:

getSslContext in interface AsyncHttpClientConfig

Returns:

an instance of SslContext used for SSL connection.

getSslEngineFactory

@Nullable
public @Nullable SslEngineFactory getSslEngineFactory()

Specified by:

getSslEngineFactory in interface AsyncHttpClientConfig

getRequestFilters

public List<RequestFilter> getRequestFilters()

Description copied from interface: AsyncHttpClientConfig

Return the list of RequestFilter

Specified by:

getRequestFilters in interface AsyncHttpClientConfig

Returns:

Unmodifiable list of RequestFilter

getResponseFilters

public List<ResponseFilter> getResponseFilters()

Description copied from interface: AsyncHttpClientConfig

Return the list of ResponseFilter

Specified by:

getResponseFilters in interface AsyncHttpClientConfig

Returns:

Unmodifiable list of ResponseFilter

getIoExceptionFilters

public List<IOExceptionFilter> getIoExceptionFilters()

Description copied from interface: AsyncHttpClientConfig

Return the list of IOException

Specified by:

getIoExceptionFilters in interface AsyncHttpClientConfig

Returns:

Unmodifiable list of IOException

getCookieStore

public CookieStore getCookieStore()

Description copied from interface: AsyncHttpClientConfig

Return cookie store that is used to store and retrieve cookies

Specified by:

getCookieStore in interface AsyncHttpClientConfig

Returns:

CookieStore object

expiredCookieEvictionDelay

public int expiredCookieEvictionDelay()

Description copied from interface: AsyncHttpClientConfig

Return the delay in milliseconds to evict expired cookies from CookieStore

Specified by:

expiredCookieEvictionDelay in interface AsyncHttpClientConfig

Returns:

the delay in milliseconds to evict expired cookies from CookieStore

isTcpNoDelay

public boolean isTcpNoDelay()

Specified by:

isTcpNoDelay in interface AsyncHttpClientConfig

isSoReuseAddress

public boolean isSoReuseAddress()

Specified by:

isSoReuseAddress in interface AsyncHttpClientConfig

isSoKeepAlive

public boolean isSoKeepAlive()

Specified by:

isSoKeepAlive in interface AsyncHttpClientConfig

getSoLinger

public int getSoLinger()

Specified by:

getSoLinger in interface AsyncHttpClientConfig

getSoSndBuf

public int getSoSndBuf()

Specified by:

getSoSndBuf in interface AsyncHttpClientConfig

getSoRcvBuf

public int getSoRcvBuf()

Specified by:

getSoRcvBuf in interface AsyncHttpClientConfig

getThreadPoolName

public String getThreadPoolName()

Description copied from interface: AsyncHttpClientConfig

Return the name of AsyncHttpClient, which is used for thread naming and debugging.

Specified by:

getThreadPoolName in interface AsyncHttpClientConfig

Returns:

the name.

getHttpClientCodecMaxInitialLineLength

public int getHttpClientCodecMaxInitialLineLength()

Specified by:

getHttpClientCodecMaxInitialLineLength in interface AsyncHttpClientConfig

getHttpClientCodecMaxHeaderSize

public int getHttpClientCodecMaxHeaderSize()

Specified by:

getHttpClientCodecMaxHeaderSize in interface AsyncHttpClientConfig

getHttpClientCodecMaxChunkSize

public int getHttpClientCodecMaxChunkSize()

Specified by:

getHttpClientCodecMaxChunkSize in interface AsyncHttpClientConfig

getHttpClientCodecInitialBufferSize

public int getHttpClientCodecInitialBufferSize()

Specified by:

getHttpClientCodecInitialBufferSize in interface AsyncHttpClientConfig

getChunkedFileChunkSize

public int getChunkedFileChunkSize()

Specified by:

getChunkedFileChunkSize in interface AsyncHttpClientConfig

getChannelOptions

public Map<io.netty.channel.ChannelOption<Object>,Object> getChannelOptions()

Specified by:

getChannelOptions in interface AsyncHttpClientConfig

getEventLoopGroup

@Nullable
public @Nullable io.netty.channel.EventLoopGroup getEventLoopGroup()

Specified by:

getEventLoopGroup in interface AsyncHttpClientConfig

isUseNativeTransport

public boolean isUseNativeTransport()

Specified by:

isUseNativeTransport in interface AsyncHttpClientConfig

isUseOnlyEpollNativeTransport

public boolean isUseOnlyEpollNativeTransport()

Specified by:

isUseOnlyEpollNativeTransport in interface AsyncHttpClientConfig

getAllocator

@Nullable
public @Nullable io.netty.buffer.ByteBufAllocator getAllocator()

Specified by:

getAllocator in interface AsyncHttpClientConfig

getNettyTimer

@Nullable
public @Nullable io.netty.util.Timer getNettyTimer()

Specified by:

getNettyTimer in interface AsyncHttpClientConfig

getHashedWheelTimerTickDuration

public long getHashedWheelTimerTickDuration()

Specified by:

getHashedWheelTimerTickDuration in interface AsyncHttpClientConfig

Returns:

the duration between tick of HashedWheelTimer

getHashedWheelTimerSize

public int getHashedWheelTimerSize()

Specified by:

getHashedWheelTimerSize in interface AsyncHttpClientConfig

Returns:

the size of the hashed wheel HashedWheelTimer

getThreadFactory

@Nullable
public @Nullable ThreadFactory getThreadFactory()

Description copied from interface: AsyncHttpClientConfig

Return the ThreadFactory an AsyncHttpClient use for handling asynchronous response.

Specified by:

getThreadFactory in interface AsyncHttpClientConfig

Returns:

the ThreadFactory an AsyncHttpClient use for handling asynchronous response. If no ThreadFactory has been explicitly provided, this method will return null

getHttpAdditionalChannelInitializer

@Nullable
public @Nullable Consumer<io.netty.channel.Channel> getHttpAdditionalChannelInitializer()

Specified by:

getHttpAdditionalChannelInitializer in interface AsyncHttpClientConfig

getWsAdditionalChannelInitializer

@Nullable
public @Nullable Consumer<io.netty.channel.Channel> getWsAdditionalChannelInitializer()

Specified by:

getWsAdditionalChannelInitializer in interface AsyncHttpClientConfig

getResponseBodyPartFactory

public AsyncHttpClientConfig.ResponseBodyPartFactory getResponseBodyPartFactory()

Specified by:

getResponseBodyPartFactory in interface AsyncHttpClientConfig

getIoThreadsCount

public int getIoThreadsCount()

Specified by:

getIoThreadsCount in interface AsyncHttpClientConfig