Apache HttpClient 5.3 · org.apache.hc.client5.http.impl.classic.HttpClientBuilder

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

Modifier and Type	Field and Description
private boolean	authCachingDisabled
private Lookup<AuthSchemeFactory>	authSchemeRegistry
private boolean	automaticRetriesDisabled
private BackoffManager	backoffManager
private List<Closeable>	closeables
private ConnectionBackoffStrategy	connectionBackoffStrategy
private boolean	connectionStateDisabled
private HttpClientConnectionManager	connManager
private boolean	connManagerShared
private boolean	contentCompressionDisabled
private LinkedHashMap<String, InputStreamFactory>	contentDecoderMap
private boolean	cookieManagementDisabled
private Lookup<CookieSpecFactory>	cookieSpecRegistry
private CookieStore	cookieStore
private CredentialsProvider	credentialsProvider
private Collection<? extends Header>	defaultHeaders
private RequestConfig	defaultRequestConfig
private boolean	defaultUserAgentDisabled
private boolean	evictExpiredConnections
private boolean	evictIdleConnections
private LinkedList<HttpClientBuilder.ExecInterceptorEntry>	execInterceptors
private ConnectionKeepAliveStrategy	keepAliveStrategy
private TimeValue	maxIdleTime
private HttpHost	proxy
private AuthenticationStrategy	proxyAuthStrategy
private ProxySelector	proxySelector
private boolean	redirectHandlingDisabled
private RedirectStrategy	redirectStrategy
private HttpRequestExecutor	requestExec
private LinkedList<HttpClientBuilder.RequestInterceptorEntry>	requestInterceptors
private LinkedList<HttpClientBuilder.ResponseInterceptorEntry>	responseInterceptors
private HttpRequestRetryStrategy	retryStrategy
private ConnectionReuseStrategy	reuseStrategy
private HttpRoutePlanner	routePlanner
private SchemePortResolver	schemePortResolver
private boolean	systemProperties
private AuthenticationStrategy	targetAuthStrategy
private String	userAgent
private UserTokenHandler	userTokenHandler

Access	Constructor and Description
protected	HttpClientBuilder()

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 HttpClientBuilder	addExecInterceptorAfter(final String existing, final String name, final ExecChainHandler interceptor) Adds this execution interceptor after interceptor with the given name.
public final HttpClientBuilder	addExecInterceptorBefore(final String existing, final String name, final ExecChainHandler interceptor) Adds this execution interceptor before an existing interceptor.
public final HttpClientBuilder	addExecInterceptorFirst(final String name, final ExecChainHandler interceptor) Add an interceptor to the head of the processing list.
public final HttpClientBuilder	addExecInterceptorLast(final String name, final ExecChainHandler interceptor) Add an interceptor to the tail of the processing list.
public final HttpClientBuilder	addRequestInterceptorFirst(final HttpRequestInterceptor interceptor) Adds this protocol interceptor to the head of the protocol processing list.
public final HttpClientBuilder	addRequestInterceptorLast(final HttpRequestInterceptor interceptor) Adds this protocol interceptor to the tail of the protocol processing list.
public final HttpClientBuilder	addResponseInterceptorFirst(final HttpResponseInterceptor interceptor) Adds this protocol interceptor to the head of the protocol processing list.
public final HttpClientBuilder	addResponseInterceptorLast(final HttpResponseInterceptor interceptor) Adds this protocol interceptor to the tail of the protocol processing list.
public CloseableHttpClient	build()
public static HttpClientBuilder	create()
protected void	customizeExecChain(final NamedElementChain<ExecChainHandler> execChainDefinition) Request exec chain customization and extension.
public final HttpClientBuilder	disableAuthCaching() Disables authentication scheme caching.
public final HttpClientBuilder	disableAutomaticRetries() Disables automatic request recovery and re-execution.
public final HttpClientBuilder	disableConnectionState() Disables connection state tracking.
public final HttpClientBuilder	disableContentCompression() Disables automatic content decompression.
public final HttpClientBuilder	disableCookieManagement() Disables state (cookie) management.
public final HttpClientBuilder	disableDefaultUserAgent() Disables the default user agent set by this builder if none has been provided by the user.
public final HttpClientBuilder	disableRedirectHandling() Disables automatic redirect handling.
public final HttpClientBuilder	evictExpiredConnections() Makes this instance of HttpClient proactively evict expired connections from the connection pool using a background thread.
public final HttpClientBuilder	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.
public final HttpClientBuilder	replaceExecInterceptor(final String existing, final ExecChainHandler interceptor) Replace an existing interceptor with the given name with new interceptor.
public final HttpClientBuilder	setBackoffManager(final BackoffManager backoffManager) Assigns `BackoffManager` instance.
public final HttpClientBuilder	setConnectionBackoffStrategy(final ConnectionBackoffStrategy connectionBackoffStrategy) Assigns `ConnectionBackoffStrategy` instance.
public final HttpClientBuilder	setConnectionManager(final HttpClientConnectionManager connManager) Assigns `HttpClientConnectionManager` instance.
public final HttpClientBuilder	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 HttpClientBuilder	setConnectionReuseStrategy(final ConnectionReuseStrategy reuseStrategy) Assigns `ConnectionReuseStrategy` instance.
public final HttpClientBuilder	setContentDecoderRegistry(final LinkedHashMap<String, InputStreamFactory> contentDecoderMap) Assigns a map of `org.apache.hc.client5.http.entity.InputStreamFactory`s to be used for automatic content decompression.
public final HttpClientBuilder	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 HttpClientBuilder	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 HttpClientBuilder	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 HttpClientBuilder	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 HttpClientBuilder	setDefaultHeaders(final Collection<? extends Header> defaultHeaders) Assigns default request header values.
public final HttpClientBuilder	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 HttpClientBuilder	setKeepAliveStrategy(final ConnectionKeepAliveStrategy keepAliveStrategy) Assigns `ConnectionKeepAliveStrategy` instance.
public final HttpClientBuilder	setProxy(final HttpHost proxy) Assigns default proxy value.
public final HttpClientBuilder	setProxyAuthenticationStrategy(final AuthenticationStrategy proxyAuthStrategy) Assigns `AuthenticationStrategy` instance for proxy authentication.
public final HttpClientBuilder	Returns: this `HttpClientBuilder` 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 final HttpClientBuilder	setRedirectStrategy(final RedirectStrategy redirectStrategy) Assigns `RedirectStrategy` instance.
public final HttpClientBuilder	setRequestExecutor(final HttpRequestExecutor requestExec) Assigns `HttpRequestExecutor` instance.
public final HttpClientBuilder	setRetryStrategy(final HttpRequestRetryStrategy retryStrategy) Assigns `HttpRequestRetryStrategy` instance.
public final HttpClientBuilder	setRoutePlanner(final HttpRoutePlanner routePlanner) Assigns `HttpRoutePlanner` instance.
public final HttpClientBuilder	setSchemePortResolver(final SchemePortResolver schemePortResolver) Assigns `SchemePortResolver` instance.
public final HttpClientBuilder	setTargetAuthenticationStrategy(final AuthenticationStrategy targetAuthStrategy) Assigns `AuthenticationStrategy` instance for target host authentication.
public final HttpClientBuilder	setUserAgent(final String userAgent) Assigns `User-Agent` value.
public final HttpClientBuilder	setUserTokenHandler(final UserTokenHandler userTokenHandler) Assigns `UserTokenHandler` instance.
public final HttpClientBuilder	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 HttpClientBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary