org.apache.http.impl.client

Class HttpClientBuilder

java.lang.Object

org.apache.http.impl.client.HttpClientBuilder

@NotThreadSafe
public class HttpClientBuilder
extends Object

HttpClient builder.

The following system properties are taken into account by this class if the useSystemProperties() method is called.

• ssl.TrustManagerFactory.algorithm
• javax.net.ssl.trustStoreType
• javax.net.ssl.trustStore
• javax.net.ssl.trustStoreProvider
• javax.net.ssl.trustStorePassword
• java.home
• ssl.KeyManagerFactory.algorithm
• javax.net.ssl.keyStoreType
• javax.net.ssl.keyStore
• javax.net.ssl.keyStoreProvider
• javax.net.ssl.keyStorePassword
• http.proxyHost
• http.proxyPort
• http.nonProxyHosts
• http.keepAlive
• http.maxConnections
• http.agent

Since:

4.3

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpClientBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCloseable(Closeable closeable)
HttpClientBuilder	addInterceptorFirst(HttpRequestInterceptor itcp)
HttpClientBuilder	addInterceptorFirst(HttpResponseInterceptor itcp)
HttpClientBuilder	addInterceptorLast(HttpRequestInterceptor itcp)
HttpClientBuilder	addInterceptorLast(HttpResponseInterceptor itcp)
CloseableHttpClient	build()
static HttpClientBuilder	create()
protected ClientExecChain	decorateMainExec(ClientExecChain mainExec)
protected ClientExecChain	decorateProtocolExec(ClientExecChain protocolExec)
HttpClientBuilder	disableAutomaticRetries()
HttpClientBuilder	disableConnectionState()
HttpClientBuilder	disableContentCompression()
HttpClientBuilder	disableRedirectHandling()
HttpClientBuilder	setBackoffManager(BackoffManager backoffManager)
HttpClientBuilder	setConnectionBackoffStrategy(ConnectionBackoffStrategy connectionBackoffStrategy)
HttpClientBuilder	setConnectionManager(HttpClientConnectionManager connManager)
HttpClientBuilder	setConnectionReuseStrategy(ConnectionReuseStrategy reuseStrategy)
HttpClientBuilder	setDefaultAuthSchemeRegistry(org.apache.http.config.Lookup<AuthSchemeProvider> authSchemeRegistry)
HttpClientBuilder	setDefaultConnectionConfig(org.apache.http.config.ConnectionConfig config)
HttpClientBuilder	setDefaultCookieSpecRegistry(org.apache.http.config.Lookup<CookieSpecProvider> cookieSpecRegistry)
HttpClientBuilder	setDefaultCookieStore(CookieStore cookieStore)
HttpClientBuilder	setDefaultCredentialsProvider(CredentialsProvider credentialsProvider)
HttpClientBuilder	setDefaultHeaders(Collection<? extends Header> defaultHeaders)
HttpClientBuilder	setDefaultRequestConfig(RequestConfig config)
HttpClientBuilder	setDefaultSocketConfig(org.apache.http.config.SocketConfig config)
HttpClientBuilder	setHttpProcessor(HttpProcessor httpprocessor)
HttpClientBuilder	setKeepAliveStrategy(ConnectionKeepAliveStrategy keepAliveStrategy)
HttpClientBuilder	setMaxConnPerRoute(int maxConnPerRoute)
HttpClientBuilder	setMaxConnTotal(int maxConnTotal)
HttpClientBuilder	setProxy(HttpHost proxy)
HttpClientBuilder	setProxyAuthenticationStrategy(AuthenticationStrategy proxyAuthStrategy)
HttpClientBuilder	setRedirectStrategy(RedirectStrategy redirectStrategy)
HttpClientBuilder	setRequestExecutor(HttpRequestExecutor requestExec)
HttpClientBuilder	setRetryHandler(HttpRequestRetryHandler retryHandler)
HttpClientBuilder	setRoutePlanner(HttpRoutePlanner routePlanner)
HttpClientBuilder	setSchemePortResolver(SchemePortResolver schemePortResolver)
HttpClientBuilder	setServiceUnavailableRetryStrategy(ServiceUnavailableRetryStrategy serviceUnavailStrategy)
HttpClientBuilder	setSSLSocketFactory(LayeredConnectionSocketFactory sslSocketFactory)
HttpClientBuilder	setTargetAuthenticationStrategy(AuthenticationStrategy targetAuthStrategy)
HttpClientBuilder	setUserAgent(String userAgent)
HttpClientBuilder	setUserTokenHandler(UserTokenHandler userTokenHandler)
HttpClientBuilder	useSystemProperties()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientBuilder

protected HttpClientBuilder()

Method Detail

create

public static HttpClientBuilder create()

setRequestExecutor

public final HttpClientBuilder setRequestExecutor(HttpRequestExecutor requestExec)

setSSLSocketFactory

public final HttpClientBuilder setSSLSocketFactory(LayeredConnectionSocketFactory sslSocketFactory)

setConnectionManager

public final HttpClientBuilder setConnectionManager(HttpClientConnectionManager connManager)

setSchemePortResolver

public final HttpClientBuilder setSchemePortResolver(SchemePortResolver schemePortResolver)

setMaxConnTotal

public final HttpClientBuilder setMaxConnTotal(int maxConnTotal)

setMaxConnPerRoute

public final HttpClientBuilder setMaxConnPerRoute(int maxConnPerRoute)

setConnectionReuseStrategy

public final HttpClientBuilder setConnectionReuseStrategy(ConnectionReuseStrategy reuseStrategy)

setKeepAliveStrategy

public final HttpClientBuilder setKeepAliveStrategy(ConnectionKeepAliveStrategy keepAliveStrategy)

setUserTokenHandler

public final HttpClientBuilder setUserTokenHandler(UserTokenHandler userTokenHandler)

setTargetAuthenticationStrategy

public final HttpClientBuilder setTargetAuthenticationStrategy(AuthenticationStrategy targetAuthStrategy)

setProxyAuthenticationStrategy

public final HttpClientBuilder setProxyAuthenticationStrategy(AuthenticationStrategy proxyAuthStrategy)

setHttpProcessor

public final HttpClientBuilder setHttpProcessor(HttpProcessor httpprocessor)

addInterceptorFirst

public final HttpClientBuilder addInterceptorFirst(HttpResponseInterceptor itcp)

addInterceptorLast

public final HttpClientBuilder addInterceptorLast(HttpResponseInterceptor itcp)

addInterceptorFirst

public final HttpClientBuilder addInterceptorFirst(HttpRequestInterceptor itcp)

addInterceptorLast

public final HttpClientBuilder addInterceptorLast(HttpRequestInterceptor itcp)

setRetryHandler

public final HttpClientBuilder setRetryHandler(HttpRequestRetryHandler retryHandler)

setRoutePlanner

public final HttpClientBuilder setRoutePlanner(HttpRoutePlanner routePlanner)

setRedirectStrategy

public final HttpClientBuilder setRedirectStrategy(RedirectStrategy redirectStrategy)

setConnectionBackoffStrategy

public final HttpClientBuilder setConnectionBackoffStrategy(ConnectionBackoffStrategy connectionBackoffStrategy)

setBackoffManager

public final HttpClientBuilder setBackoffManager(BackoffManager backoffManager)

setServiceUnavailableRetryStrategy

public final HttpClientBuilder setServiceUnavailableRetryStrategy(ServiceUnavailableRetryStrategy serviceUnavailStrategy)

setDefaultCookieStore

public final HttpClientBuilder setDefaultCookieStore(CookieStore cookieStore)

setDefaultCredentialsProvider

public final HttpClientBuilder setDefaultCredentialsProvider(CredentialsProvider credentialsProvider)

setDefaultAuthSchemeRegistry

public final HttpClientBuilder setDefaultAuthSchemeRegistry(org.apache.http.config.Lookup<AuthSchemeProvider> authSchemeRegistry)

setDefaultCookieSpecRegistry

public final HttpClientBuilder setDefaultCookieSpecRegistry(org.apache.http.config.Lookup<CookieSpecProvider> cookieSpecRegistry)

setUserAgent

public final HttpClientBuilder setUserAgent(String userAgent)

setProxy

public final HttpClientBuilder setProxy(HttpHost proxy)

setDefaultHeaders

public final HttpClientBuilder setDefaultHeaders(Collection<? extends Header> defaultHeaders)

setDefaultSocketConfig

public final HttpClientBuilder setDefaultSocketConfig(org.apache.http.config.SocketConfig config)

setDefaultConnectionConfig

public final HttpClientBuilder setDefaultConnectionConfig(org.apache.http.config.ConnectionConfig config)

setDefaultRequestConfig

public final HttpClientBuilder setDefaultRequestConfig(RequestConfig config)

disableRedirectHandling

public final HttpClientBuilder disableRedirectHandling()

disableAutomaticRetries

public final HttpClientBuilder disableAutomaticRetries()

disableConnectionState

public final HttpClientBuilder disableConnectionState()

disableContentCompression

public final HttpClientBuilder disableContentCompression()

useSystemProperties

public final HttpClientBuilder useSystemProperties()

decorateMainExec

protected ClientExecChain decorateMainExec(ClientExecChain mainExec)

decorateProtocolExec

protected ClientExecChain decorateProtocolExec(ClientExecChain protocolExec)

addCloseable

protected void addCloseable(Closeable closeable)

build

public CloseableHttpClient build()