HttpAsyncClientBuilder

java.lang.Object
- org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder

```
public class HttpAsyncClientBuilder
extends java.lang.Object
```
Builder for CloseableHttpAsyncClient instances that can negotiate the most optimal HTTP protocol version during the TLS handshake with ALPN extension if supported by the Java runtime.
Concurrent message exchanges executed by CloseableHttpAsyncClient instances created with this builder will get automatically assigned to separate connections leased from the connection pool.

When a particular component is not explicitly set this class will use its default implementation. System properties will be taken into account when configuring the default implementations when useSystemProperties() method is called prior to calling build().
- http.proxyHost
- http.proxyPort
- https.proxyHost
- https.proxyPort
- http.nonProxyHosts
- http.keepAlive
- http.agent
Please note that some settings used by this class can be mutually exclusive and may not apply when building CloseableHttpAsyncClient instances.
Since:

5.0

Constructor Summary

Constructors
Modifier Constructor and Description

protected HttpAsyncClientBuilder()

Constructors
Modifier	Constructor and Description
`protected`	`HttpAsyncClientBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addCloseable(java.io.Closeable closeable)` Adds to the list of `Closeable` resources to be managed by the client.
`HttpAsyncClientBuilder`	`addExecInterceptorAfter(java.lang.String existing, java.lang.String name, AsyncExecChainHandler interceptor)` Adds this execution interceptor after interceptor with the given name.
`HttpAsyncClientBuilder`	`addExecInterceptorBefore(java.lang.String existing, java.lang.String name, AsyncExecChainHandler interceptor)` Adds this execution interceptor before an existing interceptor.
`HttpAsyncClientBuilder`	`addExecInterceptorFirst(java.lang.String name, AsyncExecChainHandler interceptor)` Add an interceptor to the head of the processing list.
`HttpAsyncClientBuilder`	`addExecInterceptorLast(java.lang.String name, AsyncExecChainHandler interceptor)` Add an interceptor to the tail of the processing list.
`HttpAsyncClientBuilder`	`addRequestInterceptorFirst(HttpRequestInterceptor interceptor)` Adds this protocol interceptor to the head of the protocol processing list.
`HttpAsyncClientBuilder`	`addRequestInterceptorLast(HttpRequestInterceptor interceptor)` Adds this protocol interceptor to the tail of the protocol processing list.
`HttpAsyncClientBuilder`	`addResponseInterceptorFirst(HttpResponseInterceptor interceptor)` Adds this protocol interceptor to the head of the protocol processing list.
`HttpAsyncClientBuilder`	`addResponseInterceptorLast(HttpResponseInterceptor interceptor)` Adds this protocol interceptor to the tail of the protocol processing list.
`CloseableHttpAsyncClient`	`build()`
`static HttpAsyncClientBuilder`	`create()`
`protected void`	`customizeExecChain(<any> execChainDefinition)` Request exec chain customization and extension.
`HttpAsyncClientBuilder`	`disableAuthCaching()` Disables authentication scheme caching.
`HttpAsyncClientBuilder`	`disableAutomaticRetries()` Disables automatic request recovery and re-execution.
`HttpAsyncClientBuilder`	`disableConnectionState()` Disables connection state tracking.
`HttpAsyncClientBuilder`	`disableCookieManagement()` Disables state (cookie) management.
`HttpAsyncClientBuilder`	`disableRedirectHandling()` Disables automatic redirect handling.
`HttpAsyncClientBuilder`	`evictExpiredConnections()` Makes this instance of HttpClient proactively evict expired connections from the connection pool using a background thread.
`HttpAsyncClientBuilder`	`evictIdleConnections(TimeValue maxIdleTime)` Makes this instance of HttpClient proactively evict idle connections from the connection pool using a background thread.
`HttpAsyncClientBuilder`	`replaceExecInterceptor(java.lang.String existing, AsyncExecChainHandler interceptor)` Replace an existing interceptor with the given name with new interceptor.
`HttpAsyncClientBuilder`	`setCharCodingConfig(CharCodingConfig charCodingConfig)` Sets `CharCodingConfig` configuration.
`HttpAsyncClientBuilder`	`setConnectionManager(AsyncClientConnectionManager connManager)` Assigns `AsyncClientConnectionManager` instance.
`HttpAsyncClientBuilder`	`setConnectionManagerShared(boolean shared)` Defines the connection manager is to be shared by multiple client instances.
`HttpAsyncClientBuilder`	`setConnectionReuseStrategy(ConnectionReuseStrategy reuseStrategy)` Assigns `ConnectionReuseStrategy` instance.
`HttpAsyncClientBuilder`	`setDefaultAuthSchemeRegistry(<any> authSchemeRegistry)` Assigns default `AuthScheme` registry which will be used for request execution if not explicitly set in the client execution context.
`HttpAsyncClientBuilder`	`setDefaultCookieSpecRegistry(<any> cookieSpecRegistry)` Assigns default `CookieSpec` registry which will be used for request execution if not explicitly set in the client execution context.
`HttpAsyncClientBuilder`	`setDefaultCookieStore(CookieStore cookieStore)` Assigns default `CookieStore` instance which will be used for request execution if not explicitly set in the client execution context.
`HttpAsyncClientBuilder`	`setDefaultCredentialsProvider(CredentialsProvider credentialsProvider)` Assigns default `CredentialsProvider` instance which will be used for request execution if not explicitly set in the client execution context.
`HttpAsyncClientBuilder`	`setDefaultHeaders(java.util.Collection<? extends Header> defaultHeaders)` Assigns default request header values.
`HttpAsyncClientBuilder`	`setDefaultRequestConfig(RequestConfig config)` Assigns default `RequestConfig` instance which will be used for request execution if not explicitly set in the client execution context.
`HttpAsyncClientBuilder`	`setH2Config(H2Config h2Config)` Sets `H2Config` configuration.
`HttpAsyncClientBuilder`	`setHttp1Config(Http1Config h1Config)` Sets `Http1Config` configuration.
`HttpAsyncClientBuilder`	`setIOReactorConfig(IOReactorConfig ioReactorConfig)` Sets `IOReactorConfig` configuration.
`HttpAsyncClientBuilder`	`setIoReactorExceptionCallback(<any> ioReactorExceptionCallback)` Sets the callback that will be invoked when the client's IOReactor encounters an uncaught exception.
`HttpAsyncClientBuilder`	`setKeepAliveStrategy(ConnectionKeepAliveStrategy keepAliveStrategy)` Assigns `ConnectionKeepAliveStrategy` instance.
`HttpAsyncClientBuilder`	`setProxy(HttpHost proxy)` Assigns default proxy value.
`HttpAsyncClientBuilder`	`setProxyAuthenticationStrategy(AuthenticationStrategy proxyAuthStrategy)` Assigns `AuthenticationStrategy` instance for proxy authentication.
`HttpAsyncClientBuilder`	`setRedirectStrategy(RedirectStrategy redirectStrategy)` Assigns `RedirectStrategy` instance.
`HttpAsyncClientBuilder`	`setRetryStrategy(HttpRequestRetryStrategy retryStrategy)` Assigns `HttpRequestRetryStrategy` instance.
`HttpAsyncClientBuilder`	`setRoutePlanner(HttpRoutePlanner routePlanner)` Assigns `HttpRoutePlanner` instance.
`HttpAsyncClientBuilder`	`setSchemePortResolver(SchemePortResolver schemePortResolver)` Assigns `SchemePortResolver` instance.
`HttpAsyncClientBuilder`	`setTargetAuthenticationStrategy(AuthenticationStrategy targetAuthStrategy)` Assigns `AuthenticationStrategy` instance for target host authentication.
`HttpAsyncClientBuilder`	`setThreadFactory(java.util.concurrent.ThreadFactory threadFactory)` Assigns `ThreadFactory` instance.
`HttpAsyncClientBuilder`	`setUserAgent(java.lang.String userAgent)` Assigns `User-Agent` value.
`HttpAsyncClientBuilder`	`setUserTokenHandler(UserTokenHandler userTokenHandler)` Assigns `UserTokenHandler` instance.
`HttpAsyncClientBuilder`	`setVersionPolicy(HttpVersionPolicy versionPolicy)` Sets HTTP protocol version policy.
`HttpAsyncClientBuilder`	`useSystemProperties()` Use system properties when creating and configuring default implementations.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpAsyncClientBuilder
```
protected HttpAsyncClientBuilder()
```
- Method Detail
  - create
```
public static HttpAsyncClientBuilder create()
```
  - setVersionPolicy
```
public final HttpAsyncClientBuilder setVersionPolicy(HttpVersionPolicy versionPolicy)
```
    Sets HTTP protocol version policy.
  - setHttp1Config
```
public final HttpAsyncClientBuilder setHttp1Config(Http1Config h1Config)
```
    Sets Http1Config configuration.
  - setH2Config
```
public final HttpAsyncClientBuilder setH2Config(H2Config h2Config)
```
    Sets H2Config configuration.
  - setConnectionManager
```
public final HttpAsyncClientBuilder setConnectionManager(AsyncClientConnectionManager connManager)
```
    Assigns AsyncClientConnectionManager instance.
  - setConnectionManagerShared
```
public final HttpAsyncClientBuilder setConnectionManagerShared(boolean shared)
```
    Defines the connection manager is to be shared by multiple client instances.
    If the connection manager is shared its life-cycle is expected to be managed by the caller and it will not be shut down if the client is closed.
    
    Parameters:
    
    shared - defines whether or not the connection manager can be shared by multiple clients.
  - setIOReactorConfig
```
public final HttpAsyncClientBuilder setIOReactorConfig(IOReactorConfig ioReactorConfig)
```
    Sets IOReactorConfig configuration.
  - setIoReactorExceptionCallback
```
public final HttpAsyncClientBuilder setIoReactorExceptionCallback(<any> ioReactorExceptionCallback)
```
    Sets the callback that will be invoked when the client's IOReactor encounters an uncaught exception.
    
    Since:
    
    5.1
  - setCharCodingConfig
```
public final HttpAsyncClientBuilder setCharCodingConfig(CharCodingConfig charCodingConfig)
```
    Sets CharCodingConfig configuration.
  - setConnectionReuseStrategy
```
public final HttpAsyncClientBuilder setConnectionReuseStrategy(ConnectionReuseStrategy reuseStrategy)
```
    Assigns ConnectionReuseStrategy instance.
    Please note this strategy applies to HTTP/1.0 and HTTP/1.1 connections only
  - setKeepAliveStrategy
```
public final HttpAsyncClientBuilder setKeepAliveStrategy(ConnectionKeepAliveStrategy keepAliveStrategy)
```
    Assigns ConnectionKeepAliveStrategy instance.
  - setUserTokenHandler
```
public final HttpAsyncClientBuilder setUserTokenHandler(UserTokenHandler userTokenHandler)
```
    Assigns UserTokenHandler instance.
    Please note this value can be overridden by the disableConnectionState() method.
  - setTargetAuthenticationStrategy
```
public final HttpAsyncClientBuilder setTargetAuthenticationStrategy(AuthenticationStrategy targetAuthStrategy)
```
    Assigns AuthenticationStrategy instance for target host authentication.
  - setProxyAuthenticationStrategy
```
public final HttpAsyncClientBuilder setProxyAuthenticationStrategy(AuthenticationStrategy proxyAuthStrategy)
```
    Assigns AuthenticationStrategy instance for proxy authentication.
  - addResponseInterceptorFirst
```
public final HttpAsyncClientBuilder addResponseInterceptorFirst(HttpResponseInterceptor interceptor)
```
    Adds this protocol interceptor to the head of the protocol processing list.
  - addResponseInterceptorLast
```
public final HttpAsyncClientBuilder addResponseInterceptorLast(HttpResponseInterceptor interceptor)
```
    Adds this protocol interceptor to the tail of the protocol processing list.
  - addExecInterceptorBefore
```
public final HttpAsyncClientBuilder addExecInterceptorBefore(java.lang.String existing,
                                                             java.lang.String name,
                                                             AsyncExecChainHandler interceptor)
```
    Adds this execution interceptor before an existing interceptor.
  - addExecInterceptorAfter
```
public final HttpAsyncClientBuilder addExecInterceptorAfter(java.lang.String existing,
                                                            java.lang.String name,
                                                            AsyncExecChainHandler interceptor)
```
    Adds this execution interceptor after interceptor with the given name.
  - replaceExecInterceptor
```
public final HttpAsyncClientBuilder replaceExecInterceptor(java.lang.String existing,
                                                           AsyncExecChainHandler interceptor)
```
    Replace an existing interceptor with the given name with new interceptor.
  - addExecInterceptorFirst
```
public final HttpAsyncClientBuilder addExecInterceptorFirst(java.lang.String name,
                                                            AsyncExecChainHandler interceptor)
```
    Add an interceptor to the head of the processing list.
  - addExecInterceptorLast
```
public final HttpAsyncClientBuilder addExecInterceptorLast(java.lang.String name,
                                                           AsyncExecChainHandler interceptor)
```
    Add an interceptor to the tail of the processing list.
  - addRequestInterceptorFirst
```
public final HttpAsyncClientBuilder addRequestInterceptorFirst(HttpRequestInterceptor interceptor)
```
    Adds this protocol interceptor to the head of the protocol processing list.
  - addRequestInterceptorLast
```
public final HttpAsyncClientBuilder addRequestInterceptorLast(HttpRequestInterceptor interceptor)
```
    Adds this protocol interceptor to the tail of the protocol processing list.
  - setRetryStrategy
```
public final HttpAsyncClientBuilder setRetryStrategy(HttpRequestRetryStrategy retryStrategy)
```
    Assigns HttpRequestRetryStrategy instance.
    Please note this value can be overridden by the disableAutomaticRetries() method.
  - setRedirectStrategy
```
public HttpAsyncClientBuilder setRedirectStrategy(RedirectStrategy redirectStrategy)
```
    Assigns RedirectStrategy instance.
    Please note this value can be overridden by the disableRedirectHandling() method.
  - setSchemePortResolver
```
public final HttpAsyncClientBuilder setSchemePortResolver(SchemePortResolver schemePortResolver)
```
    Assigns SchemePortResolver instance.
  - setThreadFactory
```
public final HttpAsyncClientBuilder setThreadFactory(java.util.concurrent.ThreadFactory threadFactory)
```
    Assigns ThreadFactory instance.
  - setUserAgent
```
public final HttpAsyncClientBuilder setUserAgent(java.lang.String userAgent)
```
    Assigns User-Agent value.
  - setDefaultHeaders
```
public final HttpAsyncClientBuilder setDefaultHeaders(java.util.Collection<? extends Header> defaultHeaders)
```
    Assigns default request header values.
  - setProxy
```
public final HttpAsyncClientBuilder setProxy(HttpHost proxy)
```
    Assigns default proxy value.
    Please note this value can be overridden by the setRoutePlanner( HttpRoutePlanner) method.
  - setRoutePlanner
```
public final HttpAsyncClientBuilder setRoutePlanner(HttpRoutePlanner routePlanner)
```
    Assigns HttpRoutePlanner instance.
  - setDefaultCredentialsProvider
```
public final HttpAsyncClientBuilder setDefaultCredentialsProvider(CredentialsProvider credentialsProvider)
```
    Assigns default CredentialsProvider instance which will be used for request execution if not explicitly set in the client execution context.
  - setDefaultAuthSchemeRegistry
```
public final HttpAsyncClientBuilder setDefaultAuthSchemeRegistry(<any> authSchemeRegistry)
```
    Assigns default AuthScheme registry which will be used for request execution if not explicitly set in the client execution context.
  - setDefaultCookieSpecRegistry
```
public final HttpAsyncClientBuilder setDefaultCookieSpecRegistry(<any> cookieSpecRegistry)
```
    Assigns default CookieSpec registry which will be used for request execution if not explicitly set in the client execution context.
  - setDefaultCookieStore
```
public final HttpAsyncClientBuilder setDefaultCookieStore(CookieStore cookieStore)
```
    Assigns default CookieStore instance which will be used for request execution if not explicitly set in the client execution context.
  - setDefaultRequestConfig
```
public final HttpAsyncClientBuilder setDefaultRequestConfig(RequestConfig config)
```
    Assigns default RequestConfig instance which will be used for request execution if not explicitly set in the client execution context.
  - useSystemProperties
```
public final HttpAsyncClientBuilder useSystemProperties()
```
    Use system properties when creating and configuring default implementations.
  - disableConnectionState
```
public final HttpAsyncClientBuilder disableConnectionState()
```
    Disables connection state tracking.
  - disableRedirectHandling
```
public final HttpAsyncClientBuilder disableRedirectHandling()
```
    Disables automatic redirect handling.
  - disableAutomaticRetries
```
public final HttpAsyncClientBuilder disableAutomaticRetries()
```
    Disables automatic request recovery and re-execution.
  - disableCookieManagement
```
public final HttpAsyncClientBuilder disableCookieManagement()
```
    Disables state (cookie) management.
  - disableAuthCaching
```
public final HttpAsyncClientBuilder disableAuthCaching()
```
    Disables authentication scheme caching.
  - evictExpiredConnections
```
public final HttpAsyncClientBuilder evictExpiredConnections()
```
    Makes this instance of HttpClient proactively evict expired connections from the connection pool using a background thread.
    One MUST explicitly close HttpClient with CloseableHttpAsyncClient#close() in order to stop and release the background thread.
    Please note this method has no effect if the instance of HttpClient is configured to use a shared connection manager.
    
    See Also:
    
    setConnectionManagerShared(boolean), ConnPoolControl#closeExpired()
  - evictIdleConnections
```
public final HttpAsyncClientBuilder evictIdleConnections(TimeValue maxIdleTime)
```
    Makes this instance of HttpClient proactively evict idle connections from the connection pool using a background thread.
    One MUST explicitly close HttpClient with CloseableHttpAsyncClient#close() in order to stop and release the background thread.
    Please note this method has no effect if the instance of HttpClient is configured to use a shared connection manager.
    
    Parameters:
    
    maxIdleTime - maximum time persistent connections can stay idle while kept alive in the connection pool. Connections whose inactivity period exceeds this value will get closed and evicted from the pool.
    
    See Also:
    
    setConnectionManagerShared(boolean), ConnPoolControl#closeIdle(TimeValue)
  - customizeExecChain
```
protected void customizeExecChain(<any> execChainDefinition)
```
    Request exec chain customization and extension.
    For internal use.
  - addCloseable
```
protected void addCloseable(java.io.Closeable closeable)
```
    Adds to the list of Closeable resources to be managed by the client.
    For internal use.
  - build
```
public CloseableHttpAsyncClient build()
```

Class HttpAsyncClientBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpAsyncClientBuilder

Method Detail

create

setVersionPolicy

setHttp1Config

setH2Config

setConnectionManager

setConnectionManagerShared

setIOReactorConfig

setIoReactorExceptionCallback

setCharCodingConfig

setConnectionReuseStrategy

setKeepAliveStrategy

setUserTokenHandler

setTargetAuthenticationStrategy

setProxyAuthenticationStrategy

addResponseInterceptorFirst

addResponseInterceptorLast

addExecInterceptorBefore

addExecInterceptorAfter

replaceExecInterceptor

addExecInterceptorFirst

addExecInterceptorLast

addRequestInterceptorFirst

addRequestInterceptorLast

setRetryStrategy

setRedirectStrategy

setSchemePortResolver

setThreadFactory

setUserAgent

setDefaultHeaders

setProxy

setRoutePlanner

setDefaultCredentialsProvider

setDefaultAuthSchemeRegistry

setDefaultCookieSpecRegistry

setDefaultCookieStore

setDefaultRequestConfig

useSystemProperties

disableConnectionState

disableRedirectHandling

disableAutomaticRetries

disableCookieManagement

disableAuthCaching

evictExpiredConnections

evictIdleConnections

customizeExecChain

addCloseable

build