HttpClientBuilder (httpclient-android API)

java.lang.Object
- cz.msebera.android.httpclient.impl.client.HttpClientBuilder

Direct Known Subclasses:

CachingHttpClientBuilder
```
@NotThreadSafe
public class HttpClientBuilder
extends java.lang.Object
```
Builder for CloseableHttpClient instances.
When a particular component is not explicitly 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().
- ssl.TrustManagerFactory.algorithm
- javax.net.ssl.trustStoreType
- javax.net.ssl.trustStore
- javax.net.ssl.trustStoreProvider
- javax.net.ssl.trustStorePassword
- ssl.KeyManagerFactory.algorithm
- javax.net.ssl.keyStoreType
- javax.net.ssl.keyStore
- javax.net.ssl.keyStoreProvider
- javax.net.ssl.keyStorePassword
- https.protocols
- https.cipherSuites
- http.proxyHost
- http.proxyPort
- http.nonProxyHosts
- http.keepAlive
- http.maxConnections
- http.agent
Please note that some settings used by this class can be mutually exclusive and may not apply when building CloseableHttpClient instances.
Since:

4.3

Constructor Summary

Constructors
Modifier Constructor and Description

protected HttpClientBuilder()

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addCloseable(java.io.Closeable closeable)` For internal use.
`HttpClientBuilder`	`addInterceptorFirst(HttpRequestInterceptor itcp)` Adds this protocol interceptor to the head of the protocol processing list.
`HttpClientBuilder`	`addInterceptorFirst(HttpResponseInterceptor itcp)` Adds this protocol interceptor to the head of the protocol processing list.
`HttpClientBuilder`	`addInterceptorLast(HttpRequestInterceptor itcp)` Adds this protocol interceptor to the tail of the protocol processing list.
`HttpClientBuilder`	`addInterceptorLast(HttpResponseInterceptor itcp)` Adds this protocol interceptor to the tail of the protocol processing list.
`CloseableHttpClient`	`build()`
`static HttpClientBuilder`	`create()`
`protected ClientExecChain`	`decorateMainExec(ClientExecChain mainExec)` For internal use.
`protected ClientExecChain`	`decorateProtocolExec(ClientExecChain protocolExec)` For internal use.
`HttpClientBuilder`	`disableAuthCaching()` Disables authentication scheme caching.
`HttpClientBuilder`	`disableAutomaticRetries()` Disables automatic request recovery and re-execution.
`HttpClientBuilder`	`disableConnectionState()` Disables connection state tracking.
`HttpClientBuilder`	`disableContentCompression()` Disables automatic content decompression.
`HttpClientBuilder`	`disableCookieManagement()` Disables state (cookie) management.
`HttpClientBuilder`	`disableRedirectHandling()` Disables automatic redirect handling.
`HttpClientBuilder`	`setBackoffManager(BackoffManager backoffManager)` Assigns `BackoffManager` instance.
`HttpClientBuilder`	`setConnectionBackoffStrategy(ConnectionBackoffStrategy connectionBackoffStrategy)` Assigns `ConnectionBackoffStrategy` instance.
`HttpClientBuilder`	`setConnectionManager(HttpClientConnectionManager connManager)` Assigns `HttpClientConnectionManager` instance.
`HttpClientBuilder`	`setConnectionReuseStrategy(ConnectionReuseStrategy reuseStrategy)` Assigns `ConnectionReuseStrategy` instance.
`HttpClientBuilder`	`setDefaultAuthSchemeRegistry(Lookup<AuthSchemeProvider> authSchemeRegistry)` Assigns default `AuthScheme` registry which will be used for request execution if not explicitly set in the client execution context.
`HttpClientBuilder`	`setDefaultConnectionConfig(ConnectionConfig config)` Assigns default `ConnectionConfig`.
`HttpClientBuilder`	`setDefaultCookieSpecRegistry(Lookup<CookieSpecProvider> cookieSpecRegistry)` Assigns default `CookieSpec` registry which will be used for request execution if not explicitly set in the client execution context.
`HttpClientBuilder`	`setDefaultCookieStore(CookieStore cookieStore)` Assigns default `CookieStore` instance which will be used for request execution if not explicitly set in the client execution context.
`HttpClientBuilder`	`setDefaultCredentialsProvider(CredentialsProvider credentialsProvider)` Assigns default `CredentialsProvider` instance which will be used for request execution if not explicitly set in the client execution context.
`HttpClientBuilder`	`setDefaultHeaders(java.util.Collection<? extends Header> defaultHeaders)` Assigns default request header values.
`HttpClientBuilder`	`setDefaultRequestConfig(RequestConfig config)` Assigns default `RequestConfig` instance which will be used for request execution if not explicitly set in the client execution context.
`HttpClientBuilder`	`setDefaultSocketConfig(SocketConfig config)` Assigns default `SocketConfig`.
`HttpClientBuilder`	`setHostnameVerifier(X509HostnameVerifier hostnameVerifier)` Assigns `X509HostnameVerifier` instance.
`HttpClientBuilder`	`setHttpProcessor(HttpProcessor httpprocessor)` Assigns `HttpProcessor` instance.
`HttpClientBuilder`	`setKeepAliveStrategy(ConnectionKeepAliveStrategy keepAliveStrategy)` Assigns `ConnectionKeepAliveStrategy` instance.
`HttpClientBuilder`	`setMaxConnPerRoute(int maxConnPerRoute)` Assigns maximum connection per route value.
`HttpClientBuilder`	`setMaxConnTotal(int maxConnTotal)` Assigns maximum total connection value.
`HttpClientBuilder`	`setProxy(HttpHost proxy)` Assigns default proxy value.
`HttpClientBuilder`	`setProxyAuthenticationStrategy(AuthenticationStrategy proxyAuthStrategy)` Assigns `AuthenticationStrategy` instance for target host authentication.
`HttpClientBuilder`	`setRedirectStrategy(RedirectStrategy redirectStrategy)` Assigns `RedirectStrategy` instance.
`HttpClientBuilder`	`setRequestExecutor(HttpRequestExecutor requestExec)` Assigns `HttpRequestExecutor` instance.
`HttpClientBuilder`	`setRetryHandler(HttpRequestRetryHandler retryHandler)` Assigns `HttpRequestRetryHandler` instance.
`HttpClientBuilder`	`setRoutePlanner(HttpRoutePlanner routePlanner)` Assigns `HttpRoutePlanner` instance.
`HttpClientBuilder`	`setSchemePortResolver(SchemePortResolver schemePortResolver)` Assigns `SchemePortResolver` instance.
`HttpClientBuilder`	`setServiceUnavailableRetryStrategy(ServiceUnavailableRetryStrategy serviceUnavailStrategy)` Assigns `ServiceUnavailableRetryStrategy` instance.
`HttpClientBuilder`	`setSslcontext(javax.net.ssl.SSLContext sslcontext)` Assigns `SSLContext` instance.
`HttpClientBuilder`	`setSSLSocketFactory(LayeredConnectionSocketFactory sslSocketFactory)` Assigns `LayeredConnectionSocketFactory` instance.
`HttpClientBuilder`	`setTargetAuthenticationStrategy(AuthenticationStrategy targetAuthStrategy)` Assigns `AuthenticationStrategy` instance for proxy authentication.
`HttpClientBuilder`	`setUserAgent(java.lang.String userAgent)` Assigns `User-Agent` value.
`HttpClientBuilder`	`setUserTokenHandler(UserTokenHandler userTokenHandler)` Assigns `UserTokenHandler` instance.
`HttpClientBuilder`	`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
  - HttpClientBuilder
```
protected HttpClientBuilder()
```
- Method Detail
  - create
```
public static HttpClientBuilder create()
```
  - setRequestExecutor
```
public final HttpClientBuilder setRequestExecutor(HttpRequestExecutor requestExec)
```
    Assigns HttpRequestExecutor instance.
  - setHostnameVerifier
```
public final HttpClientBuilder setHostnameVerifier(X509HostnameVerifier hostnameVerifier)
```
    Assigns X509HostnameVerifier instance.
    Please note this value can be overridden by the setConnectionManager( cz.msebera.android.httpclient.conn.HttpClientConnectionManager) and the setSSLSocketFactory( cz.msebera.android.httpclient.conn.socket.LayeredConnectionSocketFactory) methods.
  - setSslcontext
```
public final HttpClientBuilder setSslcontext(javax.net.ssl.SSLContext sslcontext)
```
    Assigns SSLContext instance.
    
    Please note this value can be overridden by the setConnectionManager( cz.msebera.android.httpclient.conn.HttpClientConnectionManager) and the setSSLSocketFactory( cz.msebera.android.httpclient.conn.socket.LayeredConnectionSocketFactory) methods.
  - setSSLSocketFactory
```
public final HttpClientBuilder setSSLSocketFactory(LayeredConnectionSocketFactory sslSocketFactory)
```
    Assigns LayeredConnectionSocketFactory instance.
    Please note this value can be overridden by the setConnectionManager( cz.msebera.android.httpclient.conn.HttpClientConnectionManager) method.
  - setMaxConnTotal
```
public final HttpClientBuilder setMaxConnTotal(int maxConnTotal)
```
    Assigns maximum total connection value.
    Please note this value can be overridden by the setConnectionManager( cz.msebera.android.httpclient.conn.HttpClientConnectionManager) method.
  - setMaxConnPerRoute
```
public final HttpClientBuilder setMaxConnPerRoute(int maxConnPerRoute)
```
    Assigns maximum connection per route value.
    Please note this value can be overridden by the setConnectionManager( cz.msebera.android.httpclient.conn.HttpClientConnectionManager) method.
  - setDefaultSocketConfig
```
public final HttpClientBuilder setDefaultSocketConfig(SocketConfig config)
```
    Assigns default SocketConfig.
    Please note this value can be overridden by the setConnectionManager( cz.msebera.android.httpclient.conn.HttpClientConnectionManager) method.
  - setDefaultConnectionConfig
```
public final HttpClientBuilder setDefaultConnectionConfig(ConnectionConfig config)
```
    Assigns default ConnectionConfig.
    Please note this value can be overridden by the setConnectionManager( cz.msebera.android.httpclient.conn.HttpClientConnectionManager) method.
  - setConnectionManager
```
public final HttpClientBuilder setConnectionManager(HttpClientConnectionManager connManager)
```
    Assigns HttpClientConnectionManager instance.
  - setConnectionReuseStrategy
```
public final HttpClientBuilder setConnectionReuseStrategy(ConnectionReuseStrategy reuseStrategy)
```
    Assigns ConnectionReuseStrategy instance.
  - setKeepAliveStrategy
```
public final HttpClientBuilder setKeepAliveStrategy(ConnectionKeepAliveStrategy keepAliveStrategy)
```
    Assigns ConnectionKeepAliveStrategy instance.
  - setTargetAuthenticationStrategy
```
public final HttpClientBuilder setTargetAuthenticationStrategy(AuthenticationStrategy targetAuthStrategy)
```
    Assigns AuthenticationStrategy instance for proxy authentication.
  - setProxyAuthenticationStrategy
```
public final HttpClientBuilder setProxyAuthenticationStrategy(AuthenticationStrategy proxyAuthStrategy)
```
    Assigns AuthenticationStrategy instance for target host authentication.
  - setUserTokenHandler
```
public final HttpClientBuilder setUserTokenHandler(UserTokenHandler userTokenHandler)
```
    Assigns UserTokenHandler instance.
    Please note this value can be overridden by the disableConnectionState() method.
  - disableConnectionState
```
public final HttpClientBuilder disableConnectionState()
```
    Disables connection state tracking.
  - setSchemePortResolver
```
public final HttpClientBuilder setSchemePortResolver(SchemePortResolver schemePortResolver)
```
    Assigns SchemePortResolver instance.
  - setUserAgent
```
public final HttpClientBuilder setUserAgent(java.lang.String userAgent)
```
    Assigns User-Agent value.
    Please note this value can be overridden by the setHttpProcessor( cz.msebera.android.httpclient.protocol.HttpProcessor) method.
  - setDefaultHeaders
```
public final HttpClientBuilder setDefaultHeaders(java.util.Collection<? extends Header> defaultHeaders)
```
    Assigns default request header values.
    Please note this value can be overridden by the setHttpProcessor( cz.msebera.android.httpclient.protocol.HttpProcessor) method.
  - addInterceptorFirst
```
public final HttpClientBuilder addInterceptorFirst(HttpResponseInterceptor itcp)
```
    Adds this protocol interceptor to the head of the protocol processing list.
    Please note this value can be overridden by the setHttpProcessor( cz.msebera.android.httpclient.protocol.HttpProcessor) method.
  - addInterceptorLast
```
public final HttpClientBuilder addInterceptorLast(HttpResponseInterceptor itcp)
```
    Adds this protocol interceptor to the tail of the protocol processing list.
    Please note this value can be overridden by the setHttpProcessor( cz.msebera.android.httpclient.protocol.HttpProcessor) method.
  - addInterceptorFirst
```
public final HttpClientBuilder addInterceptorFirst(HttpRequestInterceptor itcp)
```
    Adds this protocol interceptor to the head of the protocol processing list.
    Please note this value can be overridden by the setHttpProcessor( cz.msebera.android.httpclient.protocol.HttpProcessor) method.
  - addInterceptorLast
```
public final HttpClientBuilder addInterceptorLast(HttpRequestInterceptor itcp)
```
    Adds this protocol interceptor to the tail of the protocol processing list.
    Please note this value can be overridden by the setHttpProcessor( cz.msebera.android.httpclient.protocol.HttpProcessor) method.
  - disableCookieManagement
```
public final HttpClientBuilder disableCookieManagement()
```
    Disables state (cookie) management.
    Please note this value can be overridden by the setHttpProcessor( cz.msebera.android.httpclient.protocol.HttpProcessor) method.
  - disableContentCompression
```
public final HttpClientBuilder disableContentCompression()
```
    Disables automatic content decompression.
    Please note this value can be overridden by the setHttpProcessor( cz.msebera.android.httpclient.protocol.HttpProcessor) method.
  - disableAuthCaching
```
public final HttpClientBuilder disableAuthCaching()
```
    Disables authentication scheme caching.
    Please note this value can be overridden by the setHttpProcessor( cz.msebera.android.httpclient.protocol.HttpProcessor) method.
  - setHttpProcessor
```
public final HttpClientBuilder setHttpProcessor(HttpProcessor httpprocessor)
```
    Assigns HttpProcessor instance.
  - setRetryHandler
```
public final HttpClientBuilder setRetryHandler(HttpRequestRetryHandler retryHandler)
```
    Assigns HttpRequestRetryHandler instance.
    Please note this value can be overridden by the disableAutomaticRetries() method.
  - disableAutomaticRetries
```
public final HttpClientBuilder disableAutomaticRetries()
```
    Disables automatic request recovery and re-execution.
  - setProxy
```
public final HttpClientBuilder setProxy(HttpHost proxy)
```
    Assigns default proxy value.
    Please note this value can be overridden by the setRoutePlanner( cz.msebera.android.httpclient.conn.routing.HttpRoutePlanner) method.
  - setRoutePlanner
```
public final HttpClientBuilder setRoutePlanner(HttpRoutePlanner routePlanner)
```
    Assigns HttpRoutePlanner instance.
  - setRedirectStrategy
```
public final HttpClientBuilder setRedirectStrategy(RedirectStrategy redirectStrategy)
```
    Assigns RedirectStrategy instance.
    Please note this value can be overridden by the disableRedirectHandling() method. `
  - disableRedirectHandling
```
public final HttpClientBuilder disableRedirectHandling()
```
    Disables automatic redirect handling.
  - setConnectionBackoffStrategy
```
public final HttpClientBuilder setConnectionBackoffStrategy(ConnectionBackoffStrategy connectionBackoffStrategy)
```
    Assigns ConnectionBackoffStrategy instance.
  - setBackoffManager
```
public final HttpClientBuilder setBackoffManager(BackoffManager backoffManager)
```
    Assigns BackoffManager instance.
  - setServiceUnavailableRetryStrategy
```
public final HttpClientBuilder setServiceUnavailableRetryStrategy(ServiceUnavailableRetryStrategy serviceUnavailStrategy)
```
    Assigns ServiceUnavailableRetryStrategy instance.
  - setDefaultCookieStore
```
public final HttpClientBuilder setDefaultCookieStore(CookieStore cookieStore)
```
    Assigns default CookieStore instance which will be used for request execution if not explicitly set in the client execution context.
  - setDefaultCredentialsProvider
```
public final HttpClientBuilder 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 HttpClientBuilder setDefaultAuthSchemeRegistry(Lookup<AuthSchemeProvider> authSchemeRegistry)
```
    Assigns default AuthScheme registry which will be used for request execution if not explicitly set in the client execution context.
  - setDefaultCookieSpecRegistry
```
public final HttpClientBuilder setDefaultCookieSpecRegistry(Lookup<CookieSpecProvider> cookieSpecRegistry)
```
    Assigns default CookieSpec registry which will be used for request execution if not explicitly set in the client execution context.
  - setDefaultRequestConfig
```
public final HttpClientBuilder 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 HttpClientBuilder useSystemProperties()
```
    Use system properties when creating and configuring default implementations.
  - decorateMainExec
```
protected ClientExecChain decorateMainExec(ClientExecChain mainExec)
```
    For internal use.
  - decorateProtocolExec
```
protected ClientExecChain decorateProtocolExec(ClientExecChain protocolExec)
```
    For internal use.
  - addCloseable
```
protected void addCloseable(java.io.Closeable closeable)
```
    For internal use.
  - build
```
public CloseableHttpClient build()
```

Class HttpClientBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpClientBuilder

Method Detail

create

setRequestExecutor

setHostnameVerifier

setSslcontext

setSSLSocketFactory

setMaxConnTotal

setMaxConnPerRoute

setDefaultSocketConfig

setDefaultConnectionConfig

setConnectionManager

setConnectionReuseStrategy

setKeepAliveStrategy

setTargetAuthenticationStrategy

setProxyAuthenticationStrategy

setUserTokenHandler

disableConnectionState

setSchemePortResolver

setUserAgent

setDefaultHeaders

addInterceptorFirst

addInterceptorLast

addInterceptorFirst

addInterceptorLast

disableCookieManagement

disableContentCompression

disableAuthCaching

setHttpProcessor

setRetryHandler

disableAutomaticRetries

setProxy

setRoutePlanner

setRedirectStrategy

disableRedirectHandling

setConnectionBackoffStrategy

setBackoffManager

setServiceUnavailableRetryStrategy

setDefaultCookieStore

setDefaultCredentialsProvider

setDefaultAuthSchemeRegistry

setDefaultCookieSpecRegistry

setDefaultRequestConfig

useSystemProperties

decorateMainExec

decorateProtocolExec

addCloseable

build