Package org.asynchttpclient

Class DefaultAsyncHttpClientConfig.Builder

java.lang.Object

org.asynchttpclient.DefaultAsyncHttpClientConfig.Builder

Enclosing class:

DefaultAsyncHttpClientConfig

public static class DefaultAsyncHttpClientConfig.Builder
extends Object

Builder for an AsyncHttpClient

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(AsyncHttpClientConfig config)

Method Summary

Modifier and Type	Method	Description
<T> DefaultAsyncHttpClientConfig.Builder	addChannelOption(io.netty.channel.ChannelOption<T> name, T value)
DefaultAsyncHttpClientConfig.Builder	addIOExceptionFilter(IOExceptionFilter ioExceptionFilter)
DefaultAsyncHttpClientConfig.Builder	addRequestFilter(RequestFilter requestFilter)
DefaultAsyncHttpClientConfig.Builder	addResponseFilter(ResponseFilter responseFilter)
DefaultAsyncHttpClientConfig	build()
DefaultAsyncHttpClientConfig.Builder	removeIOExceptionFilter(IOExceptionFilter ioExceptionFilter)
DefaultAsyncHttpClientConfig.Builder	removeRequestFilter(RequestFilter requestFilter)
DefaultAsyncHttpClientConfig.Builder	removeResponseFilter(ResponseFilter responseFilter)
DefaultAsyncHttpClientConfig.Builder	setAcquireFreeChannelTimeout(int acquireFreeChannelTimeout)	Sets the maximum duration in milliseconds to acquire a free channel to send a request
DefaultAsyncHttpClientConfig.Builder	setAggregateWebSocketFrameFragments(boolean aggregateWebSocketFrameFragments)
DefaultAsyncHttpClientConfig.Builder	setAllocator(io.netty.buffer.ByteBufAllocator allocator)
DefaultAsyncHttpClientConfig.Builder	setChannelPool(ChannelPool channelPool)
DefaultAsyncHttpClientConfig.Builder	setChunkedFileChunkSize(int chunkedFileChunkSize)
DefaultAsyncHttpClientConfig.Builder	setCompressionEnforced(boolean compressionEnforced)	If true, AHC will add Accept-Encoding HTTP header to each request
DefaultAsyncHttpClientConfig.Builder	setConnectionPoolCleanerPeriod(Duration connectionPoolCleanerPeriod)
DefaultAsyncHttpClientConfig.Builder	setConnectionSemaphoreFactory(ConnectionSemaphoreFactory connectionSemaphoreFactory)
DefaultAsyncHttpClientConfig.Builder	setConnectionTtl(Duration connectionTtl)
DefaultAsyncHttpClientConfig.Builder	setConnectTimeout(Duration connectTimeout)
DefaultAsyncHttpClientConfig.Builder	setCookieStore(CookieStore cookieStore)
DefaultAsyncHttpClientConfig.Builder	setDisableHttpsEndpointIdentificationAlgorithm(boolean disableHttpsEndpointIdentificationAlgorithm)
DefaultAsyncHttpClientConfig.Builder	setDisableUrlEncodingForBoundRequests(boolean disableUrlEncodingForBoundRequests)
DefaultAsyncHttpClientConfig.Builder	setDisableZeroCopy(boolean disableZeroCopy)
DefaultAsyncHttpClientConfig.Builder	setEnableAutomaticDecompression(boolean enable)
DefaultAsyncHttpClientConfig.Builder	setEnabledCipherSuites(String[] enabledCipherSuites)
DefaultAsyncHttpClientConfig.Builder	setEnabledProtocols(String[] enabledProtocols)
DefaultAsyncHttpClientConfig.Builder	setEnablewebSocketCompression(boolean enablewebSocketCompression)
DefaultAsyncHttpClientConfig.Builder	setEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)
DefaultAsyncHttpClientConfig.Builder	setExpiredCookieEvictionDelay(int expiredCookieEvictionDelay)
DefaultAsyncHttpClientConfig.Builder	setFilterInsecureCipherSuites(boolean filterInsecureCipherSuites)
DefaultAsyncHttpClientConfig.Builder	setFollowRedirect(boolean followRedirect)
DefaultAsyncHttpClientConfig.Builder	setHandshakeTimeout(int handshakeTimeout)
DefaultAsyncHttpClientConfig.Builder	setHashedWheelSize(int hashedWheelSize)
DefaultAsyncHttpClientConfig.Builder	setHashedWheelTickDuration(long hashedWheelTickDuration)
DefaultAsyncHttpClientConfig.Builder	setHttpAdditionalChannelInitializer(Consumer<io.netty.channel.Channel> httpAdditionalChannelInitializer)
DefaultAsyncHttpClientConfig.Builder	setHttpClientCodecInitialBufferSize(int httpClientCodecInitialBufferSize)
DefaultAsyncHttpClientConfig.Builder	setHttpClientCodecMaxChunkSize(int httpClientCodecMaxChunkSize)
DefaultAsyncHttpClientConfig.Builder	setHttpClientCodecMaxHeaderSize(int httpClientCodecMaxHeaderSize)
DefaultAsyncHttpClientConfig.Builder	setHttpClientCodecMaxInitialLineLength(int httpClientCodecMaxInitialLineLength)
DefaultAsyncHttpClientConfig.Builder	setIoThreadsCount(int ioThreadsCount)
DefaultAsyncHttpClientConfig.Builder	setKeepAlive(boolean keepAlive)
DefaultAsyncHttpClientConfig.Builder	setKeepAliveStrategy(KeepAliveStrategy keepAliveStrategy)
DefaultAsyncHttpClientConfig.Builder	setKeepEncodingHeader(boolean keepEncodingHeader)
DefaultAsyncHttpClientConfig.Builder	setMaxConnections(int maxConnections)
DefaultAsyncHttpClientConfig.Builder	setMaxConnectionsPerHost(int maxConnectionsPerHost)
DefaultAsyncHttpClientConfig.Builder	setMaxRedirects(int maxRedirects)
DefaultAsyncHttpClientConfig.Builder	setMaxRequestRetry(int maxRequestRetry)
DefaultAsyncHttpClientConfig.Builder	setNettyTimer(io.netty.util.Timer nettyTimer)
DefaultAsyncHttpClientConfig.Builder	setPooledConnectionIdleTimeout(Duration pooledConnectionIdleTimeout)
DefaultAsyncHttpClientConfig.Builder	setProxyServer(ProxyServer proxyServer)
DefaultAsyncHttpClientConfig.Builder	setProxyServer(ProxyServer.Builder proxyServerBuilder)
DefaultAsyncHttpClientConfig.Builder	setProxyServerSelector(ProxyServerSelector proxyServerSelector)
DefaultAsyncHttpClientConfig.Builder	setReadTimeout(Duration readTimeout)
DefaultAsyncHttpClientConfig.Builder	setRealm(Realm realm)
DefaultAsyncHttpClientConfig.Builder	setRealm(Realm.Builder realmBuilder)
DefaultAsyncHttpClientConfig.Builder	setRequestTimeout(Duration requestTimeout)
DefaultAsyncHttpClientConfig.Builder	setResponseBodyPartFactory(AsyncHttpClientConfig.ResponseBodyPartFactory responseBodyPartFactory)
DefaultAsyncHttpClientConfig.Builder	setShutdownQuietPeriod(Duration shutdownQuietPeriod)
DefaultAsyncHttpClientConfig.Builder	setShutdownTimeout(Duration shutdownTimeout)
DefaultAsyncHttpClientConfig.Builder	setSoKeepAlive(boolean soKeepAlive)
DefaultAsyncHttpClientConfig.Builder	setSoLinger(int soLinger)
DefaultAsyncHttpClientConfig.Builder	setSoRcvBuf(int soRcvBuf)
DefaultAsyncHttpClientConfig.Builder	setSoReuseAddress(boolean soReuseAddress)
DefaultAsyncHttpClientConfig.Builder	setSoSndBuf(int soSndBuf)
DefaultAsyncHttpClientConfig.Builder	setSslContext(io.netty.handler.ssl.SslContext sslContext)
DefaultAsyncHttpClientConfig.Builder	setSslEngineFactory(SslEngineFactory sslEngineFactory)
DefaultAsyncHttpClientConfig.Builder	setSslSessionCacheSize(Integer sslSessionCacheSize)
DefaultAsyncHttpClientConfig.Builder	setSslSessionTimeout(Integer sslSessionTimeout)
DefaultAsyncHttpClientConfig.Builder	setStrict302Handling(boolean strict302Handling)
DefaultAsyncHttpClientConfig.Builder	setTcpNoDelay(boolean tcpNoDelay)
DefaultAsyncHttpClientConfig.Builder	setThreadFactory(ThreadFactory threadFactory)
DefaultAsyncHttpClientConfig.Builder	setThreadPoolName(String threadPoolName)
DefaultAsyncHttpClientConfig.Builder	setUseInsecureTrustManager(boolean useInsecureTrustManager)
DefaultAsyncHttpClientConfig.Builder	setUseLaxCookieEncoder(boolean useLaxCookieEncoder)
DefaultAsyncHttpClientConfig.Builder	setUseNativeTransport(boolean useNativeTransport)
DefaultAsyncHttpClientConfig.Builder	setUseOnlyEpollNativeTransport(boolean useOnlyEpollNativeTransport)
DefaultAsyncHttpClientConfig.Builder	setUseOpenSsl(boolean useOpenSsl)
DefaultAsyncHttpClientConfig.Builder	setUseProxyProperties(boolean useProxyProperties)
DefaultAsyncHttpClientConfig.Builder	setUseProxySelector(boolean useProxySelector)
DefaultAsyncHttpClientConfig.Builder	setUserAgent(String userAgent)
DefaultAsyncHttpClientConfig.Builder	setValidateResponseHeaders(boolean validateResponseHeaders)
DefaultAsyncHttpClientConfig.Builder	setWebSocketMaxBufferSize(int webSocketMaxBufferSize)
DefaultAsyncHttpClientConfig.Builder	setWebSocketMaxFrameSize(int webSocketMaxFrameSize)
DefaultAsyncHttpClientConfig.Builder	setWsAdditionalChannelInitializer(Consumer<io.netty.channel.Channel> wsAdditionalChannelInitializer)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(AsyncHttpClientConfig config)

Method Detail

setFollowRedirect

public DefaultAsyncHttpClientConfig.Builder setFollowRedirect(boolean followRedirect)

setMaxRedirects

public DefaultAsyncHttpClientConfig.Builder setMaxRedirects(int maxRedirects)

setStrict302Handling

public DefaultAsyncHttpClientConfig.Builder setStrict302Handling(boolean strict302Handling)

setCompressionEnforced

public DefaultAsyncHttpClientConfig.Builder setCompressionEnforced(boolean compressionEnforced)

If true, AHC will add Accept-Encoding HTTP header to each request

If false (default), AHC will either leave AcceptEncoding header as is (if enableAutomaticDecompression is false) or will remove unsupported algorithms (if enableAutomaticDecompression is true)

setEnableAutomaticDecompression

public DefaultAsyncHttpClientConfig.Builder setEnableAutomaticDecompression(boolean enable)

setUserAgent

public DefaultAsyncHttpClientConfig.Builder setUserAgent(String userAgent)

setRealm

public DefaultAsyncHttpClientConfig.Builder setRealm(Realm realm)

setRealm

public DefaultAsyncHttpClientConfig.Builder setRealm(Realm.Builder realmBuilder)

setMaxRequestRetry

public DefaultAsyncHttpClientConfig.Builder setMaxRequestRetry(int maxRequestRetry)

setDisableUrlEncodingForBoundRequests

public DefaultAsyncHttpClientConfig.Builder setDisableUrlEncodingForBoundRequests(boolean disableUrlEncodingForBoundRequests)

setUseLaxCookieEncoder

public DefaultAsyncHttpClientConfig.Builder setUseLaxCookieEncoder(boolean useLaxCookieEncoder)

setDisableZeroCopy

public DefaultAsyncHttpClientConfig.Builder setDisableZeroCopy(boolean disableZeroCopy)

setKeepEncodingHeader

public DefaultAsyncHttpClientConfig.Builder setKeepEncodingHeader(boolean keepEncodingHeader)

setProxyServerSelector

public DefaultAsyncHttpClientConfig.Builder setProxyServerSelector(ProxyServerSelector proxyServerSelector)

setValidateResponseHeaders

public DefaultAsyncHttpClientConfig.Builder setValidateResponseHeaders(boolean validateResponseHeaders)

setProxyServer

public DefaultAsyncHttpClientConfig.Builder setProxyServer(ProxyServer proxyServer)

setProxyServer

public DefaultAsyncHttpClientConfig.Builder setProxyServer(ProxyServer.Builder proxyServerBuilder)

setUseProxySelector

public DefaultAsyncHttpClientConfig.Builder setUseProxySelector(boolean useProxySelector)

setUseProxyProperties

public DefaultAsyncHttpClientConfig.Builder setUseProxyProperties(boolean useProxyProperties)

setAggregateWebSocketFrameFragments

public DefaultAsyncHttpClientConfig.Builder setAggregateWebSocketFrameFragments(boolean aggregateWebSocketFrameFragments)

setEnablewebSocketCompression

public DefaultAsyncHttpClientConfig.Builder setEnablewebSocketCompression(boolean enablewebSocketCompression)

setWebSocketMaxBufferSize

public DefaultAsyncHttpClientConfig.Builder setWebSocketMaxBufferSize(int webSocketMaxBufferSize)

setWebSocketMaxFrameSize

public DefaultAsyncHttpClientConfig.Builder setWebSocketMaxFrameSize(int webSocketMaxFrameSize)

setConnectTimeout

public DefaultAsyncHttpClientConfig.Builder setConnectTimeout(Duration connectTimeout)

setRequestTimeout

public DefaultAsyncHttpClientConfig.Builder setRequestTimeout(Duration requestTimeout)

setReadTimeout

public DefaultAsyncHttpClientConfig.Builder setReadTimeout(Duration readTimeout)

setShutdownQuietPeriod

public DefaultAsyncHttpClientConfig.Builder setShutdownQuietPeriod(Duration shutdownQuietPeriod)

setShutdownTimeout

public DefaultAsyncHttpClientConfig.Builder setShutdownTimeout(Duration shutdownTimeout)

setKeepAlive

public DefaultAsyncHttpClientConfig.Builder setKeepAlive(boolean keepAlive)

setPooledConnectionIdleTimeout

public DefaultAsyncHttpClientConfig.Builder setPooledConnectionIdleTimeout(Duration pooledConnectionIdleTimeout)

setConnectionPoolCleanerPeriod

public DefaultAsyncHttpClientConfig.Builder setConnectionPoolCleanerPeriod(Duration connectionPoolCleanerPeriod)

setConnectionTtl

public DefaultAsyncHttpClientConfig.Builder setConnectionTtl(Duration connectionTtl)

setMaxConnections

public DefaultAsyncHttpClientConfig.Builder setMaxConnections(int maxConnections)

setMaxConnectionsPerHost

public DefaultAsyncHttpClientConfig.Builder setMaxConnectionsPerHost(int maxConnectionsPerHost)

setAcquireFreeChannelTimeout

public DefaultAsyncHttpClientConfig.Builder setAcquireFreeChannelTimeout(int acquireFreeChannelTimeout)

Sets the maximum duration in milliseconds to acquire a free channel to send a request

Parameters:

acquireFreeChannelTimeout - maximum duration in milliseconds to acquire a free channel to send a request

Returns:

the same builder instance

setChannelPool

public DefaultAsyncHttpClientConfig.Builder setChannelPool(ChannelPool channelPool)

setConnectionSemaphoreFactory

public DefaultAsyncHttpClientConfig.Builder setConnectionSemaphoreFactory(ConnectionSemaphoreFactory connectionSemaphoreFactory)

setKeepAliveStrategy

public DefaultAsyncHttpClientConfig.Builder setKeepAliveStrategy(KeepAliveStrategy keepAliveStrategy)

setUseOpenSsl

public DefaultAsyncHttpClientConfig.Builder setUseOpenSsl(boolean useOpenSsl)

setUseInsecureTrustManager

public DefaultAsyncHttpClientConfig.Builder setUseInsecureTrustManager(boolean useInsecureTrustManager)

setDisableHttpsEndpointIdentificationAlgorithm

public DefaultAsyncHttpClientConfig.Builder setDisableHttpsEndpointIdentificationAlgorithm(boolean disableHttpsEndpointIdentificationAlgorithm)

setHandshakeTimeout

public DefaultAsyncHttpClientConfig.Builder setHandshakeTimeout(int handshakeTimeout)

setEnabledProtocols

public DefaultAsyncHttpClientConfig.Builder setEnabledProtocols(String[] enabledProtocols)

setEnabledCipherSuites

public DefaultAsyncHttpClientConfig.Builder setEnabledCipherSuites(String[] enabledCipherSuites)

setFilterInsecureCipherSuites

public DefaultAsyncHttpClientConfig.Builder setFilterInsecureCipherSuites(boolean filterInsecureCipherSuites)

setSslSessionCacheSize

public DefaultAsyncHttpClientConfig.Builder setSslSessionCacheSize(Integer sslSessionCacheSize)

setSslSessionTimeout

public DefaultAsyncHttpClientConfig.Builder setSslSessionTimeout(Integer sslSessionTimeout)

setSslContext

public DefaultAsyncHttpClientConfig.Builder setSslContext(io.netty.handler.ssl.SslContext sslContext)

setSslEngineFactory

public DefaultAsyncHttpClientConfig.Builder setSslEngineFactory(SslEngineFactory sslEngineFactory)

addRequestFilter

public DefaultAsyncHttpClientConfig.Builder addRequestFilter(RequestFilter requestFilter)

removeRequestFilter

public DefaultAsyncHttpClientConfig.Builder removeRequestFilter(RequestFilter requestFilter)

addResponseFilter

public DefaultAsyncHttpClientConfig.Builder addResponseFilter(ResponseFilter responseFilter)

removeResponseFilter

public DefaultAsyncHttpClientConfig.Builder removeResponseFilter(ResponseFilter responseFilter)

addIOExceptionFilter

public DefaultAsyncHttpClientConfig.Builder addIOExceptionFilter(IOExceptionFilter ioExceptionFilter)

removeIOExceptionFilter

public DefaultAsyncHttpClientConfig.Builder removeIOExceptionFilter(IOExceptionFilter ioExceptionFilter)

setCookieStore

public DefaultAsyncHttpClientConfig.Builder setCookieStore(CookieStore cookieStore)

setExpiredCookieEvictionDelay

public DefaultAsyncHttpClientConfig.Builder setExpiredCookieEvictionDelay(int expiredCookieEvictionDelay)

setTcpNoDelay

public DefaultAsyncHttpClientConfig.Builder setTcpNoDelay(boolean tcpNoDelay)

setSoReuseAddress

public DefaultAsyncHttpClientConfig.Builder setSoReuseAddress(boolean soReuseAddress)

setSoKeepAlive

public DefaultAsyncHttpClientConfig.Builder setSoKeepAlive(boolean soKeepAlive)

setSoLinger

public DefaultAsyncHttpClientConfig.Builder setSoLinger(int soLinger)

setSoSndBuf

public DefaultAsyncHttpClientConfig.Builder setSoSndBuf(int soSndBuf)

setSoRcvBuf

public DefaultAsyncHttpClientConfig.Builder setSoRcvBuf(int soRcvBuf)

setThreadPoolName

public DefaultAsyncHttpClientConfig.Builder setThreadPoolName(String threadPoolName)

setHttpClientCodecMaxInitialLineLength

public DefaultAsyncHttpClientConfig.Builder setHttpClientCodecMaxInitialLineLength(int httpClientCodecMaxInitialLineLength)

setHttpClientCodecMaxHeaderSize

public DefaultAsyncHttpClientConfig.Builder setHttpClientCodecMaxHeaderSize(int httpClientCodecMaxHeaderSize)

setHttpClientCodecMaxChunkSize

public DefaultAsyncHttpClientConfig.Builder setHttpClientCodecMaxChunkSize(int httpClientCodecMaxChunkSize)

setHttpClientCodecInitialBufferSize

public DefaultAsyncHttpClientConfig.Builder setHttpClientCodecInitialBufferSize(int httpClientCodecInitialBufferSize)

setChunkedFileChunkSize

public DefaultAsyncHttpClientConfig.Builder setChunkedFileChunkSize(int chunkedFileChunkSize)

setHashedWheelTickDuration

public DefaultAsyncHttpClientConfig.Builder setHashedWheelTickDuration(long hashedWheelTickDuration)

setHashedWheelSize

public DefaultAsyncHttpClientConfig.Builder setHashedWheelSize(int hashedWheelSize)

addChannelOption

public <T> DefaultAsyncHttpClientConfig.Builder addChannelOption(io.netty.channel.ChannelOption<T> name,
                                                                 T value)

setEventLoopGroup

public DefaultAsyncHttpClientConfig.Builder setEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)

setUseNativeTransport

public DefaultAsyncHttpClientConfig.Builder setUseNativeTransport(boolean useNativeTransport)

setUseOnlyEpollNativeTransport

public DefaultAsyncHttpClientConfig.Builder setUseOnlyEpollNativeTransport(boolean useOnlyEpollNativeTransport)

setAllocator

public DefaultAsyncHttpClientConfig.Builder setAllocator(io.netty.buffer.ByteBufAllocator allocator)

setNettyTimer

public DefaultAsyncHttpClientConfig.Builder setNettyTimer(io.netty.util.Timer nettyTimer)

setThreadFactory

public DefaultAsyncHttpClientConfig.Builder setThreadFactory(ThreadFactory threadFactory)

setHttpAdditionalChannelInitializer

public DefaultAsyncHttpClientConfig.Builder setHttpAdditionalChannelInitializer(Consumer<io.netty.channel.Channel> httpAdditionalChannelInitializer)

setWsAdditionalChannelInitializer

public DefaultAsyncHttpClientConfig.Builder setWsAdditionalChannelInitializer(Consumer<io.netty.channel.Channel> wsAdditionalChannelInitializer)

setResponseBodyPartFactory

public DefaultAsyncHttpClientConfig.Builder setResponseBodyPartFactory(AsyncHttpClientConfig.ResponseBodyPartFactory responseBodyPartFactory)

setIoThreadsCount

public DefaultAsyncHttpClientConfig.Builder setIoThreadsCount(int ioThreadsCount)

build

public DefaultAsyncHttpClientConfig build()