Package org.asynchttpclient
Interface AsyncHttpClientConfig
-
- All Known Implementing Classes:
DefaultAsyncHttpClientConfig
public interface AsyncHttpClientConfig
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classAsyncHttpClientConfig.ResponseBodyPartFactory
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description intexpiredCookieEvictionDelay()Return the delay in milliseconds to evict expired cookies from CookieStoreintgetAcquireFreeChannelTimeout()Return the maximum duration in milliseconds anAsyncHttpClientcan wait to acquire a free channelStringgetAhcVersion()@Nullable io.netty.buffer.ByteBufAllocatorgetAllocator()Map<io.netty.channel.ChannelOption<Object>,Object>getChannelOptions()@Nullable ChannelPoolgetChannelPool()intgetChunkedFileChunkSize()DurationgetConnectionPoolCleanerPeriod()@Nullable ConnectionSemaphoreFactorygetConnectionSemaphoreFactory()DurationgetConnectionTtl()DurationgetConnectTimeout()Return the maximum time anAsyncHttpClientcan wait when connecting to a remote hostCookieStoregetCookieStore()Return cookie store that is used to store and retrieve cookies@Nullable String[]getEnabledCipherSuites()@Nullable String[]getEnabledProtocols()@Nullable io.netty.channel.EventLoopGroupgetEventLoopGroup()intgetHandshakeTimeout()intgetHashedWheelTimerSize()longgetHashedWheelTimerTickDuration()@Nullable Consumer<io.netty.channel.Channel>getHttpAdditionalChannelInitializer()intgetHttpClientCodecInitialBufferSize()intgetHttpClientCodecMaxChunkSize()intgetHttpClientCodecMaxHeaderSize()intgetHttpClientCodecMaxInitialLineLength()List<IOExceptionFilter>getIoExceptionFilters()Return the list ofIOExceptionintgetIoThreadsCount()KeepAliveStrategygetKeepAliveStrategy()intgetMaxConnections()Return the maximum number of connections anAsyncHttpClientcan handle.intgetMaxConnectionsPerHost()Return the maximum number of connections per hosts anAsyncHttpClientcan handle.intgetMaxRedirects()Get the maximum number of HTTP redirectintgetMaxRequestRetry()Return the number of time the library will retry when anIOExceptionis throw by the remote server@Nullable io.netty.util.TimergetNettyTimer()DurationgetPooledConnectionIdleTimeout()Return the maximum time anAsyncHttpClientwill keep connection in pool.ProxyServerSelectorgetProxyServerSelector()An instance ofProxyServerused by anAsyncHttpClientDurationgetReadTimeout()Return the maximum time anAsyncHttpClientcan stay idle.@Nullable RealmgetRealm()Return the currentRealmList<RequestFilter>getRequestFilters()Return the list ofRequestFilterDurationgetRequestTimeout()Return the maximum time anAsyncHttpClientwaits until the response is completed.AsyncHttpClientConfig.ResponseBodyPartFactorygetResponseBodyPartFactory()List<ResponseFilter>getResponseFilters()Return the list ofResponseFilterDurationgetShutdownQuietPeriod()DurationgetShutdownTimeout()intgetSoLinger()intgetSoRcvBuf()intgetSoSndBuf()@Nullable io.netty.handler.ssl.SslContextgetSslContext()Return an instance ofSslContextused for SSL connection.@Nullable SslEngineFactorygetSslEngineFactory()intgetSslSessionCacheSize()intgetSslSessionTimeout()@Nullable ThreadFactorygetThreadFactory()Return theThreadFactoryanAsyncHttpClientuse for handling asynchronous response.StringgetThreadPoolName()Return the name ofAsyncHttpClient, which is used for thread naming and debugging.StringgetUserAgent()Return the USER_AGENT header valueintgetWebSocketMaxBufferSize()intgetWebSocketMaxFrameSize()@Nullable Consumer<io.netty.channel.Channel>getWsAdditionalChannelInitializer()booleanisAggregateWebSocketFrameFragments()booleanisCompressionEnforced()Is HTTP compression enforced.booleanisDisableHttpsEndpointIdentificationAlgorithm()booleanisDisableUrlEncodingForBoundRequests()booleanisDisableZeroCopy()booleanisEnableAutomaticDecompression()If automatic content decompression is enabled.booleanisEnableWebSocketCompression()booleanisFilterInsecureCipherSuites()booleanisFollowRedirect()Is HTTP redirect enabledbooleanisKeepAlive()Is theChannelPoolsupport enabled.booleanisKeepEncodingHeader()booleanisSoKeepAlive()booleanisSoReuseAddress()booleanisStrict302Handling()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.booleanisTcpNoDelay()booleanisUseInsecureTrustManager()booleanisUseLaxCookieEncoder()booleanisUseNativeTransport()booleanisUseOnlyEpollNativeTransport()booleanisUseOpenSsl()booleanisValidateResponseHeaders()
-
-
-
Method Detail
-
getAhcVersion
String getAhcVersion()
- Returns:
- the version of AHC
-
getThreadPoolName
String getThreadPoolName()
Return the name ofAsyncHttpClient, which is used for thread naming and debugging.- Returns:
- the name.
-
getMaxConnections
int getMaxConnections()
Return the maximum number of connections anAsyncHttpClientcan handle.- Returns:
- the maximum number of connections an
AsyncHttpClientcan handle.
-
getMaxConnectionsPerHost
int getMaxConnectionsPerHost()
Return the maximum number of connections per hosts anAsyncHttpClientcan handle.- Returns:
- the maximum number of connections per host an
AsyncHttpClientcan handle.
-
getAcquireFreeChannelTimeout
int getAcquireFreeChannelTimeout()
Return the maximum duration in milliseconds anAsyncHttpClientcan wait to acquire a free channel- Returns:
- Return the maximum duration in milliseconds an
AsyncHttpClientcan wait to acquire a free channel
-
getConnectTimeout
Duration getConnectTimeout()
Return the maximum time anAsyncHttpClientcan wait when connecting to a remote host- Returns:
- the maximum time an
AsyncHttpClientcan wait when connecting to a remote host
-
getReadTimeout
Duration getReadTimeout()
Return the maximum time anAsyncHttpClientcan stay idle.- Returns:
- the maximum time an
AsyncHttpClientcan stay idle.
-
getPooledConnectionIdleTimeout
Duration getPooledConnectionIdleTimeout()
Return the maximum time anAsyncHttpClientwill keep connection in pool.- Returns:
- the maximum time an
AsyncHttpClientwill keep connection in pool.
-
getConnectionPoolCleanerPeriod
Duration getConnectionPoolCleanerPeriod()
- Returns:
- the period to clean the pool of dead and idle connections.
-
getRequestTimeout
Duration getRequestTimeout()
Return the maximum time anAsyncHttpClientwaits until the response is completed.- Returns:
- the maximum time an
AsyncHttpClientwaits until the response is completed.
-
isFollowRedirect
boolean isFollowRedirect()
Is HTTP redirect enabled- Returns:
- true if enabled.
-
getMaxRedirects
int getMaxRedirects()
Get the maximum number of HTTP redirect- Returns:
- the maximum number of HTTP redirect
-
isKeepAlive
boolean isKeepAlive()
Is theChannelPoolsupport enabled.- Returns:
- true if keep-alive is enabled
-
getUserAgent
String getUserAgent()
Return the USER_AGENT header value- Returns:
- the USER_AGENT header value
-
isCompressionEnforced
boolean isCompressionEnforced()
Is HTTP compression enforced.- Returns:
- true if compression is enforced
-
isEnableAutomaticDecompression
boolean isEnableAutomaticDecompression()
If automatic content decompression is enabled.- Returns:
- true if content decompression is enabled
-
getThreadFactory
@Nullable @Nullable ThreadFactory getThreadFactory()
Return theThreadFactoryanAsyncHttpClientuse for handling asynchronous response.- Returns:
- the
ThreadFactoryanAsyncHttpClientuse for handling asynchronous response. If noThreadFactoryhas been explicitly provided, this method will returnnull
-
getProxyServerSelector
ProxyServerSelector getProxyServerSelector()
An instance ofProxyServerused by anAsyncHttpClient- Returns:
- instance of
ProxyServer
-
getSslContext
@Nullable @Nullable io.netty.handler.ssl.SslContext getSslContext()
Return an instance ofSslContextused for SSL connection.- Returns:
- an instance of
SslContextused for SSL connection.
-
getRequestFilters
List<RequestFilter> getRequestFilters()
Return the list ofRequestFilter- Returns:
- Unmodifiable list of
RequestFilter
-
getResponseFilters
List<ResponseFilter> getResponseFilters()
Return the list ofResponseFilter- Returns:
- Unmodifiable list of
ResponseFilter
-
getIoExceptionFilters
List<IOExceptionFilter> getIoExceptionFilters()
Return the list ofIOException- Returns:
- Unmodifiable list of
IOException
-
getCookieStore
CookieStore getCookieStore()
Return cookie store that is used to store and retrieve cookies- Returns:
CookieStoreobject
-
expiredCookieEvictionDelay
int expiredCookieEvictionDelay()
Return the delay in milliseconds to evict expired cookies from CookieStore- Returns:
- the delay in milliseconds to evict expired cookies from CookieStore
-
getMaxRequestRetry
int getMaxRequestRetry()
Return the number of time the library will retry when anIOExceptionis throw by the remote server- Returns:
- the number of time the library will retry when an
IOExceptionis throw by the remote server
-
isDisableUrlEncodingForBoundRequests
boolean isDisableUrlEncodingForBoundRequests()
- Returns:
- the disableUrlEncodingForBoundRequests
-
isUseLaxCookieEncoder
boolean isUseLaxCookieEncoder()
- Returns:
- true if AHC is to use a LAX cookie encoder, e.g. accept illegal chars in cookie value
-
isStrict302Handling
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:
trueif strict 302 handling is to be used, otherwisefalse.
-
getConnectionTtl
Duration getConnectionTtl()
- Returns:
- the maximum time an
AsyncHttpClientwill keep connection in the pool, or negative value to keep connection while possible.
-
isUseOpenSsl
boolean isUseOpenSsl()
-
isUseInsecureTrustManager
boolean isUseInsecureTrustManager()
-
isDisableHttpsEndpointIdentificationAlgorithm
boolean isDisableHttpsEndpointIdentificationAlgorithm()
- Returns:
- true to disable all HTTPS behaviors AT ONCE, such as hostname verification and SNI
-
getEnabledProtocols
@Nullable @Nullable String[] getEnabledProtocols()
- Returns:
- the array of enabled protocols
-
getEnabledCipherSuites
@Nullable @Nullable String[] getEnabledCipherSuites()
- Returns:
- the array of enabled cipher suites
-
isFilterInsecureCipherSuites
boolean isFilterInsecureCipherSuites()
- Returns:
- if insecure cipher suites must be filtered out (only used when not explicitly passing enabled cipher suites)
-
getSslSessionCacheSize
int getSslSessionCacheSize()
- Returns:
- the size of the SSL session cache, 0 means using the default value
-
getSslSessionTimeout
int getSslSessionTimeout()
- Returns:
- the SSL session timeout in seconds, 0 means using the default value
-
getHttpClientCodecMaxInitialLineLength
int getHttpClientCodecMaxInitialLineLength()
-
getHttpClientCodecMaxHeaderSize
int getHttpClientCodecMaxHeaderSize()
-
getHttpClientCodecMaxChunkSize
int getHttpClientCodecMaxChunkSize()
-
getHttpClientCodecInitialBufferSize
int getHttpClientCodecInitialBufferSize()
-
isDisableZeroCopy
boolean isDisableZeroCopy()
-
getHandshakeTimeout
int getHandshakeTimeout()
-
getSslEngineFactory
@Nullable @Nullable SslEngineFactory getSslEngineFactory()
-
getChunkedFileChunkSize
int getChunkedFileChunkSize()
-
getWebSocketMaxBufferSize
int getWebSocketMaxBufferSize()
-
getWebSocketMaxFrameSize
int getWebSocketMaxFrameSize()
-
isKeepEncodingHeader
boolean isKeepEncodingHeader()
-
getShutdownQuietPeriod
Duration getShutdownQuietPeriod()
-
getShutdownTimeout
Duration getShutdownTimeout()
-
getEventLoopGroup
@Nullable @Nullable io.netty.channel.EventLoopGroup getEventLoopGroup()
-
isUseNativeTransport
boolean isUseNativeTransport()
-
isUseOnlyEpollNativeTransport
boolean isUseOnlyEpollNativeTransport()
-
getHttpAdditionalChannelInitializer
@Nullable @Nullable Consumer<io.netty.channel.Channel> getHttpAdditionalChannelInitializer()
-
getWsAdditionalChannelInitializer
@Nullable @Nullable Consumer<io.netty.channel.Channel> getWsAdditionalChannelInitializer()
-
getResponseBodyPartFactory
AsyncHttpClientConfig.ResponseBodyPartFactory getResponseBodyPartFactory()
-
getChannelPool
@Nullable @Nullable ChannelPool getChannelPool()
-
getConnectionSemaphoreFactory
@Nullable @Nullable ConnectionSemaphoreFactory getConnectionSemaphoreFactory()
-
getNettyTimer
@Nullable @Nullable io.netty.util.Timer getNettyTimer()
-
getHashedWheelTimerTickDuration
long getHashedWheelTimerTickDuration()
- Returns:
- the duration between tick of
HashedWheelTimer
-
getHashedWheelTimerSize
int getHashedWheelTimerSize()
- Returns:
- the size of the hashed wheel
HashedWheelTimer
-
getKeepAliveStrategy
KeepAliveStrategy getKeepAliveStrategy()
-
isValidateResponseHeaders
boolean isValidateResponseHeaders()
-
isAggregateWebSocketFrameFragments
boolean isAggregateWebSocketFrameFragments()
-
isEnableWebSocketCompression
boolean isEnableWebSocketCompression()
-
isTcpNoDelay
boolean isTcpNoDelay()
-
isSoReuseAddress
boolean isSoReuseAddress()
-
isSoKeepAlive
boolean isSoKeepAlive()
-
getSoLinger
int getSoLinger()
-
getSoSndBuf
int getSoSndBuf()
-
getSoRcvBuf
int getSoRcvBuf()
-
getAllocator
@Nullable @Nullable io.netty.buffer.ByteBufAllocator getAllocator()
-
getIoThreadsCount
int getIoThreadsCount()
-
-