com.ning.http.client

Class AsyncHttpClientConfig.Builder

java.lang.Object

com.ning.http.client.AsyncHttpClientConfig.Builder

Enclosing class:

AsyncHttpClientConfig

public static class AsyncHttpClientConfig.Builder
extends Object

Builder for an AsyncHttpClient

Constructor Summary

Constructors

Constructor and Description
AsyncHttpClientConfig.Builder()
AsyncHttpClientConfig.Builder(AsyncHttpClientConfig prototype) Create a config builder with values taken from the given prototype configuration.

Method Summary

Methods

Modifier and Type	Method and Description
AsyncHttpClientConfig.Builder	addIOExceptionFilter(IOExceptionFilter ioExceptionFilter) Add an IOExceptionFilter that will be invoked when an IOException occurs during the download/upload operations.
AsyncHttpClientConfig.Builder	addRequestFilter(RequestFilter requestFilter) Add an RequestFilter that will be invoked before AsyncHttpClient.executeRequest(Request)
AsyncHttpClientConfig.Builder	addResponseFilter(ResponseFilter responseFilter) Add an ResponseFilter that will be invoked as soon as the response is received, and before AsyncHandler.onStatusReceived(HttpResponseStatus).
AsyncHttpClientConfig	build() Build an AsyncHttpClientConfig
AsyncHttpClientConfig.Builder	removeIOExceptionFilter(IOExceptionFilter ioExceptionFilter) Remove an IOExceptionFilter tthat will be invoked when an IOException occurs during the download/upload operations.
AsyncHttpClientConfig.Builder	removeRequestFilter(RequestFilter requestFilter) Remove an RequestFilter that will be invoked before AsyncHttpClient.executeRequest(Request)
AsyncHttpClientConfig.Builder	removeResponseFilter(ResponseFilter responseFilter) Remove an ResponseFilter that will be invoked as soon as the response is received, and before AsyncHandler.onStatusReceived(HttpResponseStatus).
AsyncHttpClientConfig.Builder	setAcceptAnyCertificate(boolean acceptAnyCertificate)
AsyncHttpClientConfig.Builder	setAllowPoolingConnections(boolean allowPoolingConnections) Set true if connection can be pooled by a ChannelPool.
AsyncHttpClientConfig.Builder	setAllowPoolingSslConnections(boolean allowPoolingSslConnections) Return true is if connections pooling is enabled.
AsyncHttpClientConfig.Builder	setAsyncHttpClientProviderConfig(AsyncHttpProviderConfig<?,?> providerConfig) Set the AsyncHttpProviderConfig
AsyncHttpClientConfig.Builder	setCompressionEnforced(boolean compressionEnforced) Enforce HTTP compression.
AsyncHttpClientConfig.Builder	setConnectionTTL(int connectionTTL) Set the maximum time in millisecond connection can be added to the pool for further reuse
AsyncHttpClientConfig.Builder	setConnectTimeout(int connectTimeOut) Set the maximum time in millisecond an AsyncHttpClient can wait when connecting to a remote host
AsyncHttpClientConfig.Builder	setDisableUrlEncodingForBoundedRequests(boolean disableUrlEncodingForBoundedRequests) Disable automatic url escaping
AsyncHttpClientConfig.Builder	setEnabledCipherSuites(String[] enabledCipherSuites)
AsyncHttpClientConfig.Builder	setEnabledProtocols(String[] enabledProtocols)
AsyncHttpClientConfig.Builder	setExecutorService(ExecutorService applicationThreadPool) Set the ExecutorService an AsyncHttpClient use for handling asynchronous response.
AsyncHttpClientConfig.Builder	setFollowRedirect(boolean followRedirect) Set to true to enable HTTP redirect
AsyncHttpClientConfig.Builder	setHostnameVerifier(HostnameVerifier hostnameVerifier) Set the HostnameVerifier
AsyncHttpClientConfig.Builder	setIOThreadMultiplier(int multiplier)
AsyncHttpClientConfig.Builder	setMaxConnections(int maxConnections) Set the maximum number of connections an AsyncHttpClient can handle.
AsyncHttpClientConfig.Builder	setMaxConnectionsPerHost(int maxConnectionsPerHost) Set the maximum number of connections per (scheme, host, port) an AsyncHttpClient can handle.
AsyncHttpClientConfig.Builder	setMaxRedirects(int maxRedirects) Set the maximum number of HTTP redirect
AsyncHttpClientConfig.Builder	setMaxRequestRetry(int maxRequestRetry) Set the number of time a request will be retried when an IOException occurs because of a Network exception.
AsyncHttpClientConfig.Builder	setPooledConnectionIdleTimeout(int pooledConnectionIdleTimeout) Set the maximum time in millisecond an AsyncHttpClient will keep connection idle in pool.
AsyncHttpClientConfig.Builder	setProxyServer(ProxyServer proxyServer) Set an instance of ProxyServer used by an AsyncHttpClient
AsyncHttpClientConfig.Builder	setProxyServerSelector(ProxyServerSelector proxyServerSelector) Set an instance of ProxyServerSelector used by an AsyncHttpClient
AsyncHttpClientConfig.Builder	setReadTimeout(int readTimeout) Set the maximum time in millisecond an AsyncHttpClient can stay idle.
AsyncHttpClientConfig.Builder	setRealm(Realm realm) Set the Realm that will be used for all requests.
AsyncHttpClientConfig.Builder	setRemoveQueryParamsOnRedirect(boolean removeQueryParamOnRedirect) Set to false if you don't want the query parameters removed when a redirect occurs.
AsyncHttpClientConfig.Builder	setRequestTimeout(int requestTimeout) Set the maximum time in millisecond an AsyncHttpClient waits until the response is completed.
AsyncHttpClientConfig.Builder	setSSLContext(SSLContext sslContext) Set the SSLContext for secure connection.
AsyncHttpClientConfig.Builder	setStrict302Handling(boolean strict302Handling) Configures this AHC instance to be strict in it's handling of 302 redirects in a POST/Redirect/GET situation.
AsyncHttpClientConfig.Builder	setTimeConverter(TimeConverter timeConverter)
AsyncHttpClientConfig.Builder	setUseProxyProperties(boolean useProxyProperties) Sets whether AHC should use the default http.proxy* system properties to obtain proxy information.
AsyncHttpClientConfig.Builder	setUseProxySelector(boolean useProxySelector) Sets whether AHC should use the default JDK ProxySelector to select a proxy server.
AsyncHttpClientConfig.Builder	setUserAgent(String userAgent) Set the USER_AGENT header value
AsyncHttpClientConfig.Builder	setUseRelativeURIsWithConnectProxies(boolean useRelativeURIsWithConnectProxies) Configures this AHC instance to use relative URIs instead of absolute ones when talking with a SSL proxy or WebSocket proxy.
AsyncHttpClientConfig.Builder	setWebSocketTimeout(int webSocketTimeout) Set the maximum time in millisecond an WebSocket can stay idle.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncHttpClientConfig.Builder

public AsyncHttpClientConfig.Builder()

AsyncHttpClientConfig.Builder

public AsyncHttpClientConfig.Builder(AsyncHttpClientConfig prototype)

Create a config builder with values taken from the given prototype configuration.

Parameters:

prototype - the configuration to use as a prototype.

Method Detail

setMaxConnections

public AsyncHttpClientConfig.Builder setMaxConnections(int maxConnections)

Set the maximum number of connections an AsyncHttpClient can handle.

Parameters:

maxConnections - the maximum number of connections an AsyncHttpClient can handle.

Returns:

a AsyncHttpClientConfig.Builder

setMaxConnectionsPerHost

public AsyncHttpClientConfig.Builder setMaxConnectionsPerHost(int maxConnectionsPerHost)

Set the maximum number of connections per (scheme, host, port) an AsyncHttpClient can handle.

Parameters:

maxConnectionsPerHost - the maximum number of connections per (scheme, host, port) an AsyncHttpClient can handle.

Returns:

a AsyncHttpClientConfig.Builder

setConnectTimeout

public AsyncHttpClientConfig.Builder setConnectTimeout(int connectTimeOut)

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

Parameters:

connectTimeOut - the maximum time in millisecond an AsyncHttpClient can wait when connecting to a remote host

Returns:

a AsyncHttpClientConfig.Builder

setWebSocketTimeout

public AsyncHttpClientConfig.Builder setWebSocketTimeout(int webSocketTimeout)

Set the maximum time in millisecond an WebSocket can stay idle.

Parameters:

webSocketTimeout - the maximum time in millisecond an WebSocket can stay idle.

Returns:

a AsyncHttpClientConfig.Builder

setReadTimeout

public AsyncHttpClientConfig.Builder setReadTimeout(int readTimeout)

Set the maximum time in millisecond an AsyncHttpClient can stay idle.

Parameters:

readTimeout - the maximum time in millisecond an AsyncHttpClient can stay idle.

Returns:

a AsyncHttpClientConfig.Builder

setPooledConnectionIdleTimeout

public AsyncHttpClientConfig.Builder setPooledConnectionIdleTimeout(int pooledConnectionIdleTimeout)

Set the maximum time in millisecond an AsyncHttpClient will keep connection idle in pool.

Parameters:

idleConnectionInPoolTimeout - the maximum time in millisecond an AsyncHttpClient will keep connection idle in pool.

Returns:

a AsyncHttpClientConfig.Builder

setRequestTimeout

public AsyncHttpClientConfig.Builder setRequestTimeout(int requestTimeout)

Set the maximum time in millisecond an AsyncHttpClient waits until the response is completed.

Parameters:

requestTimeout - the maximum time in millisecond an AsyncHttpClient waits until the response is completed.

Returns:

a AsyncHttpClientConfig.Builder

setFollowRedirect

public AsyncHttpClientConfig.Builder setFollowRedirect(boolean followRedirect)

Set to true to enable HTTP redirect

Parameters:

redirectEnabled - true if enabled.

Returns:

a AsyncHttpClientConfig.Builder

setMaxRedirects

public AsyncHttpClientConfig.Builder setMaxRedirects(int maxRedirects)

Set the maximum number of HTTP redirect

Parameters:

maxRedirects - the maximum number of HTTP redirect

Returns:

a AsyncHttpClientConfig.Builder

setCompressionEnforced

public AsyncHttpClientConfig.Builder setCompressionEnforced(boolean compressionEnforced)

Enforce HTTP compression.

Parameters:

compressionEnforced - true if compression is enforced

Returns:

a AsyncHttpClientConfig.Builder

setUserAgent

public AsyncHttpClientConfig.Builder setUserAgent(String userAgent)

Set the USER_AGENT header value

Parameters:

userAgent - the USER_AGENT header value

Returns:

a AsyncHttpClientConfig.Builder

setAllowPoolingConnections

public AsyncHttpClientConfig.Builder setAllowPoolingConnections(boolean allowPoolingConnections)

Set true if connection can be pooled by a ChannelPool. Default is true.

Parameters:

allowPoolingConnections - true if connection can be pooled by a ChannelPool

Returns:

a AsyncHttpClientConfig.Builder

setExecutorService

public AsyncHttpClientConfig.Builder setExecutorService(ExecutorService applicationThreadPool)

Set the ExecutorService an AsyncHttpClient use for handling asynchronous response.

Parameters:

applicationThreadPool - the ExecutorService an AsyncHttpClient use for handling asynchronous response.

Returns:

a AsyncHttpClientConfig.Builder

setProxyServerSelector

public AsyncHttpClientConfig.Builder setProxyServerSelector(ProxyServerSelector proxyServerSelector)

Set an instance of ProxyServerSelector used by an AsyncHttpClient

Parameters:

proxyServerSelector - instance of ProxyServerSelector

Returns:

a AsyncHttpClientConfig.Builder

setProxyServer

public AsyncHttpClientConfig.Builder setProxyServer(ProxyServer proxyServer)

Set an instance of ProxyServer used by an AsyncHttpClient

Parameters:

proxyServer - instance of ProxyServer

Returns:

a AsyncHttpClientConfig.Builder

setSSLContext

public AsyncHttpClientConfig.Builder setSSLContext(SSLContext sslContext)

Set the SSLContext for secure connection.

Parameters:

sslContext - the SSLContext for secure connection

Returns:

a AsyncHttpClientConfig.Builder

setAsyncHttpClientProviderConfig

public AsyncHttpClientConfig.Builder setAsyncHttpClientProviderConfig(AsyncHttpProviderConfig<?,?> providerConfig)

Set the AsyncHttpProviderConfig

Parameters:

providerConfig - the AsyncHttpProviderConfig

Returns:

a AsyncHttpClientConfig.Builder

setRealm

public AsyncHttpClientConfig.Builder setRealm(Realm realm)

Set the Realm that will be used for all requests.

Parameters:

realm - the Realm

Returns:

a AsyncHttpClientConfig.Builder

addRequestFilter

public AsyncHttpClientConfig.Builder addRequestFilter(RequestFilter requestFilter)

Add an RequestFilter that will be invoked before AsyncHttpClient.executeRequest(Request)

Parameters:

requestFilter - RequestFilter

Returns:

this

removeRequestFilter

public AsyncHttpClientConfig.Builder removeRequestFilter(RequestFilter requestFilter)

Remove an RequestFilter that will be invoked before AsyncHttpClient.executeRequest(Request)

Parameters:

requestFilter - RequestFilter

Returns:

this

addResponseFilter

public AsyncHttpClientConfig.Builder addResponseFilter(ResponseFilter responseFilter)

Add an ResponseFilter that will be invoked as soon as the response is received, and before AsyncHandler.onStatusReceived(HttpResponseStatus).

Parameters:

responseFilter - an ResponseFilter

Returns:

this

removeResponseFilter

public AsyncHttpClientConfig.Builder removeResponseFilter(ResponseFilter responseFilter)

Remove an ResponseFilter that will be invoked as soon as the response is received, and before AsyncHandler.onStatusReceived(HttpResponseStatus).

Parameters:

responseFilter - an ResponseFilter

Returns:

this

addIOExceptionFilter

public AsyncHttpClientConfig.Builder addIOExceptionFilter(IOExceptionFilter ioExceptionFilter)

Add an IOExceptionFilter that will be invoked when an IOException occurs during the download/upload operations.

Parameters:

ioExceptionFilter - an ResponseFilter

Returns:

this

removeIOExceptionFilter

public AsyncHttpClientConfig.Builder removeIOExceptionFilter(IOExceptionFilter ioExceptionFilter)

Remove an IOExceptionFilter tthat will be invoked when an IOException occurs during the download/upload operations.

Parameters:

ioExceptionFilter - an ResponseFilter

Returns:

this

setMaxRequestRetry

public AsyncHttpClientConfig.Builder setMaxRequestRetry(int maxRequestRetry)

Set the number of time a request will be retried when an IOException occurs because of a Network exception.

Parameters:

maxRequestRetry - the number of time a request will be retried

Returns:

this

setAllowPoolingSslConnections

public AsyncHttpClientConfig.Builder setAllowPoolingSslConnections(boolean allowPoolingSslConnections)

Return true is if connections pooling is enabled.

Parameters:

allowPoolingSslConnections - true if enabled

Returns:

this

setDisableUrlEncodingForBoundedRequests

public AsyncHttpClientConfig.Builder setDisableUrlEncodingForBoundedRequests(boolean disableUrlEncodingForBoundedRequests)

Disable automatic url escaping

Parameters:

disableUrlEncodingForBoundedRequests -

Returns:

this

setRemoveQueryParamsOnRedirect

public AsyncHttpClientConfig.Builder setRemoveQueryParamsOnRedirect(boolean removeQueryParamOnRedirect)

Set to false if you don't want the query parameters removed when a redirect occurs.

Parameters:

removeQueryParamOnRedirect -

Returns:

this

setUseProxySelector

public AsyncHttpClientConfig.Builder setUseProxySelector(boolean useProxySelector)

Sets whether AHC should use the default JDK ProxySelector to select a proxy server.

If useProxySelector is set to true but setProxyServer(ProxyServer) was used to explicitly set a proxy server, the latter is preferred.

See http://docs.oracle.com/javase/7/docs/api/java/net/ProxySelector.html

setUseProxyProperties

public AsyncHttpClientConfig.Builder setUseProxyProperties(boolean useProxyProperties)

Sets whether AHC should use the default http.proxy* system properties to obtain proxy information. This differs from setUseProxySelector(boolean) in that AsyncHttpClient will use its own logic to handle the system properties, potentially supporting other protocols that the the JDK ProxySelector doesn't.

If useProxyProperties is set to true but setUseProxySelector(boolean) was also set to true, the latter is preferred.

See http://download.oracle.com/javase/1.4.2/docs/guide/net/properties.html

setIOThreadMultiplier

public AsyncHttpClientConfig.Builder setIOThreadMultiplier(int multiplier)

setHostnameVerifier

public AsyncHttpClientConfig.Builder setHostnameVerifier(HostnameVerifier hostnameVerifier)

Set the HostnameVerifier

Parameters:

hostnameVerifier - HostnameVerifier

Returns:

this

setStrict302Handling

public AsyncHttpClientConfig.Builder setStrict302Handling(boolean strict302Handling)

Configures this AHC instance to be strict in it's handling of 302 redirects in a POST/Redirect/GET situation.

Parameters:

strict302Handling - strict handling

Returns:

this

Since:

1.7.2

setUseRelativeURIsWithConnectProxies

public AsyncHttpClientConfig.Builder setUseRelativeURIsWithConnectProxies(boolean useRelativeURIsWithConnectProxies)

Configures this AHC instance to use relative URIs instead of absolute ones when talking with a SSL proxy or WebSocket proxy.

Parameters:

useRelativeURIsWithConnectProxies -

Returns:

this

Since:

1.8.13

setConnectionTTL

public AsyncHttpClientConfig.Builder setConnectionTTL(int connectionTTL)

Set the maximum time in millisecond connection can be added to the pool for further reuse

Parameters:

connectionTTL - the maximum time in millisecond connection can be added to the pool for further reuse

Returns:

a AsyncHttpClientConfig.Builder

setTimeConverter

public AsyncHttpClientConfig.Builder setTimeConverter(TimeConverter timeConverter)

setAcceptAnyCertificate

public AsyncHttpClientConfig.Builder setAcceptAnyCertificate(boolean acceptAnyCertificate)

setEnabledProtocols

public AsyncHttpClientConfig.Builder setEnabledProtocols(String[] enabledProtocols)

setEnabledCipherSuites

public AsyncHttpClientConfig.Builder setEnabledCipherSuites(String[] enabledCipherSuites)

build

public AsyncHttpClientConfig build()

Build an AsyncHttpClientConfig

Returns:

an AsyncHttpClientConfig