AsyncHttpClientConfig (Asynchronous Http Client 2.0.0 API)

All Known Implementing Classes:

DefaultAsyncHttpClientConfig
```
public interface AsyncHttpClientConfig
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`AsyncHttpClientConfig.AdditionalChannelInitializer`
`static class`	`AsyncHttpClientConfig.ResponseBodyPartFactory`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getAhcVersion()`
`Map<ChannelOption<Object>,Object>`	`getChannelOptions()`
`ChannelPool`	`getChannelPool()`
`int`	`getChunkedFileChunkSize()`
`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`
`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
`io.netty.util.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`	`isUsePooledMemory()`
`boolean`	`isValidateResponseHeaders()`

- Method Detail
  - getAhcVersion
```
String getAhcVersion()
```
    Returns:
    
    the version of AHC
  - getThreadPoolName
```
String getThreadPoolName()
```
    Return the name of AsyncHttpClient, which is used for thread naming and debugging.
    
    Returns:
    
    the name.
  - getMaxConnections
```
int getMaxConnections()
```
    Return the maximum number of connections an AsyncHttpClient can handle.
    
    Returns:
    
    the maximum number of connections an AsyncHttpClient can handle.
  - getMaxConnectionsPerHost
```
int getMaxConnectionsPerHost()
```
    Return the maximum number of connections per hosts an AsyncHttpClient can handle.
    
    Returns:
    
    the maximum number of connections per host an AsyncHttpClient can handle.
  - getConnectTimeout
```
int getConnectTimeout()
```
    Return the maximum time in millisecond an AsyncHttpClient can wait when connecting to a remote host
    
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient can wait when connecting to a remote host
  - getReadTimeout
```
int getReadTimeout()
```
    Return the maximum time in millisecond an AsyncHttpClient can stay idle.
    
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient can stay idle.
  - getPooledConnectionIdleTimeout
```
int getPooledConnectionIdleTimeout()
```
    Return the maximum time in millisecond an AsyncHttpClient will keep connection in pool.
    
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient will keep connection in pool.
  - getRequestTimeout
```
int getRequestTimeout()
```
    Return the maximum time in millisecond an AsyncHttpClient waits until the response is completed.
    
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient waits until the response is completed.
  - isFollowRedirect
```
boolean isFollowRedirect()
```
    Is HTTP redirect enabled
    
    Returns:
    
    true if enabled.
  - getMaxRedirects
```
int getMaxRedirects()
```
    Get the maximum number of HTTP redirect
    
    Returns:
    
    the maximum number of HTTP redirect
  - isKeepAlive
```
boolean isKeepAlive()
```
    Is the ChannelPool support enabled.
    
    Returns:
    
    true if keep-alive is enabled
  - getUserAgent
```
String getUserAgent()
```
    Return the USER_AGENT header value
    
    Returns:
    
    the USER_AGENT header value
  - isCompressionEnforced
```
boolean isCompressionEnforced()
```
    Is HTTP compression enforced.
    
    Returns:
    
    true if compression is enforced
  - getThreadFactory
```
ThreadFactory getThreadFactory()
```
    Return the ThreadFactory an AsyncHttpClient use for handling asynchronous response.
    
    Returns:
    
    the ThreadFactory an AsyncHttpClient use for handling asynchronous response. If no ThreadFactory has been explicitly provided, this method will return null
  - getProxyServerSelector
```
ProxyServerSelector getProxyServerSelector()
```
    An instance of ProxyServer used by an AsyncHttpClient
    
    Returns:
    
    instance of ProxyServer
  - getSslContext
```
io.netty.handler.ssl.SslContext getSslContext()
```
    Return an instance of SslContext used for SSL connection.
    
    Returns:
    
    an instance of SslContext used for SSL connection.
  - getRealm
```
Realm getRealm()
```
    Return the current Realm
    
    Returns:
    
    the current Realm
  - getRequestFilters
```
List<RequestFilter> getRequestFilters()
```
    Return the list of RequestFilter
    
    Returns:
    
    Unmodifiable list of ResponseFilter
  - getResponseFilters
```
List<ResponseFilter> getResponseFilters()
```
    Return the list of ResponseFilter
    
    Returns:
    
    Unmodifiable list of ResponseFilter
  - getIoExceptionFilters
```
List<IOExceptionFilter> getIoExceptionFilters()
```
    Return the list of IOException
    
    Returns:
    
    Unmodifiable list of IOException
  - getMaxRequestRetry
```
int getMaxRequestRetry()
```
    Return the number of time the library will retry when an IOException is throw by the remote server
    
    Returns:
    
    the number of time the library will retry when an IOException is throw by the remote server
  - isDisableUrlEncodingForBoundRequests
```
boolean isDisableUrlEncodingForBoundRequests()
```
    Returns:
    
    the disableUrlEncodingForBoundRequests
  - isStrict302Handling
```
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. Unless configured otherwise, for a 302, AHC, will use a GET for this case.
    
    Returns:
    
    true if string 302 handling is to be used, otherwise false.
  - getConnectionTtl
```
int getConnectionTtl()
```
    Return the maximum time in millisecond an AsyncHttpClient will keep connection in the pool, or -1 to keep connection while possible.
    
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient will keep connection in the pool, or -1 to keep connection while possible.
  - isUseOpenSsl
```
boolean isUseOpenSsl()
```
  - isAcceptAnyCertificate
```
boolean isAcceptAnyCertificate()
```
  - getEnabledProtocols
```
String[] getEnabledProtocols()
```
    Returns:
    
    the array of enabled protocols
  - getEnabledCipherSuites
```
String[] getEnabledCipherSuites()
```
    Returns:
    
    the array of enabled cipher suites
  - getSslSessionCacheSize
```
int getSslSessionCacheSize()
```
    Returns:
    
    the size of the SSL session cache, 0 means using the default value
  - getSslSessionTimeout
```
int getSslSessionTimeout()
```
    Returns:
    
    the SSL session timeout in seconds, 0 means using the default value
  - getHttpClientCodecMaxInitialLineLength
```
int getHttpClientCodecMaxInitialLineLength()
```
  - getHttpClientCodecMaxHeaderSize
```
int getHttpClientCodecMaxHeaderSize()
```
  - getHttpClientCodecMaxChunkSize
```
int getHttpClientCodecMaxChunkSize()
```
  - isDisableZeroCopy
```
boolean isDisableZeroCopy()
```
  - getHandshakeTimeout
```
int getHandshakeTimeout()
```
  - getSslEngineFactory
```
SslEngineFactory getSslEngineFactory()
```
  - getChunkedFileChunkSize
```
int getChunkedFileChunkSize()
```
  - getWebSocketMaxBufferSize
```
int getWebSocketMaxBufferSize()
```
  - getWebSocketMaxFrameSize
```
int getWebSocketMaxFrameSize()
```
  - isKeepEncodingHeader
```
boolean isKeepEncodingHeader()
```
  - getShutdownQuietPeriod
```
int getShutdownQuietPeriod()
```
  - getShutdownTimeout
```
int getShutdownTimeout()
```
  - getChannelOptions
```
Map<ChannelOption<Object>,Object> getChannelOptions()
```
  - getEventLoopGroup
```
EventLoopGroup getEventLoopGroup()
```
  - isUseNativeTransport
```
boolean isUseNativeTransport()
```
  - getHttpAdditionalChannelInitializer
```
AsyncHttpClientConfig.AdditionalChannelInitializer getHttpAdditionalChannelInitializer()
```
  - getWsAdditionalChannelInitializer
```
AsyncHttpClientConfig.AdditionalChannelInitializer getWsAdditionalChannelInitializer()
```
  - getResponseBodyPartFactory
```
AsyncHttpClientConfig.ResponseBodyPartFactory getResponseBodyPartFactory()
```
  - getChannelPool
```
ChannelPool getChannelPool()
```
  - getNettyTimer
```
io.netty.util.Timer getNettyTimer()
```
  - getKeepAliveStrategy
```
KeepAliveStrategy getKeepAliveStrategy()
```
  - isValidateResponseHeaders
```
boolean isValidateResponseHeaders()
```
  - isTcpNoDelay
```
boolean isTcpNoDelay()
```
  - isSoReuseAddress
```
boolean isSoReuseAddress()
```
  - getSoLinger
```
int getSoLinger()
```
  - getSoSndBuf
```
int getSoSndBuf()
```
  - getSoRcvBuf
```
int getSoRcvBuf()
```
  - isUsePooledMemory
```
boolean isUsePooledMemory()
```

Interface AsyncHttpClientConfig

Nested Class Summary

Method Summary

Method Detail

getAhcVersion

getThreadPoolName

getMaxConnections

getMaxConnectionsPerHost

getConnectTimeout

getReadTimeout

getPooledConnectionIdleTimeout

getRequestTimeout

isFollowRedirect

getMaxRedirects

isKeepAlive

getUserAgent

isCompressionEnforced

getThreadFactory

getProxyServerSelector

getSslContext

getRealm

getRequestFilters

getResponseFilters

getIoExceptionFilters

getMaxRequestRetry

isDisableUrlEncodingForBoundRequests

isStrict302Handling

getConnectionTtl

isUseOpenSsl

isAcceptAnyCertificate

getEnabledProtocols

getEnabledCipherSuites

getSslSessionCacheSize

getSslSessionTimeout

getHttpClientCodecMaxInitialLineLength

getHttpClientCodecMaxHeaderSize

getHttpClientCodecMaxChunkSize

isDisableZeroCopy

getHandshakeTimeout

getSslEngineFactory

getChunkedFileChunkSize

getWebSocketMaxBufferSize

getWebSocketMaxFrameSize

isKeepEncodingHeader

getShutdownQuietPeriod

getShutdownTimeout

getChannelOptions

getEventLoopGroup

isUseNativeTransport

getHttpAdditionalChannelInitializer

getWsAdditionalChannelInitializer

getResponseBodyPartFactory

getChannelPool

getNettyTimer

getKeepAliveStrategy

isValidateResponseHeaders

isTcpNoDelay

isSoReuseAddress

getSoLinger

getSoSndBuf

getSoRcvBuf

isUsePooledMemory