AsyncHttpClientConfig (Asynchronous Http Client 1.9.0-BETA5 API)

java.lang.Object
- com.ning.http.client.AsyncHttpClientConfig

Direct Known Subclasses:

AsyncHttpClientConfigBean
```
public class AsyncHttpClientConfig
extends Object
```
Configuration class to use with a AsyncHttpClient. System property can be also used to configure this object default behavior by doing:
-Dcom.ning.http.client.AsyncHttpClientConfig.nameOfTheProperty

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AsyncHttpClientConfig.Builder
Builder for an AsyncHttpClient

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`acceptAnyCertificate`
`protected boolean`	`allowPoolingConnections`
`protected boolean`	`allowPoolingSslConnections`
`protected ExecutorService`	`applicationThreadPool`
`protected boolean`	`compressionEnabled`
`protected int`	`connectionTimeout`
`protected int`	`connectionTTL`
`protected boolean`	`disableUrlEncodingForBoundRequests`
`protected boolean`	`followRedirect`
`protected HostnameVerifier`	`hostnameVerifier`
`protected List<IOExceptionFilter>`	`ioExceptionFilters`
`protected int`	`ioThreadMultiplier`
`protected int`	`maxConnections`
`protected int`	`maxConnectionsPerHost`
`protected int`	`maxRedirects`
`protected int`	`maxRequestRetry`
`protected int`	`pooledConnectionIdleTimeout`
`protected AsyncHttpProviderConfig<?,?>`	`providerConfig`
`protected ProxyServerSelector`	`proxyServerSelector`
`protected int`	`readTimeout`
`protected Realm`	`realm`
`protected boolean`	`removeQueryParamOnRedirect`
`protected List<RequestFilter>`	`requestFilters`
`protected int`	`requestTimeout`
`protected List<ResponseFilter>`	`responseFilters`
`protected SSLContext`	`sslContext`
`protected boolean`	`strict302Handling`
`protected TimeConverter`	`timeConverter`
`protected String`	`userAgent`
`protected boolean`	`useRelativeURIsWithSSLProxies`
`protected int`	`webSocketTimeout`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AsyncHttpClientConfig()

Constructors
Modifier	Constructor and Description
`protected`	`AsyncHttpClientConfig()`

Method Summary

Methods
Modifier and Type	Method and Description
`ExecutorService`	`executorService()` Return the `ExecutorService` an `AsyncHttpClient` use for handling asynchronous response.
`AsyncHttpProviderConfig<?,?>`	`getAsyncHttpProviderConfig()` Return the `AsyncHttpProviderConfig`
`int`	`getConnectionTimeout()` Return the maximum time in millisecond an `AsyncHttpClient` can wait when connecting to a remote host
`int`	`getConnectionTTL()` Return the maximum time in millisecond an `AsyncHttpClient` will keep connection in the pool, or -1 to keep connection while possible.
`HostnameVerifier`	`getHostnameVerifier()` Return the `HostnameVerifier`
`List<IOExceptionFilter>`	`getIOExceptionFilters()` Return the list of `IOException`
`int`	`getIoThreadMultiplier()`
`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
`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` wait for a response
`List<ResponseFilter>`	`getResponseFilters()` Return the list of `ResponseFilter`
`SSLContext`	`getSSLContext()` Return an instance of `SSLContext` used for SSL connection.
`TimeConverter`	`getTimeConverter()` since 1.8.2
`String`	`getUserAgent()` Return the USER_AGENT header value
`int`	`getWebSocketTimeout()` Return the maximum time, in milliseconds, a `WebSocket` may be idle before being timed out.
`boolean`	`isAcceptAnyCertificate()` since 1.9.0
`boolean`	`isAllowPoolingConnections()` Is pooling connections enabled.
`boolean`	`isAllowPoolingSslConnections()` Return true is SSL connection polling is enabled.
`boolean`	`isCompressionEnabled()` Is HTTP compression enabled.
`boolean`	`isDisableUrlEncodingForBoundedRequests()`
`boolean`	`isFollowRedirect()` Is HTTP redirect enabled
`boolean`	`isRemoveQueryParamOnRedirect()` Return true if the query parameters will be stripped from the request when a redirect is requested.
`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`	`isUseRelativeURIsWithSSLProxies()`
`boolean`	`isValid()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - connectionTimeout
```
protected int connectionTimeout
```
  - maxConnections
```
protected int maxConnections
```
  - maxConnectionsPerHost
```
protected int maxConnectionsPerHost
```
  - requestTimeout
```
protected int requestTimeout
```
  - readTimeout
```
protected int readTimeout
```
  - webSocketTimeout
```
protected int webSocketTimeout
```
  - allowPoolingConnections
```
protected boolean allowPoolingConnections
```
  - allowPoolingSslConnections
```
protected boolean allowPoolingSslConnections
```
  - pooledConnectionIdleTimeout
```
protected int pooledConnectionIdleTimeout
```
  - connectionTTL
```
protected int connectionTTL
```
  - sslContext
```
protected SSLContext sslContext
```
  - hostnameVerifier
```
protected HostnameVerifier hostnameVerifier
```
  - acceptAnyCertificate
```
protected boolean acceptAnyCertificate
```
  - followRedirect
```
protected boolean followRedirect
```
  - maxRedirects
```
protected int maxRedirects
```
  - removeQueryParamOnRedirect
```
protected boolean removeQueryParamOnRedirect
```
  - strict302Handling
```
protected boolean strict302Handling
```
  - proxyServerSelector
```
protected ProxyServerSelector proxyServerSelector
```
  - useRelativeURIsWithSSLProxies
```
protected boolean useRelativeURIsWithSSLProxies
```
  - compressionEnabled
```
protected boolean compressionEnabled
```
  - userAgent
```
protected String userAgent
```
  - applicationThreadPool
```
protected ExecutorService applicationThreadPool
```
  - realm
```
protected Realm realm
```
  - requestFilters
```
protected List<RequestFilter> requestFilters
```
  - responseFilters
```
protected List<ResponseFilter> responseFilters
```
  - ioExceptionFilters
```
protected List<IOExceptionFilter> ioExceptionFilters
```
  - maxRequestRetry
```
protected int maxRequestRetry
```
  - disableUrlEncodingForBoundRequests
```
protected boolean disableUrlEncodingForBoundRequests
```
  - ioThreadMultiplier
```
protected int ioThreadMultiplier
```
  - timeConverter
```
protected TimeConverter timeConverter
```
  - providerConfig
```
protected AsyncHttpProviderConfig<?,?> providerConfig
```
- Constructor Detail
  - AsyncHttpClientConfig
```
protected AsyncHttpClientConfig()
```
- Method Detail
  - getMaxConnections
```
public int getMaxConnections()
```
    Return the maximum number of connections an AsyncHttpClient can handle.
    
    Returns:
    the maximum number of connections an AsyncHttpClient can handle.
  - getMaxConnectionsPerHost
```
public 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.
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    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
  - getWebSocketTimeout
```
public int getWebSocketTimeout()
```
    Return the maximum time, in milliseconds, a WebSocket may be idle before being timed out.
    
    Returns:
    the maximum time, in milliseconds, a WebSocket may be idle before being timed out.
  - getReadTimeout
```
public 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
```
public 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
```
public int getRequestTimeout()
```
    Return the maximum time in millisecond an AsyncHttpClient wait for a response
    
    Returns:
    the maximum time in millisecond an AsyncHttpClient wait for a response
  - isFollowRedirect
```
public boolean isFollowRedirect()
```
    Is HTTP redirect enabled
    
    Returns:
    true if enabled.
  - getMaxRedirects
```
public int getMaxRedirects()
```
    Get the maximum number of HTTP redirect
    
    Returns:
    the maximum number of HTTP redirect
  - isAllowPoolingConnections
```
public boolean isAllowPoolingConnections()
```
    Is pooling connections enabled.
    
    Returns:
    if polling connections is enabled
  - getUserAgent
```
public String getUserAgent()
```
    Return the USER_AGENT header value
    
    Returns:
    the USER_AGENT header value
  - isCompressionEnabled
```
public boolean isCompressionEnabled()
```
    Is HTTP compression enabled.
    
    Returns:
    true if compression is enabled
  - executorService
```
public ExecutorService executorService()
```
    Return the ExecutorService an AsyncHttpClient use for handling asynchronous response.
    
    Returns:
    the ExecutorService an AsyncHttpClient use for handling asynchronous response.
  - getProxyServerSelector
```
public ProxyServerSelector getProxyServerSelector()
```
    An instance of ProxyServer used by an AsyncHttpClient
    
    Returns:
    instance of ProxyServer
  - getSSLContext
```
public SSLContext getSSLContext()
```
    Return an instance of SSLContext used for SSL connection.
    
    Returns:
    an instance of SSLContext used for SSL connection.
  - getAsyncHttpProviderConfig
```
public AsyncHttpProviderConfig<?,?> getAsyncHttpProviderConfig()
```
    Return the AsyncHttpProviderConfig
    
    Returns:
    the AsyncHttpProviderConfig
  - getRealm
```
public Realm getRealm()
```
    Return the current Realm}
    
    Returns:
    the current Realm}
  - getRequestFilters
```
public List<RequestFilter> getRequestFilters()
```
    Return the list of RequestFilter
    
    Returns:
    Unmodifiable list of ResponseFilter
  - getResponseFilters
```
public List<ResponseFilter> getResponseFilters()
```
    Return the list of ResponseFilter
    
    Returns:
    Unmodifiable list of ResponseFilter
  - getIOExceptionFilters
```
public List<IOExceptionFilter> getIOExceptionFilters()
```
    Return the list of IOException
    
    Returns:
    Unmodifiable list of IOException
  - getMaxRequestRetry
```
public 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
  - isAllowPoolingSslConnections
```
public boolean isAllowPoolingSslConnections()
```
    Return true is SSL connection polling is enabled. Default is true.
    
    Returns:
    true is enabled.
  - isDisableUrlEncodingForBoundedRequests
```
public boolean isDisableUrlEncodingForBoundedRequests()
```
    Returns:
    the disableUrlEncodingForBoundedRequests
  - isRemoveQueryParamOnRedirect
```
public boolean isRemoveQueryParamOnRedirect()
```
    Return true if the query parameters will be stripped from the request when a redirect is requested.
    
    Returns:
    true if the query parameters will be stripped from the request when a redirect is requested.
  - isValid
```
public boolean isValid()
```
    Returns:
    true if both the application and reaper thread pools haven't yet been shutdown.
    Since:
    
    1.7.21
  - getHostnameVerifier
```
public HostnameVerifier getHostnameVerifier()
```
    Return the HostnameVerifier
    
    Returns:
    the HostnameVerifier
  - getIoThreadMultiplier
```
public int getIoThreadMultiplier()
```
    Returns:
    number to multiply by availableProcessors() that will determine # of NioWorkers to use
  - isStrict302Handling
```
public 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.
    Since:
    
    1.7.2
  - isUseRelativeURIsWithSSLProxies
```
public boolean isUseRelativeURIsWithSSLProxies()
```
    Since:
    
    1.7.12
  - getConnectionTTL
```
public 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.
  - getTimeConverter
```
public TimeConverter getTimeConverter()
```
    since 1.8.2
  - isAcceptAnyCertificate
```
public boolean isAcceptAnyCertificate()
```
    since 1.9.0

Class AsyncHttpClientConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

connectionTimeout

maxConnections

maxConnectionsPerHost

requestTimeout

readTimeout

webSocketTimeout

allowPoolingConnections

allowPoolingSslConnections

pooledConnectionIdleTimeout

connectionTTL

sslContext

hostnameVerifier

acceptAnyCertificate

followRedirect

maxRedirects

removeQueryParamOnRedirect

strict302Handling

proxyServerSelector

useRelativeURIsWithSSLProxies

compressionEnabled

userAgent

applicationThreadPool

realm

requestFilters

responseFilters

ioExceptionFilters

maxRequestRetry

disableUrlEncodingForBoundRequests

ioThreadMultiplier

timeConverter

providerConfig

Constructor Detail

AsyncHttpClientConfig

Method Detail

getMaxConnections

getMaxConnectionsPerHost

getConnectionTimeout

getWebSocketTimeout

getReadTimeout

getPooledConnectionIdleTimeout

getRequestTimeout

isFollowRedirect

getMaxRedirects

isAllowPoolingConnections

getUserAgent

isCompressionEnabled

executorService

getProxyServerSelector

getSSLContext

getAsyncHttpProviderConfig

getRealm

getRequestFilters

getResponseFilters

getIOExceptionFilters

getMaxRequestRetry

isAllowPoolingSslConnections

isDisableUrlEncodingForBoundedRequests

isRemoveQueryParamOnRedirect

isValid

getHostnameVerifier

getIoThreadMultiplier

isStrict302Handling

isUseRelativeURIsWithSSLProxies

getConnectionTTL

getTimeConverter

isAcceptAnyCertificate