Apache HttpClient 4.5.14 · org.apache.http.impl.client.HttpClientBuilder

Modifier and Type	Field and Description
private boolean	authCachingDisabled
private Lookup<AuthSchemeProvider>	authSchemeRegistry
private boolean	automaticRetriesDisabled
private BackoffManager	backoffManager
private List<Closeable>	closeables
private ConnectionBackoffStrategy	connectionBackoffStrategy
private boolean	connectionStateDisabled
private HttpClientConnectionManager	connManager
private boolean	connManagerShared
private long	connTimeToLive
private TimeUnit	connTimeToLiveTimeUnit
private boolean	contentCompressionDisabled
private Map<String, InputStreamFactory>	contentDecoderMap
private boolean	cookieManagementDisabled
private Lookup<CookieSpecProvider>	cookieSpecRegistry
private CookieStore	cookieStore
private CredentialsProvider	credentialsProvider
private ConnectionConfig	defaultConnectionConfig
private Collection<? extends Header>	defaultHeaders
private RequestConfig	defaultRequestConfig
private SocketConfig	defaultSocketConfig
private boolean	defaultUserAgentDisabled
private DnsResolver	dnsResolver
private boolean	evictExpiredConnections
private boolean	evictIdleConnections
private HostnameVerifier	hostnameVerifier
private HttpProcessor	httpprocessor
private ConnectionKeepAliveStrategy	keepAliveStrategy
private int	maxConnPerRoute
private int	maxConnTotal
private long	maxIdleTime
private TimeUnit	maxIdleTimeUnit
private HttpHost	proxy
private AuthenticationStrategy	proxyAuthStrategy
private PublicSuffixMatcher	publicSuffixMatcher
private boolean	redirectHandlingDisabled
private RedirectStrategy	redirectStrategy
private HttpRequestExecutor	requestExec
private LinkedList<HttpRequestInterceptor>	requestFirst
private LinkedList<HttpRequestInterceptor>	requestLast
private LinkedList<HttpResponseInterceptor>	responseFirst
private LinkedList<HttpResponseInterceptor>	responseLast
private HttpRequestRetryHandler	retryHandler
private ConnectionReuseStrategy	reuseStrategy
private HttpRoutePlanner	routePlanner
private SchemePortResolver	schemePortResolver
private ServiceUnavailableRetryStrategy	serviceUnavailStrategy
private SSLContext	sslContext
private LayeredConnectionSocketFactory	sslSocketFactory
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) For internal use.
public final HttpClientBuilder	addInterceptorFirst(final HttpResponseInterceptor itcp) Adds this protocol interceptor to the head of the protocol processing list.
public final HttpClientBuilder	addInterceptorFirst(final HttpRequestInterceptor itcp) Adds this protocol interceptor to the head of the protocol processing list.
public final HttpClientBuilder	addInterceptorLast(final HttpResponseInterceptor itcp) Adds this protocol interceptor to the tail of the protocol processing list.
public final HttpClientBuilder	addInterceptorLast(final HttpRequestInterceptor itcp) Adds this protocol interceptor to the tail of the protocol processing list.
public CloseableHttpClient	build()
public static HttpClientBuilder	create()
protected ClientExecChain	createMainExec(final HttpRequestExecutor requestExec, final HttpClientConnectionManager connManager, final ConnectionReuseStrategy reuseStrategy, final ConnectionKeepAliveStrategy keepAliveStrategy, final HttpProcessor proxyHttpProcessor, final AuthenticationStrategy targetAuthStrategy, final AuthenticationStrategy proxyAuthStrategy, final UserTokenHandler userTokenHandler) Produces an instance of `ClientExecChain` to be used as a main exec.
protected ClientExecChain	decorateMainExec(final ClientExecChain mainExec) For internal use.
protected ClientExecChain	decorateProtocolExec(final ClientExecChain protocolExec) For internal use.
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 Long 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, final TimeUnit time unit for the above parameter. maxIdleTimeUnit) Deprecated (4.5) use `evictIdleConnections(long, TimeUnit)` Makes this instance of HttpClient proactively evict idle connections from the connection pool using a background thread.
public final HttpClientBuilder	evictIdleConnections(final long 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, final TimeUnit time unit for the above parameter. maxIdleTimeUnit) Makes this instance of HttpClient proactively evict idle connections from the connection pool using a background thread.
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	setConnectionTimeToLive(final long connTimeToLive, final TimeUnit connTimeToLiveTimeUnit) Sets maximum time to live for persistent connections Please note this value can be overridden by the `setConnectionManager( org.apache.http.conn.HttpClientConnectionManager)` method.
public final HttpClientBuilder	setContentDecoderRegistry(final Map<String, InputStreamFactory> contentDecoderMap) Assigns a map of `org.apache.http.client.entity.InputStreamFactory`s to be used for automatic content decompression.
public final HttpClientBuilder	setDefaultAuthSchemeRegistry(final Lookup<AuthSchemeProvider> authSchemeRegistry) Assigns default `org.apache.http.auth.AuthScheme` registry which will be used for request execution if not explicitly set in the client execution context.
public final HttpClientBuilder	setDefaultConnectionConfig(final ConnectionConfig config) Assigns default `ConnectionConfig`.
public final HttpClientBuilder	setDefaultCookieSpecRegistry(final Lookup<CookieSpecProvider> cookieSpecRegistry) Assigns default `org.apache.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	setDefaultSocketConfig(final SocketConfig config) Assigns default `SocketConfig`.
public final HttpClientBuilder	setDnsResolver(final DnsResolver dnsResolver) Assigns `DnsResolver` instance.
public final HttpClientBuilder	setHostnameVerifier(final X509HostnameVerifier hostnameVerifier) Deprecated (4.4) Assigns `X509HostnameVerifier` instance.
public final HttpClientBuilder	setHttpProcessor(final HttpProcessor httpprocessor) Assigns `HttpProcessor` instance.
public final HttpClientBuilder	setKeepAliveStrategy(final ConnectionKeepAliveStrategy keepAliveStrategy) Assigns `ConnectionKeepAliveStrategy` instance.
public final HttpClientBuilder	setMaxConnPerRoute(final int maxConnPerRoute) Assigns maximum connection per route value.
public final HttpClientBuilder	setMaxConnTotal(final int maxConnTotal) Assigns maximum total connection value.
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	setPublicSuffixMatcher(final PublicSuffixMatcher publicSuffixMatcher) Assigns file containing public suffix matcher.
public final HttpClientBuilder	setRedirectStrategy(final RedirectStrategy redirectStrategy) Assigns `RedirectStrategy` instance.
public final HttpClientBuilder	setRequestExecutor(final HttpRequestExecutor requestExec) Assigns `HttpRequestExecutor` instance.
public final HttpClientBuilder	setRetryHandler(final HttpRequestRetryHandler retryHandler) Assigns `HttpRequestRetryHandler` instance.
public final HttpClientBuilder	setRoutePlanner(final HttpRoutePlanner routePlanner) Assigns `HttpRoutePlanner` instance.
public final HttpClientBuilder	setSchemePortResolver(final SchemePortResolver schemePortResolver) Assigns `SchemePortResolver` instance.
public final HttpClientBuilder	setServiceUnavailableRetryStrategy(final ServiceUnavailableRetryStrategy serviceUnavailStrategy) Assigns `ServiceUnavailableRetryStrategy` instance.
public final HttpClientBuilder	setSslcontext(final SSLContext sslcontext) Deprecated (4.5) use `setSSLContext(SSLContext)` Assigns `SSLContext` instance.
public final HttpClientBuilder	setSSLContext(final SSLContext sslContext) Assigns `SSLContext` instance.
public final HttpClientBuilder	setSSLHostnameVerifier(final HostnameVerifier hostnameVerifier) Assigns `javax.net.ssl.HostnameVerifier` instance.
public final HttpClientBuilder	setSSLSocketFactory(final LayeredConnectionSocketFactory sslSocketFactory) Assigns `LayeredConnectionSocketFactory` 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.
private static String[]	split(final String s)
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

Field Summary

Constructor Summary

Method Summary