public static class AsyncHttpClientConfig.Builder extends Object
AsyncHttpClient
Constructor and Description |
---|
Builder() |
Builder(AsyncHttpClientConfig prototype)
Create a config builder with values taken from the given prototype
configuration.
|
public Builder()
public Builder(AsyncHttpClientConfig prototype)
prototype
- the configuration to use as a prototype.public AsyncHttpClientConfig.Builder setName(String name)
AsyncHttpClient
. That name is used for thread
naming and can be used for debugging multiple AsyncHttpClient
instance.public AsyncHttpClientConfig.Builder setMaxConnections(int maxConnections)
AsyncHttpClient
can
handle.maxConnections
- the maximum number of connections an
AsyncHttpClient
can handle.AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setMaxConnectionsPerHost(int maxConnectionsPerHost)
AsyncHttpClient
can handle.maxConnectionsPerHost
- the maximum number of connections per
(scheme, host, port) an AsyncHttpClient
can
handle.AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setConnectTimeout(int connectTimeout)
AsyncHttpClient
can
wait when connecting to a remote hostconnectTimeout
- the maximum time in millisecond an
AsyncHttpClient
can wait when connecting to a
remote hostAsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setWebSocketTimeout(int webSocketTimeout)
WebSocket
can stay idle.webSocketTimeout
- the maximum time in millisecond an
WebSocket
can stay idle.AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setReadTimeout(int readTimeout)
AsyncHttpClient
can
stay idle.readTimeout
- the maximum time in millisecond an
AsyncHttpClient
can stay idle.AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setPooledConnectionIdleTimeout(int pooledConnectionIdleTimeout)
AsyncHttpClient
will
keep connection idle in pool.pooledConnectionIdleTimeout
- the maximum time in millisecond an
AsyncHttpClient
will keep connection idle in pool.AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setRequestTimeout(int requestTimeout)
AsyncHttpClient
waits
until the response is completed.requestTimeout
- the maximum time in millisecond an
AsyncHttpClient
waits until the response is
completed.AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setFollowRedirect(boolean followRedirect)
redirectEnabled
- true if enabled.AsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setMaxRedirects(int maxRedirects)
maxRedirects
- the maximum number of HTTP redirectAsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setCompressionEnforced(boolean compressionEnforced)
compressionEnabled
- true if compression is enforcedAsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setUserAgent(String userAgent)
userAgent
- the USER_AGENT header valueAsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setAllowPoolingConnections(boolean allowPoolingConnections)
ConnectionsPool
.
Default is true.allowPoolingConnections
- 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 connectionAsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setAdvancedConfig(AdvancedConfig advancedConfig)
AdvancedConfig
advancedConfig
- the AdvancedConfig
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 AsyncHttpClientConfig.Builder setMaxRequestRetry(int maxRequestRetry)
IOException
occurs because of a Network exception.maxRequestRetry
- the number of times a request will be retriedpublic AsyncHttpClientConfig.Builder setAllowPoolingSslConnections(boolean allowPoolingSslConnections)
pooledConnectionIdleTimeout
- true if enabledpublic AsyncHttpClientConfig.Builder setDisableUrlEncodingForBoundRequests(boolean disableUrlEncodingForBoundRequests)
disableUrlEncodingForBoundRequests
- 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.
htmlpublic 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.
htmlpublic AsyncHttpClientConfig.Builder setIOThreadMultiplier(int multiplier)
public AsyncHttpClientConfig.Builder setStrict302Handling(boolean strict302Handling)
strict302Handling
- strict handlingpublic AsyncHttpClientConfig.Builder setConnectionTTL(int connectionTTL)
connectionTTL
- the maximum time in millisecond connection can
be added to the pool for further reuseAsyncHttpClientConfig.Builder
public AsyncHttpClientConfig.Builder setAcceptAnyCertificate(boolean acceptAnyCertificate)
public AsyncHttpClientConfig.Builder setEnabledProtocols(String[] enabledProtocols)
public AsyncHttpClientConfig.Builder setEnabledCipherSuites(String[] enabledCipherSuites)
public AsyncHttpClientConfig.Builder setSslSessionCacheSize(Integer sslSessionCacheSize)
public AsyncHttpClientConfig.Builder setSslSessionTimeout(Integer sslSessionTimeout)
public AsyncHttpClientConfig.Builder setHttpClientCodecMaxInitialLineLength(int httpClientCodecMaxInitialLineLength)
public AsyncHttpClientConfig.Builder setHttpClientCodecMaxHeaderSize(int httpClientCodecMaxHeaderSize)
public AsyncHttpClientConfig.Builder setHttpClientCodecMaxChunkSize(int httpClientCodecMaxChunkSize)
public AsyncHttpClientConfig.Builder setDisableZeroCopy(boolean disableZeroCopy)
public AsyncHttpClientConfig.Builder setHandshakeTimeout(long handshakeTimeout)
public AsyncHttpClientConfig.Builder setSslEngineFactory(SSLEngineFactory sslEngineFactory)
public AsyncHttpClientConfig.Builder setChunkedFileChunkSize(int chunkedFileChunkSize)
public AsyncHttpClientConfig.Builder setWebSocketMaxBufferSize(int webSocketMaxBufferSize)
public AsyncHttpClientConfig.Builder setWebSocketMaxFrameSize(int webSocketMaxFrameSize)
public AsyncHttpClientConfig.Builder setKeepEncodingHeader(boolean keepEncodingHeader)
public AsyncHttpClientConfig.Builder setShutdownQuiet(int shutdownQuiet)
shutdownQuiet
- the quiet period in ms before actually shutting downpublic AsyncHttpClientConfig.Builder setShutdownTimeout(int shutdownTimeout)
shutdownTimeout
- the shutdown timeout in mspublic AsyncHttpClientConfig build()
AsyncHttpClientConfig
AsyncHttpClientConfig
Copyright © 2015. All Rights Reserved.