Apache HttpClient 5.3 · org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder

Modifier and Type	Class and Description
private static class	HttpAsyncClientBuilder.ExecInterceptorEntry
private static class	HttpAsyncClientBuilder.RequestInterceptorEntry
private static class	HttpAsyncClientBuilder.ResponseInterceptorEntry

Modifier and Type	Field and Description
private boolean	authCachingDisabled
private Lookup<AuthSchemeFactory>	authSchemeRegistry
private boolean	automaticRetriesDisabled
private CharCodingConfig	charCodingConfig
private List<Closeable>	closeables
private boolean	connectionStateDisabled
private AsyncClientConnectionManager	connManager
private boolean	connManagerShared
private boolean	cookieManagementDisabled
private Lookup<CookieSpecFactory>	cookieSpecRegistry
private CookieStore	cookieStore
private CredentialsProvider	credentialsProvider
private Collection<? extends Header>	defaultHeaders
private RequestConfig	defaultRequestConfig
private boolean	evictExpiredConnections
private boolean	evictIdleConnections
private LinkedList<HttpAsyncClientBuilder.ExecInterceptorEntry>	execInterceptors
private Http1Config	h1Config
private H2Config	h2Config
private IOReactorConfig	ioReactorConfig
private Callback<Exception>	ioReactorExceptionCallback
private Decorator<IOSession>	ioSessionDecorator
private IOSessionListener	ioSessionListener
private ConnectionKeepAliveStrategy	keepAliveStrategy
private TimeValue	maxIdleTime
private HttpHost	proxy
private AuthenticationStrategy	proxyAuthStrategy
private ProxySelector	proxySelector
private boolean	redirectHandlingDisabled
private RedirectStrategy	redirectStrategy
private LinkedList<HttpAsyncClientBuilder.RequestInterceptorEntry>	requestInterceptors
private LinkedList<HttpAsyncClientBuilder.ResponseInterceptorEntry>	responseInterceptors
private HttpRequestRetryStrategy	retryStrategy
private ConnectionReuseStrategy	reuseStrategy
private HttpRoutePlanner	routePlanner
private SchemePortResolver	schemePortResolver
private boolean	systemProperties
private AuthenticationStrategy	targetAuthStrategy
private ThreadFactory	threadFactory
private TlsConfig	tlsConfig Deprecated TLS should be configured by the connection manager
private String	userAgent
private UserTokenHandler	userTokenHandler

Access	Constructor and Description
protected	HttpAsyncClientBuilder()

Method Summary

Modifier and Type	Method and Description
protected void	addCloseable(final Closeable closeable) Adds to the list of `Closeable` resources to be managed by the client.
public final HttpAsyncClientBuilder	addExecInterceptorAfter(final String existing, final String name, final AsyncExecChainHandler interceptor) Adds this execution interceptor after interceptor with the given name.
public final HttpAsyncClientBuilder	addExecInterceptorBefore(final String existing, final String name, final AsyncExecChainHandler interceptor) Adds this execution interceptor before an existing interceptor.
public final HttpAsyncClientBuilder	addExecInterceptorFirst(final String name, final AsyncExecChainHandler interceptor) Add an interceptor to the head of the processing list.
public final HttpAsyncClientBuilder	addExecInterceptorLast(final String name, final AsyncExecChainHandler interceptor) Add an interceptor to the tail of the processing list.
public final HttpAsyncClientBuilder	addRequestInterceptorFirst(final HttpRequestInterceptor interceptor) Adds this protocol interceptor to the head of the protocol processing list.
public final HttpAsyncClientBuilder	addRequestInterceptorLast(final HttpRequestInterceptor interceptor) Adds this protocol interceptor to the tail of the protocol processing list.
public final HttpAsyncClientBuilder	addResponseInterceptorFirst(final HttpResponseInterceptor interceptor) Adds this protocol interceptor to the head of the protocol processing list.
public final HttpAsyncClientBuilder	addResponseInterceptorLast(final HttpResponseInterceptor interceptor) Adds this protocol interceptor to the tail of the protocol processing list.
public CloseableHttpAsyncClient	build()
public static HttpAsyncClientBuilder	create()
protected void	customizeExecChain(final NamedElementChain<AsyncExecChainHandler> execChainDefinition) Request exec chain customization and extension.
public final HttpAsyncClientBuilder	disableAuthCaching() Disables authentication scheme caching.
public final HttpAsyncClientBuilder	disableAutomaticRetries() Disables automatic request recovery and re-execution.
public final HttpAsyncClientBuilder	disableConnectionState() Disables connection state tracking.
public final HttpAsyncClientBuilder	disableCookieManagement() Disables state (cookie) management.
public final HttpAsyncClientBuilder	disableRedirectHandling() Disables automatic redirect handling.
public final HttpAsyncClientBuilder	evictExpiredConnections() Makes this instance of HttpClient proactively evict expired connections from the connection pool using a background thread.
public final HttpAsyncClientBuilder	evictIdleConnections(final TimeValue 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. maxIdleTime) Makes this instance of HttpClient proactively evict idle connections from the connection pool using a background thread.
private String	getProperty(final String key, final String defaultValue)
public final HttpAsyncClientBuilder	replaceExecInterceptor(final String existing, final AsyncExecChainHandler interceptor) Replace an existing interceptor with the given name with new interceptor.
public final HttpAsyncClientBuilder	setCharCodingConfig(final CharCodingConfig charCodingConfig) Sets `CharCodingConfig` configuration.
public final HttpAsyncClientBuilder	setConnectionManager(final AsyncClientConnectionManager connManager) Assigns `AsyncClientConnectionManager` instance.
public final HttpAsyncClientBuilder	setConnectionManagerShared(final boolean defines whether or not the connection manager can be shared by multiple clients. shared) Defines the connection manager is to be shared by multiple client instances.
public final HttpAsyncClientBuilder	setConnectionReuseStrategy(final ConnectionReuseStrategy reuseStrategy) Assigns `ConnectionReuseStrategy` instance.
public final HttpAsyncClientBuilder	setDefaultAuthSchemeRegistry(final Lookup<AuthSchemeFactory> authSchemeRegistry) Assigns default `org.apache.hc.client5.http.auth.AuthScheme` registry which will be used for request execution if not explicitly set in the client execution context.
public final HttpAsyncClientBuilder	setDefaultCookieSpecRegistry(final Lookup<CookieSpecFactory> cookieSpecRegistry) Assigns default `org.apache.hc.client5.http.cookie.CookieSpec` registry which will be used for request execution if not explicitly set in the client execution context.
public final HttpAsyncClientBuilder	setDefaultCookieStore(final CookieStore cookieStore) Assigns default `CookieStore` instance which will be used for request execution if not explicitly set in the client execution context.
public final HttpAsyncClientBuilder	setDefaultCredentialsProvider(final CredentialsProvider credentialsProvider) Assigns default `CredentialsProvider` instance which will be used for request execution if not explicitly set in the client execution context.
public final HttpAsyncClientBuilder	setDefaultHeaders(final Collection<? extends Header> defaultHeaders) Assigns default request header values.
public final HttpAsyncClientBuilder	setDefaultRequestConfig(final RequestConfig config) Assigns default `RequestConfig` instance which will be used for request execution if not explicitly set in the client execution context.
public final HttpAsyncClientBuilder	setH2Config(final H2Config h2Config) Sets `H2Config` configuration.
public final HttpAsyncClientBuilder	setHttp1Config(final Http1Config h1Config) Sets `Http1Config` configuration.
public final HttpAsyncClientBuilder	setIOReactorConfig(final IOReactorConfig ioReactorConfig) Sets `IOReactorConfig` configuration.
public final HttpAsyncClientBuilder	setIoReactorExceptionCallback(final Callback<Exception> ioReactorExceptionCallback) Sets the callback that will be invoked when the client's IOReactor encounters an uncaught exception.
public final HttpAsyncClientBuilder	setIoSessionDecorator(final Decorator<IOSession> ioSessionDecorator) Sets the `IOSession` `Decorator` that will be use with the client's IOReactor.
public final HttpAsyncClientBuilder	setIOSessionListener(final IOSessionListener ioSessionListener) Sets `IOSessionListener` listener.
public final HttpAsyncClientBuilder	setKeepAliveStrategy(final ConnectionKeepAliveStrategy keepAliveStrategy) Assigns `ConnectionKeepAliveStrategy` instance.
public final HttpAsyncClientBuilder	setProxy(final HttpHost proxy) Assigns default proxy value.
public final HttpAsyncClientBuilder	setProxyAuthenticationStrategy(final AuthenticationStrategy proxyAuthStrategy) Assigns `AuthenticationStrategy` instance for proxy authentication.
public final HttpAsyncClientBuilder	Returns: this `HttpAsyncClientBuilder` instance, to allow for method chaining. setProxySelector(final ProxySelector the `java.net.ProxySelector` to be used, or null to use the default system proxy selector. proxySelector) Sets the `java.net.ProxySelector` that will be used to select the proxies to be used for establishing HTTP connections.
public HttpAsyncClientBuilder	setRedirectStrategy(final RedirectStrategy redirectStrategy) Assigns `RedirectStrategy` instance.
public final HttpAsyncClientBuilder	setRetryStrategy(final HttpRequestRetryStrategy retryStrategy) Assigns `HttpRequestRetryStrategy` instance.
public final HttpAsyncClientBuilder	setRoutePlanner(final HttpRoutePlanner routePlanner) Assigns `HttpRoutePlanner` instance.
public final HttpAsyncClientBuilder	setSchemePortResolver(final SchemePortResolver schemePortResolver) Assigns `SchemePortResolver` instance.
public final HttpAsyncClientBuilder	setTargetAuthenticationStrategy(final AuthenticationStrategy targetAuthStrategy) Assigns `AuthenticationStrategy` instance for target host authentication.
public final HttpAsyncClientBuilder	setThreadFactory(final ThreadFactory threadFactory) Assigns `ThreadFactory` instance.
public final HttpAsyncClientBuilder	setUserAgent(final String userAgent) Assigns `User-Agent` value.
public final HttpAsyncClientBuilder	setUserTokenHandler(final UserTokenHandler userTokenHandler) Assigns `UserTokenHandler` instance.
public final HttpAsyncClientBuilder	setVersionPolicy(final HttpVersionPolicy versionPolicy) Deprecated Use `TlsConfig` and connection manager methods Sets HTTP protocol version policy.
public final HttpAsyncClientBuilder	useSystemProperties() Use system properties when creating and configuring default implementations.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class HttpAsyncClientBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary