AsyncHttpClientConfig (Asynchronous Http Client 2.8.1 API)

All Known Implementing Classes:

DefaultAsyncHttpClientConfig
```
public interface AsyncHttpClientConfig
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class AsyncHttpClientConfig.ResponseBodyPartFactory

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getAcquireFreeChannelTimeout()` Return the maximum duration in milliseconds an `AsyncHttpClient` can wait to acquire a free channel
`String`	`getAhcVersion()`
`io.netty.buffer.ByteBufAllocator`	`getAllocator()`
`Map<io.netty.channel.ChannelOption<Object>,Object>`	`getChannelOptions()`
`ChannelPool`	`getChannelPool()`
`int`	`getChunkedFileChunkSize()`
`int`	`getConnectionPoolCleanerPeriod()`
`ConnectionSemaphoreFactory`	`getConnectionSemaphoreFactory()`
`int`	`getConnectionTtl()`
`int`	`getConnectTimeout()` Return the maximum time in millisecond an `AsyncHttpClient` can wait when connecting to a remote host
`CookieStore`	`getCookieStore()` Return cookie store that is used to store and retrieve cookies
`String[]`	`getEnabledCipherSuites()`
`String[]`	`getEnabledProtocols()`
`io.netty.channel.EventLoopGroup`	`getEventLoopGroup()`
`int`	`getHandshakeTimeout()`
`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
`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()`
`Consumer<io.netty.channel.Channel>`	`getWsAdditionalChannelInitializer()`
`boolean`	`isAggregateWebSocketFrameFragments()`
`boolean`	`isCompressionEnforced()` Is HTTP compression enforced.
`boolean`	`isDisableHttpsEndpointIdentificationAlgorithm()`
`boolean`	`isDisableUrlEncodingForBoundRequests()`
`boolean`	`isDisableZeroCopy()`
`boolean`	`isEnableWebSocketCompression()`
`boolean`	`isFilterInsecureCipherSuites()`
`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`	`isUseInsecureTrustManager()`
`boolean`	`isUseLaxCookieEncoder()`
`boolean`	`isUseNativeTransport()`
`boolean`	`isUseOpenSsl()`
`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.
  - getAcquireFreeChannelTimeout
```
int getAcquireFreeChannelTimeout()
```
    Return the maximum duration in milliseconds an AsyncHttpClient can wait to acquire a free channel
    
    Returns:
    
    Return the maximum duration in milliseconds an AsyncHttpClient can wait to acquire a free channel
  - 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.
  - getConnectionPoolCleanerPeriod
```
int getConnectionPoolCleanerPeriod()
```
    Returns:
    
    the period in millis to clean the pool of dead and idle connections.
  - 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 RequestFilter
  - 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
  - getCookieStore
```
CookieStore getCookieStore()
```
    Return cookie store that is used to store and retrieve cookies
    
    Returns:
    
    CookieStore object
  - 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
  - isUseLaxCookieEncoder
```
boolean isUseLaxCookieEncoder()
```
    Returns:
    
    true if AHC is to use a LAX cookie encoder, eg accept illegal chars in cookie value
  - 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 strict 302 handling is to be used, otherwise false.
  - getConnectionTtl
```
int getConnectionTtl()
```
    Returns:
    
    the maximum time in millisecond an AsyncHttpClient will keep connection in the pool, or -1 to keep connection while possible.
  - isUseOpenSsl
```
boolean isUseOpenSsl()
```
  - isUseInsecureTrustManager
```
boolean isUseInsecureTrustManager()
```
  - isDisableHttpsEndpointIdentificationAlgorithm
```
boolean isDisableHttpsEndpointIdentificationAlgorithm()
```
    Returns:
    
    true to disable all HTTPS behaviors AT ONCE, such as hostname verification and SNI
  - getEnabledProtocols
```
String[] getEnabledProtocols()
```
    Returns:
    
    the array of enabled protocols
  - getEnabledCipherSuites
```
String[] getEnabledCipherSuites()
```
    Returns:
    
    the array of enabled cipher suites
  - isFilterInsecureCipherSuites
```
boolean isFilterInsecureCipherSuites()
```
    Returns:
    
    if insecured cipher suites must be filtered out (only used when not explicitly passing 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()
```
  - getHttpClientCodecInitialBufferSize
```
int getHttpClientCodecInitialBufferSize()
```
  - 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<io.netty.channel.ChannelOption<Object>,Object> getChannelOptions()
```
  - getEventLoopGroup
```
io.netty.channel.EventLoopGroup getEventLoopGroup()
```
  - isUseNativeTransport
```
boolean isUseNativeTransport()
```
  - getHttpAdditionalChannelInitializer
```
Consumer<io.netty.channel.Channel> getHttpAdditionalChannelInitializer()
```
  - getWsAdditionalChannelInitializer
```
Consumer<io.netty.channel.Channel> getWsAdditionalChannelInitializer()
```
  - getResponseBodyPartFactory
```
AsyncHttpClientConfig.ResponseBodyPartFactory getResponseBodyPartFactory()
```
  - getChannelPool
```
ChannelPool getChannelPool()
```
  - getConnectionSemaphoreFactory
```
ConnectionSemaphoreFactory getConnectionSemaphoreFactory()
```
  - getNettyTimer
```
io.netty.util.Timer getNettyTimer()
```
  - getKeepAliveStrategy
```
KeepAliveStrategy getKeepAliveStrategy()
```
  - isValidateResponseHeaders
```
boolean isValidateResponseHeaders()
```
  - isAggregateWebSocketFrameFragments
```
boolean isAggregateWebSocketFrameFragments()
```
  - isEnableWebSocketCompression
```
boolean isEnableWebSocketCompression()
```
  - isTcpNoDelay
```
boolean isTcpNoDelay()
```
  - isSoReuseAddress
```
boolean isSoReuseAddress()
```
  - getSoLinger
```
int getSoLinger()
```
  - getSoSndBuf
```
int getSoSndBuf()
```
  - getSoRcvBuf
```
int getSoRcvBuf()
```
  - getAllocator
```
io.netty.buffer.ByteBufAllocator getAllocator()
```
  - getIoThreadsCount
```
int getIoThreadsCount()
```

Interface AsyncHttpClientConfig

Nested Class Summary

Method Summary

Method Detail

getAhcVersion

getThreadPoolName

getMaxConnections

getMaxConnectionsPerHost

getAcquireFreeChannelTimeout

getConnectTimeout

getReadTimeout

getPooledConnectionIdleTimeout

getConnectionPoolCleanerPeriod

getRequestTimeout

isFollowRedirect

getMaxRedirects

isKeepAlive

getUserAgent

isCompressionEnforced

getThreadFactory

getProxyServerSelector

getSslContext

getRealm

getRequestFilters

getResponseFilters

getIoExceptionFilters

getCookieStore

getMaxRequestRetry

isDisableUrlEncodingForBoundRequests

isUseLaxCookieEncoder

isStrict302Handling

getConnectionTtl

isUseOpenSsl

isUseInsecureTrustManager

isDisableHttpsEndpointIdentificationAlgorithm

getEnabledProtocols

getEnabledCipherSuites

isFilterInsecureCipherSuites

getSslSessionCacheSize

getSslSessionTimeout

getHttpClientCodecMaxInitialLineLength

getHttpClientCodecMaxHeaderSize

getHttpClientCodecMaxChunkSize

getHttpClientCodecInitialBufferSize

isDisableZeroCopy

getHandshakeTimeout

getSslEngineFactory

getChunkedFileChunkSize

getWebSocketMaxBufferSize

getWebSocketMaxFrameSize

isKeepEncodingHeader

getShutdownQuietPeriod

getShutdownTimeout

getChannelOptions

getEventLoopGroup

isUseNativeTransport

getHttpAdditionalChannelInitializer

getWsAdditionalChannelInitializer

getResponseBodyPartFactory

getChannelPool

getConnectionSemaphoreFactory

getNettyTimer

getKeepAliveStrategy

isValidateResponseHeaders

isAggregateWebSocketFrameFragments

isEnableWebSocketCompression

isTcpNoDelay

isSoReuseAddress

getSoLinger

getSoSndBuf

getSoRcvBuf

getAllocator

getIoThreadsCount