|
||||||||||
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. |
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 defaultMaxTotalConnections)
AsyncHttpClient
can handle.
defaultMaxTotalConnections
- the maximum number of connections an AsyncHttpClient
can handle.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setMaximumConnectionsPerHost(int defaultMaxConnectionPerHost)
AsyncHttpClient
can handle.
defaultMaxConnectionPerHost
- the maximum number of connections per host an AsyncHttpClient
can handle.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setConnectionTimeoutInMs(int defaultConnectionTimeOutInMs)
AsyncHttpClient
can wait when connecting to a remote host
defaultConnectionTimeOutInMs
- the maximum time in millisecond an AsyncHttpClient
can wait when connecting to a remote host
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setIdleConnectionTimeoutInMs(int defaultIdleConnectionTimeoutInMs)
setIdleConnectionInPoolTimeoutInMs(int)
AsyncHttpClient
can stay idle.
defaultIdleConnectionTimeoutInMs
- the maximum time in millisecond an AsyncHttpClient
can stay idle.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setIdleConnectionInPoolTimeoutInMs(int defaultIdleConnectionInPoolTimeoutInMs)
AsyncHttpClient
will keep connection
idle in pool.
defaultIdleConnectionInPoolTimeoutInMs
- the maximum time in millisecond an AsyncHttpClient
will keep connection
idle in pool.
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setRequestTimeoutInMs(int defaultRequestTimeoutInMs)
AsyncHttpClient
wait for a response
defaultRequestTimeoutInMs
- the maximum time in millisecond an AsyncHttpClient
wait for a response
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setFollowRedirects(boolean redirectEnabled)
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 setKeepAlive(boolean allowPoolingConnection)
setAllowPoolingConnection(boolean)
ConnectionsPool
. Default is true.
allowPoolingConnection
- true if connection can be pooled by a ConnectionsPool
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setScheduledExecutorService(ScheduledExecutorService reaper)
ScheduledExecutorService
used to expire idle connections.
reaper
- theScheduledExecutorService
used to expire idle connections.
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 setProxyServer(ProxyServer proxyServer)
ProxyServer
used by an AsyncHttpClient
proxyServer
- instance of ProxyServer
AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setSSLEngineFactory(SSLEngineFactory sslEngineFactory)
SSLEngineFactory
for secure connection.
sslEngineFactory
- the SSLEngineFactory
for secure connection
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 setUseRawUrl(boolean useRawUrl)
useRawUrl
-
public AsyncHttpClientConfig build()
AsyncHttpClientConfig
AsyncHttpClientConfig
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |