DefaultAsyncHttpClientConfig (Asynchronous Http Client 2.0.27 API)

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 and Description

static class DefaultAsyncHttpClientConfig.Builder
Builder for an AsyncHttpClient
- Nested classes/interfaces inherited from interface org.asynchttpclient.AsyncHttpClientConfig
  AsyncHttpClientConfig.AdditionalChannelInitializer, AsyncHttpClientConfig.ResponseBodyPartFactory

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAhcVersion()`
`io.netty.buffer.ByteBufAllocator`	`getAllocator()`
`Map<ChannelOption<Object>,Object>`	`getChannelOptions()`
`ChannelPool`	`getChannelPool()`
`int`	`getChunkedFileChunkSize()`
`int`	`getConnectionPoolCleanerPeriod()`
`int`	`getConnectionTtl()` Return the maximum time in millisecond an `AsyncHttpClient` will keep connection in the pool, or -1 to keep connection while possible.
`int`	`getConnectTimeout()` Return the maximum time in millisecond an `AsyncHttpClient` can wait when connecting to a remote host
`String[]`	`getEnabledCipherSuites()`
`String[]`	`getEnabledProtocols()`
`EventLoopGroup`	`getEventLoopGroup()`
`int`	`getHandshakeTimeout()`
`AsyncHttpClientConfig.AdditionalChannelInitializer`	`getHttpAdditionalChannelInitializer()`
`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
`Timer`	`getNettyTimer()`
`int`	`getPooledConnectionIdleTimeout()` Return the maximum time in millisecond an `AsyncHttpClient` will keep connection in pool.
`ProxyServerSelector`	`getProxyServerSelector()` An instance of `ProxyServer` used by an `AsyncHttpClient`
`int`	`getReadTimeout()` Return the maximum time in millisecond an `AsyncHttpClient` can stay idle.
`Realm`	`getRealm()` Return the current `Realm`
`List<RequestFilter>`	`getRequestFilters()` Return the list of `RequestFilter`
`int`	`getRequestTimeout()` Return the maximum time in millisecond an `AsyncHttpClient` waits until the response is completed.
`AsyncHttpClientConfig.ResponseBodyPartFactory`	`getResponseBodyPartFactory()`
`List<ResponseFilter>`	`getResponseFilters()` Return the list of `ResponseFilter`
`int`	`getShutdownQuietPeriod()`
`int`	`getShutdownTimeout()`
`int`	`getSoLinger()`
`int`	`getSoRcvBuf()`
`int`	`getSoSndBuf()`
`io.netty.handler.ssl.SslContext`	`getSslContext()` Return an instance of `SslContext` used for SSL connection.
`SslEngineFactory`	`getSslEngineFactory()`
`int`	`getSslSessionCacheSize()`
`int`	`getSslSessionTimeout()`
`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()`
`AsyncHttpClientConfig.AdditionalChannelInitializer`	`getWsAdditionalChannelInitializer()`
`boolean`	`isAcceptAnyCertificate()`
`boolean`	`isCompressionEnforced()` Is HTTP compression enforced.
`boolean`	`isDisableUrlEncodingForBoundRequests()`
`boolean`	`isDisableZeroCopy()`
`boolean`	`isFollowRedirect()` Is HTTP redirect enabled
`boolean`	`isKeepAlive()` Is the `ChannelPool` support enabled.
`boolean`	`isKeepEncodingHeader()`
`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`	`isUseNativeTransport()`
`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
  - 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
```
public 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
  - 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
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Description copied from interface: AsyncHttpClientConfig
    
    Return the maximum time in millisecond an AsyncHttpClient can wait when connecting to a remote host
    
    Specified by:
    
    getConnectTimeout in interface AsyncHttpClientConfig
    
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient can wait when connecting to a remote host
  - getRequestTimeout
```
public int getRequestTimeout()
```
    Description copied from interface: AsyncHttpClientConfig
    
    Return the maximum time in millisecond an AsyncHttpClient waits until the response is completed.
    
    Specified by:
    
    getRequestTimeout in interface AsyncHttpClientConfig
    
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient waits until the response is completed.
  - getReadTimeout
```
public int getReadTimeout()
```
    Description copied from interface: AsyncHttpClientConfig
    
    Return the maximum time in millisecond an AsyncHttpClient can stay idle.
    
    Specified by:
    
    getReadTimeout in interface AsyncHttpClientConfig
    
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient can stay idle.
  - getShutdownQuietPeriod
```
public int getShutdownQuietPeriod()
```
    Specified by:
    
    getShutdownQuietPeriod in interface AsyncHttpClientConfig
  - getShutdownTimeout
```
public int 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 int getPooledConnectionIdleTimeout()
```
    Description copied from interface: AsyncHttpClientConfig
    
    Return the maximum time in millisecond an AsyncHttpClient will keep connection in pool.
    
    Specified by:
    
    getPooledConnectionIdleTimeout in interface AsyncHttpClientConfig
    
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient will keep connection in pool.
  - getConnectionPoolCleanerPeriod
```
public int getConnectionPoolCleanerPeriod()
```
    Specified by:
    
    getConnectionPoolCleanerPeriod in interface AsyncHttpClientConfig
    
    Returns:
    
    the period in millis to clean the pool of dead and idle connections.
  - getConnectionTtl
```
public int getConnectionTtl()
```
    Description copied from interface: AsyncHttpClientConfig
    
    Return the maximum time in millisecond an AsyncHttpClient will keep connection in the pool, or -1 to keep connection while possible.
    
    Specified by:
    
    getConnectionTtl in interface AsyncHttpClientConfig
    
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient will keep connection in the pool, or -1 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.
  - getChannelPool
```
public ChannelPool getChannelPool()
```
    Specified by:
    
    getChannelPool 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
  - isAcceptAnyCertificate
```
public boolean isAcceptAnyCertificate()
```
    Specified by:
    
    isAcceptAnyCertificate in interface AsyncHttpClientConfig
  - getHandshakeTimeout
```
public int getHandshakeTimeout()
```
    Specified by:
    
    getHandshakeTimeout in interface AsyncHttpClientConfig
  - getEnabledProtocols
```
public String[] getEnabledProtocols()
```
    Specified by:
    
    getEnabledProtocols in interface AsyncHttpClientConfig
    
    Returns:
    
    the array of enabled protocols
  - getEnabledCipherSuites
```
public String[] getEnabledCipherSuites()
```
    Specified by:
    
    getEnabledCipherSuites in interface AsyncHttpClientConfig
    
    Returns:
    
    the array of 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
```
public 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
```
public 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 ResponseFilter
  - 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
  - isTcpNoDelay
```
public boolean isTcpNoDelay()
```
    Specified by:
    
    isTcpNoDelay in interface AsyncHttpClientConfig
  - isSoReuseAddress
```
public boolean isSoReuseAddress()
```
    Specified by:
    
    isSoReuseAddress 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
  - getChunkedFileChunkSize
```
public int getChunkedFileChunkSize()
```
    Specified by:
    
    getChunkedFileChunkSize in interface AsyncHttpClientConfig
  - getWebSocketMaxBufferSize
```
public int getWebSocketMaxBufferSize()
```
    Specified by:
    
    getWebSocketMaxBufferSize in interface AsyncHttpClientConfig
  - getWebSocketMaxFrameSize
```
public int getWebSocketMaxFrameSize()
```
    Specified by:
    
    getWebSocketMaxFrameSize in interface AsyncHttpClientConfig
  - getChannelOptions
```
public Map<ChannelOption<Object>,Object> getChannelOptions()
```
    Specified by:
    
    getChannelOptions in interface AsyncHttpClientConfig
  - getEventLoopGroup
```
public EventLoopGroup getEventLoopGroup()
```
    Specified by:
    
    getEventLoopGroup in interface AsyncHttpClientConfig
  - isUseNativeTransport
```
public boolean isUseNativeTransport()
```
    Specified by:
    
    isUseNativeTransport in interface AsyncHttpClientConfig
  - getAllocator
```
public io.netty.buffer.ByteBufAllocator getAllocator()
```
    Specified by:
    
    getAllocator in interface AsyncHttpClientConfig
  - getNettyTimer
```
public Timer getNettyTimer()
```
    Specified by:
    
    getNettyTimer in interface AsyncHttpClientConfig
  - getThreadFactory
```
public 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
```
public AsyncHttpClientConfig.AdditionalChannelInitializer getHttpAdditionalChannelInitializer()
```
    Specified by:
    
    getHttpAdditionalChannelInitializer in interface AsyncHttpClientConfig
  - getWsAdditionalChannelInitializer
```
public AsyncHttpClientConfig.AdditionalChannelInitializer 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

Class DefaultAsyncHttpClientConfig

Nested Class Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAhcVersion

isFollowRedirect

getMaxRedirects

isStrict302Handling

isCompressionEnforced

getUserAgent

getRealm

getMaxRequestRetry

isDisableUrlEncodingForBoundRequests

isDisableZeroCopy

isKeepEncodingHeader

getProxyServerSelector

getConnectTimeout

getRequestTimeout

getReadTimeout

getShutdownQuietPeriod

getShutdownTimeout

isKeepAlive

getPooledConnectionIdleTimeout

getConnectionPoolCleanerPeriod

getConnectionTtl

getMaxConnections

getMaxConnectionsPerHost

getChannelPool

getKeepAliveStrategy

isValidateResponseHeaders

isUseOpenSsl

isAcceptAnyCertificate

getHandshakeTimeout

getEnabledProtocols

getEnabledCipherSuites

getSslSessionCacheSize

getSslSessionTimeout

getSslContext

getSslEngineFactory

getRequestFilters

getResponseFilters

getIoExceptionFilters

isTcpNoDelay

isSoReuseAddress

getSoLinger

getSoSndBuf

getSoRcvBuf

getThreadPoolName

getHttpClientCodecMaxInitialLineLength

getHttpClientCodecMaxHeaderSize

getHttpClientCodecMaxChunkSize

getChunkedFileChunkSize

getWebSocketMaxBufferSize

getWebSocketMaxFrameSize

getChannelOptions

getEventLoopGroup

isUseNativeTransport

getAllocator

getNettyTimer

getThreadFactory

getHttpAdditionalChannelInitializer

getWsAdditionalChannelInitializer

getResponseBodyPartFactory

getIoThreadsCount