|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ning.http.client.AsyncHttpClientConfig.Builder
public static class AsyncHttpClientConfig.Builder
Builder for an AsyncHttpClient
Constructor Summary | |
---|---|
AsyncHttpClientConfig.Builder()
|
|
AsyncHttpClientConfig.Builder(AsyncHttpClientConfig prototype)
Create a config builder with values taken from the given prototype configuration. |
Method Summary | |
---|---|
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 |
int |
getRequestCompressionLevel()
Return the compression level, or -1 if no compression is used. |
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 |
setAllowPoolingConnection(boolean allowPoolingConnection)
Set true if connection can be pooled by a ConnectionsPool . |
AsyncHttpClientConfig.Builder |
setAllowSslConnectionPool(boolean allowSslConnectionPool)
Return true is if connections pooling is enabled. |
AsyncHttpClientConfig.Builder |
setAsyncHttpClientProviderConfig(AsyncHttpProviderConfig<?,?> providerConfig)
Set the AsyncHttpProviderConfig |
AsyncHttpClientConfig.Builder |
setCompressionEnabled(boolean compressionEnabled)
Enable HTTP compression. |
AsyncHttpClientConfig.Builder |
setConnectionsPool(ConnectionsPool<?,?> connectionsPool)
Set the ConnectionsPool |
AsyncHttpClientConfig.Builder |
setConnectionTimeoutInMs(int connectionTimeOutInMs)
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 |
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 |
setIdleConnectionInPoolTimeoutInMs(int idleConnectionInPoolTimeoutInMs)
Set the maximum time in millisecond an AsyncHttpClient will keep connection
idle in pool. |
AsyncHttpClientConfig.Builder |
setIdleConnectionTimeoutInMs(int idleConnectionTimeoutInMs)
Set the maximum time in millisecond an AsyncHttpClient can stay idle. |
AsyncHttpClientConfig.Builder |
setIOThreadMultiplier(int multiplier)
|
AsyncHttpClientConfig.Builder |
setMaxConnectionLifeTimeInMs(int maxConnectionLifeTimeInMs)
Set the maximum time in millisecond connection can be added to the pool for further reuse |
AsyncHttpClientConfig.Builder |
setMaximumConnectionsPerHost(int maxConnectionPerHost)
Set the maximum number of connections per hosts an AsyncHttpClient can handle. |
AsyncHttpClientConfig.Builder |
setMaximumConnectionsTotal(int maxTotalConnections)
Set the maximum number of connections an AsyncHttpClient can handle. |
AsyncHttpClientConfig.Builder |
setMaximumNumberOfRedirects(int maxDefaultRedirects)
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 |
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 |
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 |
setRequestCompressionLevel(int requestCompressionLevel)
Set the compression level, or -1 if no compression is used. |
AsyncHttpClientConfig.Builder |
setRequestTimeoutInMs(int requestTimeoutInMs)
Set the maximum time in millisecond an AsyncHttpClient wait for a response |
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 |
setUseRelativeURIsWithSSLProxies(boolean useRelativeURIsWithSSLProxies)
Configures this AHC instance to use relative URIs instead of absolute ones when talking with a SSL proxy. |
AsyncHttpClientConfig.Builder |
setWebSocketIdleTimeoutInMs(int webSocketIdleTimeoutInMs)
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 |
---|
public AsyncHttpClientConfig.Builder()
public AsyncHttpClientConfig.Builder(AsyncHttpClientConfig prototype)
prototype
- the configuration to use as a prototype.Method Detail |
---|
public AsyncHttpClientConfig.Builder setMaximumConnectionsTotal(int maxTotalConnections)
AsyncHttpClient
can handle.
maxTotalConnections
- the maximum number of connections an AsyncHttpClient
can handle.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setMaximumConnectionsPerHost(int maxConnectionPerHost)
AsyncHttpClient
can handle.
maxConnectionPerHost
- the maximum number of connections per host an AsyncHttpClient
can handle.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setConnectionTimeoutInMs(int connectionTimeOutInMs)
AsyncHttpClient
can wait when connecting to a remote host
connectionTimeOutInMs
- the maximum time in millisecond an AsyncHttpClient
can wait when connecting to a remote host
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setWebSocketIdleTimeoutInMs(int webSocketIdleTimeoutInMs)
WebSocket
can stay idle.
webSocketIdleTimeoutInMs
- the maximum time in millisecond an WebSocket
can stay idle.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setIdleConnectionTimeoutInMs(int idleConnectionTimeoutInMs)
AsyncHttpClient
can stay idle.
idleConnectionTimeoutInMs
- the maximum time in millisecond an AsyncHttpClient
can stay idle.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setIdleConnectionInPoolTimeoutInMs(int idleConnectionInPoolTimeoutInMs)
AsyncHttpClient
will keep connection
idle in pool.
idleConnectionInPoolTimeoutInMs
- the maximum time in millisecond an AsyncHttpClient
will keep connection
idle in pool.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setRequestTimeoutInMs(int requestTimeoutInMs)
AsyncHttpClient
wait for a response
requestTimeoutInMs
- the maximum time in millisecond an AsyncHttpClient
wait for a response
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setFollowRedirect(boolean followRedirect)
redirectEnabled
- true if enabled.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setMaximumNumberOfRedirects(int maxDefaultRedirects)
maxDefaultRedirects
- the maximum number of HTTP redirect
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setCompressionEnabled(boolean compressionEnabled)
compressionEnabled
- true if compression is enabled
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setUserAgent(String userAgent)
userAgent
- the USER_AGENT header value
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setAllowPoolingConnection(boolean allowPoolingConnection)
ConnectionsPool
. Default is true.
allowPoolingConnection
- true if connection can be pooled by a ConnectionsPool
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setExecutorService(ExecutorService applicationThreadPool)
ExecutorService
an AsyncHttpClient
use for handling
asynchronous response.
applicationThreadPool
- the ExecutorService
an AsyncHttpClient
use for handling
asynchronous response.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setProxyServerSelector(ProxyServerSelector proxyServerSelector)
ProxyServerSelector
used by an AsyncHttpClient
proxyServerSelector
- instance of ProxyServerSelector
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setProxyServer(ProxyServer proxyServer)
ProxyServer
used by an AsyncHttpClient
proxyServer
- instance of ProxyServer
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setSSLContext(SSLContext sslContext)
SSLContext
for secure connection.
sslContext
- the SSLContext
for secure connection
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setAsyncHttpClientProviderConfig(AsyncHttpProviderConfig<?,?> providerConfig)
AsyncHttpProviderConfig
providerConfig
- the AsyncHttpProviderConfig
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setConnectionsPool(ConnectionsPool<?,?> connectionsPool)
ConnectionsPool
connectionsPool
- the ConnectionsPool
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setRealm(Realm realm)
Realm
that will be used for all requests.
realm
- the Realm
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder addRequestFilter(RequestFilter requestFilter)
RequestFilter
that will be invoked before AsyncHttpClient.executeRequest(Request)
requestFilter
- RequestFilter
public AsyncHttpClientConfig.Builder removeRequestFilter(RequestFilter requestFilter)
RequestFilter
that will be invoked before AsyncHttpClient.executeRequest(Request)
requestFilter
- RequestFilter
public AsyncHttpClientConfig.Builder addResponseFilter(ResponseFilter responseFilter)
ResponseFilter
that will be invoked as soon as the response is
received, and before AsyncHandler.onStatusReceived(HttpResponseStatus)
.
responseFilter
- an ResponseFilter
public AsyncHttpClientConfig.Builder removeResponseFilter(ResponseFilter responseFilter)
ResponseFilter
that will be invoked as soon as the response is
received, and before AsyncHandler.onStatusReceived(HttpResponseStatus)
.
responseFilter
- an ResponseFilter
public AsyncHttpClientConfig.Builder addIOExceptionFilter(IOExceptionFilter ioExceptionFilter)
IOExceptionFilter
that will be invoked when an IOException
occurs during the download/upload operations.
ioExceptionFilter
- an ResponseFilter
public AsyncHttpClientConfig.Builder removeIOExceptionFilter(IOExceptionFilter ioExceptionFilter)
IOExceptionFilter
tthat will be invoked when an IOException
occurs during the download/upload operations.
ioExceptionFilter
- an ResponseFilter
public int getRequestCompressionLevel()
public AsyncHttpClientConfig.Builder setRequestCompressionLevel(int requestCompressionLevel)
requestCompressionLevel
- compression level, or -1 if no compression is use
public AsyncHttpClientConfig.Builder setMaxRequestRetry(int maxRequestRetry)
IOException
occurs because of a Network exception.
maxRequestRetry
- the number of time a request will be retried
public AsyncHttpClientConfig.Builder setAllowSslConnectionPool(boolean allowSslConnectionPool)
allowSslConnectionPool
- true if enabled
public AsyncHttpClientConfig.Builder setDisableUrlEncodingForBoundedRequests(boolean disableUrlEncodingForBoundedRequests)
disableUrlEncodingForBoundedRequests
-
public AsyncHttpClientConfig.Builder setRemoveQueryParamsOnRedirect(boolean removeQueryParamOnRedirect)
removeQueryParamOnRedirect
-
public AsyncHttpClientConfig.Builder setUseProxySelector(boolean useProxySelector)
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
public AsyncHttpClientConfig.Builder setUseProxyProperties(boolean useProxyProperties)
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
public AsyncHttpClientConfig.Builder setIOThreadMultiplier(int multiplier)
public AsyncHttpClientConfig.Builder setHostnameVerifier(HostnameVerifier hostnameVerifier)
HostnameVerifier
hostnameVerifier
- HostnameVerifier
public AsyncHttpClientConfig.Builder setStrict302Handling(boolean strict302Handling)
strict302Handling
- strict handling
public AsyncHttpClientConfig.Builder setUseRelativeURIsWithSSLProxies(boolean useRelativeURIsWithSSLProxies)
useRelativeURIsWithSSLProxies
-
public AsyncHttpClientConfig.Builder setMaxConnectionLifeTimeInMs(int maxConnectionLifeTimeInMs)
maxConnectionLifeTimeInMs
- the maximum time in millisecond connection can be added to the pool for further reuse
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setTimeConverter(TimeConverter timeConverter)
public AsyncHttpClientConfig.Builder setAcceptAnyCertificate(boolean acceptAnyCertificate)
public AsyncHttpClientConfig build()
AsyncHttpClientConfig
AsyncHttpClientConfig
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |