HttpClientBuilder (java-support 7.5.0 API)

java.lang.Object
- net.shibboleth.utilities.java.support.httpclient.HttpClientBuilder

Direct Known Subclasses:

FileCachingHttpClientBuilder, InMemoryCachingHttpClientBuilder
```
public class HttpClientBuilder
extends Object
```
Builder used to construct HttpClient objects configured with particular settings.
When using the single-arg constructor variant to wrap an existing instance of HttpClientBuilder, there are several caveats of which to be aware:
- Instances of the following which are set as the default instance on the Apache builder will be unconditionally overwritten by this builder when buildClient() is called:
  - RequestConfig
  - ConnectionConfig
  This is due to the unfortunate fact that the Apache builder does not currently provide accessor methods to obtain the default instances currently set on the builder. Therefore, if you need to set any default request or connection config parameters which are not exposed by this builder, then you must use the Apache builder directly and may not use this builder.
- If this builder's connectionDisregardTLSCertificate is set to true, then any value previously set via the Apache builder's HttpClientBuilder.setSSLSocketFactory(org.apache.http.conn.socket.LayeredConnectionSocketFactory) will be unconditionally overwritten.
- If this builder is supplied with a connectionProxyHost, connectionProxyUsername and connectionProxyPassword, then any value previously set via the Apache builder's HttpClientBuilder.setDefaultCredentialsProvider(CredentialsProvider) will be unconditionally overwritten.
- Per the Apache builder's Javadoc, if a non-null instance of HttpClientConnectionManager is set on the Apache builder via HttpClientBuilder.setConnectionManager(org.apache.http.conn.HttpClientConnectionManager), this supersedes various other properties set on the Apache builder. This includes the following instances/properties on the Apache builder:
  - SSLSocketFactory (LayeredConnectionSocketFactory)
  - SSLContext
  - X509HostnameVerifier
  - SocketConfig
  - ConnectionConfig
  - maxConnTotal
  - maxConnPerRoute
  Similarly, the following setters on this builder will become ineffective when a non-null connection manger is set on the Apache builder:
  Therefore, if you need to explicitly supply a connection manager instance to the Apache builder (for example in order to be able to use IdleConnectionSweeper), then you must supply these properties or instances directly to the connection manager rather than to this builder or the Apache builder.
- Similar to the above issue, setting an explicit SSLSocketFactory on the Apache builder will supersede the following Apache builder properties:
  - SSLContext
  - X509HostnameVerifier

Field Summary

Fields
Modifier and Type	Field and Description
`private HttpClientBuilder`	`apacheBuilder` The Apache HttpClientBuilder 4.3+ instance over which to layer this builder.
`private boolean`	`connectionCloseAfterResponse` Whether to instruct the server to close the connection after it has sent its response.
`private boolean`	`connectionDisregardTLSCertificate` Whether the SSL/TLS certificates used by the responder should be ignored.
`private String`	`connectionProxyHost` Host name of the HTTP proxy server through which connections will be made.
`private String`	`connectionProxyPassword` Password used to connect to the HTTP proxy server.
`private int`	`connectionProxyPort` Port number of the HTTP proxy server through which connections will be made.
`private String`	`connectionProxyUsername` Username used to connect to the HTTP proxy server.
`private int`	`connectionRequestTimeout` Maximum length of time in milliseconds to wait for a connection to be returned from the connection manager.
`private boolean`	`connectionStaleCheck` Whether to check a connection for staleness before using.
`private int`	`connectionTimeout` Maximum length of time in milliseconds to wait for the connection to be established.
`private boolean`	`disableAuthCaching` Flag for disabling auth caching.
`private boolean`	`disableAutomaticRetries` Flag for disabling automatic retries.
`private boolean`	`disableConnectionState` Flag for disabling connection state.
`private boolean`	`disableContentCompression` Flag for disabling content compression.
`private boolean`	`disableCookieManagement` Flag for disabling cookie management.
`private boolean`	`disableRedirectHandling` Flag for disabling redirect handling.
`private String`	`httpContentCharSet` Character set used for HTTP entity content.
`private boolean`	`httpFollowRedirects` Whether to follow HTTP redirects.
`private int`	`maxConnectionsPerRoute` Max simultaneous connections per route allowed by the pooling connection manager.
`private int`	`maxConnectionsTotal` Max total simultaneous connections allowed by the pooling connection manager.
`private List<org.apache.http.HttpRequestInterceptor>`	`requestInterceptorsFirst` List of request interceptors to add first.
`private List<org.apache.http.HttpRequestInterceptor>`	`requestInterceptorsLast` List of request interceptors to add last.
`private List<org.apache.http.HttpResponseInterceptor>`	`responseInterceptorsFirst` List of response interceptors to add first.
`private List<org.apache.http.HttpResponseInterceptor>`	`responseInterceptorsLast` List of response interceptors to add last.
`private HttpRequestRetryHandler`	`retryHandler` Handler which determines if a request should be retried after a recoverable exception during execution.
`private ServiceUnavailableRetryStrategy`	`serviceUnavailStrategy` Strategy which determines if a request should be retried given the response from the target server.
`private int`	`socketBufferSize` Socket buffer size in bytes.
`private InetAddress`	`socketLocalAddress` Local IP address used when establishing connections.
`private int`	`socketTimeout` Maximum period inactivity between two consecutive data packets in milliseconds.
`private List<HttpClientContextHandler>`	`staticContextHandlers` List of static context handlers.
`private LayeredConnectionSocketFactory`	`tlsSocketFactory` The TLS socket factory to use.
`private String`	`userAgent` Apache UserAgent.
`private boolean`	`useSystemProperties` Flag for enabling use of system properties.

Constructor Summary

Constructors
Constructor and Description

HttpClientBuilder()
Constructor.

HttpClientBuilder(HttpClientBuilder builder)
Constructor.

Constructors
Constructor and Description
`HttpClientBuilder()` Constructor.
`HttpClientBuilder(HttpClientBuilder builder)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`HttpClient`	`buildClient()` Constructs an `HttpClient` using the settings of this builder.
`protected void`	`decorateApacheBuilder()` Decorate the Apache builder as determined by this builder's parameters.
`protected HttpClientBuilder`	`getApacheBuilder()` Get the Apache `HttpClientBuilder` instance over which this builder will be layered.
`String`	`getConnectionProxyHost()` Gets the hostname of the default proxy used when making connection.
`String`	`getConnectionProxyPassword()` Gets the password used when authenticating to the proxy.
`int`	`getConnectionProxyPort()` Gets the port of the default proxy used when making connection.
`String`	`getConnectionProxyUsername()` Gets the username to use when authenticating to the proxy.
`int`	`getConnectionRequestTimeout()` Gets the maximum length of time in milliseconds to wait for a connection to be returned from the connection manager.
`int`	`getConnectionTimeout()` Gets the maximum length of time in milliseconds to wait for the connection to be established.
`List<org.apache.http.HttpRequestInterceptor>`	`getFirstRequestInterceptors()` Get the list of request interceptors to add first.
`List<org.apache.http.HttpResponseInterceptor>`	`getFirstResponseInterceptors()` Get the list of response interceptors to add first.
`String`	`getHttpContentCharSet()` Gets the character set used with the HTTP entity (body).
`HttpRequestRetryHandler`	`getHttpRequestRetryHandler()` Get the handler which determines if a request should be retried after a recoverable exception during execution.
`List<org.apache.http.HttpRequestInterceptor>`	`getLastRequestInterceptors()` Get the list of request interceptors to add last.
`List<org.apache.http.HttpResponseInterceptor>`	`getLastResponseInterceptors()` Get the list of response interceptors to add last.
`int`	`getMaxConnectionsPerRoute()` Gets the max simultaneous connections per route allowed by the pooling connection manager.
`int`	`getMaxConnectionsTotal()` Gets the max total simultaneous connections allowed by the pooling connection manager.
`ServiceUnavailableRetryStrategy`	`getServiceUnavailableRetryHandler()` Get the handler which determines if a request should be retried given the response from the target server.
`int`	`getSocketBufferSize()` Gets the size of the socket buffer, in bytes, used for request/response buffering.
`InetAddress`	`getSocketLocalAddress()` Gets the local IP address used when making requests.
`int`	`getSocketTimeout()` Gets the maximum period inactivity between two consecutive data packets in milliseconds.
`List<HttpClientContextHandler>`	`getStaticContextHandlers()` Get the list of static `HttpClientContextHandler`.
`LayeredConnectionSocketFactory`	`getTLSSocketFactory()` Get the TLS socket factory to use.
`String`	`getUserAgent()` Gets user agent.
`boolean`	`isConnectionCloseAfterResponse()` Gets whether to instruct the server to close the connection after it has sent its response.
`boolean`	`isConnectionDisregardTLSCertificate()` Gets whether the responder's SSL/TLS certificate should be ignored.
`boolean`	`isConnectionStalecheck()` Deprecated. use `isConnectionStaleCheck()`
`boolean`	`isConnectionStaleCheck()` Gets whether reused connections are checked if they are closed before being used by the client.
`boolean`	`isDisableAuthCaching()` Get the flag for disabling auth caching.
`boolean`	`isDisableAutomaticRetries()` Get the flag for disabling automatic retries.
`boolean`	`isDisableConnectionState()` Get the flag for disabling connection state.
`boolean`	`isDisableContentCompression()` Get the flag for disabling content compression.
`boolean`	`isDisableCookieManagement()` Get the flag for disabling cookie management.
`boolean`	`isDisableRedirectHandling()` Get the flag for disabling redirect handling.
`boolean`	`isHttpFollowRedirects()` Gets whether HTTP redirects will be followed.
`boolean`	`isUseSystemProperties()` Get the flag enabling use of system properties.
`private <T> List<T>`	`normalizeList(List<T> items)` Normalize and copy the supplied list to remove nulls.
`void`	`resetDefaults()` Resets all builder parameters to their defaults.
`void`	`setConnectionCloseAfterResponse(boolean close)` Sets whether to instruct the server to close the connection after it has sent its response.
`void`	`setConnectionDisregardTLSCertificate(boolean disregard)` Sets whether the responder's SSL/TLS certificate should be ignored.
`void`	`setConnectionProxyHost(String host)` Sets the hostname of the default proxy used when making connection.
`void`	`setConnectionProxyPassword(String password)` Sets the password used when authenticating to the proxy.
`void`	`setConnectionProxyPort(int port)` Sets the port of the default proxy used when making connection.
`void`	`setConnectionProxyUsername(String usename)` Sets the username to use when authenticating to the proxy.
`void`	`setConnectionRequestTimeout(long timeout)` Sets the maximum length of time in milliseconds to wait for a connection to be returned from the connection manager.
`void`	`setConnectionStalecheck(boolean check)` Deprecated. use `setConnectionStaleCheck(boolean)`
`void`	`setConnectionStaleCheck(boolean check)` Sets whether reused connections are checked if they are closed before being used by the client.
`void`	`setConnectionTimeout(long timeout)` Sets the maximum length of time in milliseconds to wait for the connection to be established.
`void`	`setDisableAuthCaching(boolean flag)` Set the flag for disabling auth caching.
`void`	`setDisableAutomaticRetries(boolean flag)` Set the flag for disabling automatic retries.
`void`	`setDisableConnectionState(boolean flag)` Set the flag for disabling connection state.
`void`	`setDisableContentCompression(boolean flag)` Set the flag for disabling content compression.
`void`	`setDisableCookieManagement(boolean flag)` Set the flag for disabling cookie management.
`void`	`setDisableRedirectHandling(boolean flag)` Set the flag for disabling redirect handling.
`void`	`setFirstRequestInterceptors(List<org.apache.http.HttpRequestInterceptor> interceptors)` Set the list of request interceptors to add first.
`void`	`setFirstResponseInterceptors(List<org.apache.http.HttpResponseInterceptor> interceptors)` Set the list of response interceptors to add first.
`void`	`setHttpContentCharSet(String charSet)` Sets the character set used with the HTTP entity (body).
`void`	`setHttpFollowRedirects(boolean followRedirects)` Gets whether HTTP redirects will be followed.
`void`	`setHttpRequestRetryHandler(HttpRequestRetryHandler handler)` Set the handler which determines if a request should be retried after a recoverable exception during execution.
`void`	`setLastRequestInterceptors(List<org.apache.http.HttpRequestInterceptor> interceptors)` Set the list of request interceptors to add last.
`void`	`setLastResponseInterceptors(List<org.apache.http.HttpResponseInterceptor> interceptors)` Set the list of response interceptors to add last.
`void`	`setMaxConnectionsPerRoute(int max)` Sets the max simultaneous connections per route allowed by the pooling connection manager.
`void`	`setMaxConnectionsTotal(int max)` Sets the max total simultaneous connections allowed by the pooling connection manager.
`void`	`setServiceUnavailableRetryHandler(ServiceUnavailableRetryStrategy strategy)` Set the strategy which determines if a request should be retried given the response from the target server.
`void`	`setSocketBufferSize(int size)` Sets size of the socket buffer, in bytes, used for request/response buffering.
`void`	`setSocketLocalAddress(InetAddress address)` Sets the local IP address used when making requests.
`void`	`setSocketLocalAddress(String ipOrHost)` Sets the local IP address used when making requests.
`void`	`setSocketTimeout(long timeout)` Sets the maximum period inactivity between two consecutive data packets in milliseconds.
`void`	`setStaticContextHandlers(List<HttpClientContextHandler> handlers)` Set the list of static `HttpClientContextHandler`.
`void`	`setTLSSocketFactory(LayeredConnectionSocketFactory factory)` Set the TLS socket factory to use.
`void`	`setUserAgent(String what)` Sets user agent.
`void`	`setUseSystemProperties(boolean flag)` Set the flag enabling use of system properties.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - socketLocalAddress
```
private InetAddress socketLocalAddress
```
    Local IP address used when establishing connections. Default value: system default local address
  - socketTimeout
```
@Duration
private int socketTimeout
```
    Maximum period inactivity between two consecutive data packets in milliseconds. Default value: 60000 (60 seconds)
  - socketBufferSize
```
private int socketBufferSize
```
    Socket buffer size in bytes. Default size is 8192 bytes.
  - connectionTimeout
```
@Duration
private int connectionTimeout
```
    Maximum length of time in milliseconds to wait for the connection to be established. Default value: 60000 (60 seconds)
  - connectionRequestTimeout
```
@Duration
private int connectionRequestTimeout
```
    Maximum length of time in milliseconds to wait for a connection to be returned from the connection manager. Default value: 60000 (60 seconds);
  - maxConnectionsTotal
```
private int maxConnectionsTotal
```
    Max total simultaneous connections allowed by the pooling connection manager.
  - maxConnectionsPerRoute
```
private int maxConnectionsPerRoute
```
    Max simultaneous connections per route allowed by the pooling connection manager.
  - connectionDisregardTLSCertificate
```
private boolean connectionDisregardTLSCertificate
```
    Whether the SSL/TLS certificates used by the responder should be ignored. Default value: false
  - tlsSocketFactory
```
@Nullable
private LayeredConnectionSocketFactory tlsSocketFactory
```
    The TLS socket factory to use. Optional, defaults to null.
  - connectionCloseAfterResponse
```
private boolean connectionCloseAfterResponse
```
    Whether to instruct the server to close the connection after it has sent its response. Default value: true
  - connectionStaleCheck
```
private boolean connectionStaleCheck
```
    Whether to check a connection for staleness before using. This can be an expensive operation. Default value: false
  - connectionProxyHost
```
@Nullable
private String connectionProxyHost
```
    Host name of the HTTP proxy server through which connections will be made. Default value: null.
  - userAgent
```
@Nullable
private String userAgent
```
    Apache UserAgent.
  - connectionProxyPort
```
private int connectionProxyPort
```
    Port number of the HTTP proxy server through which connections will be made. Default value: 8080.
  - connectionProxyUsername
```
@Nullable
private String connectionProxyUsername
```
    Username used to connect to the HTTP proxy server. Default value: null.
  - connectionProxyPassword
```
@Nullable
private String connectionProxyPassword
```
    Password used to connect to the HTTP proxy server. Default value: null.
  - httpFollowRedirects
```
private boolean httpFollowRedirects
```
    Whether to follow HTTP redirects. Default value: true
  - httpContentCharSet
```
@Nullable
private String httpContentCharSet
```
    Character set used for HTTP entity content. Default value: UTF-8
  - retryHandler
```
@Nullable
private HttpRequestRetryHandler retryHandler
```
    Handler which determines if a request should be retried after a recoverable exception during execution.
  - serviceUnavailStrategy
```
@Nullable
private ServiceUnavailableRetryStrategy serviceUnavailStrategy
```
    Strategy which determines if a request should be retried given the response from the target server.
  - disableAuthCaching
```
private boolean disableAuthCaching
```
    Flag for disabling auth caching.
  - disableAutomaticRetries
```
private boolean disableAutomaticRetries
```
    Flag for disabling automatic retries.
  - disableConnectionState
```
private boolean disableConnectionState
```
    Flag for disabling connection state.
  - disableContentCompression
```
private boolean disableContentCompression
```
    Flag for disabling content compression.
  - disableCookieManagement
```
private boolean disableCookieManagement
```
    Flag for disabling cookie management.
  - disableRedirectHandling
```
private boolean disableRedirectHandling
```
    Flag for disabling redirect handling.
  - useSystemProperties
```
private boolean useSystemProperties
```
    Flag for enabling use of system properties.
  - requestInterceptorsFirst
```
private List<org.apache.http.HttpRequestInterceptor> requestInterceptorsFirst
```
    List of request interceptors to add first.
  - requestInterceptorsLast
```
private List<org.apache.http.HttpRequestInterceptor> requestInterceptorsLast
```
    List of request interceptors to add last.
  - responseInterceptorsFirst
```
private List<org.apache.http.HttpResponseInterceptor> responseInterceptorsFirst
```
    List of response interceptors to add first.
  - responseInterceptorsLast
```
private List<org.apache.http.HttpResponseInterceptor> responseInterceptorsLast
```
    List of response interceptors to add last.
  - staticContextHandlers
```
@Nonnull
@NonnullElements
private List<HttpClientContextHandler> staticContextHandlers
```
    List of static context handlers.
  - apacheBuilder
```
private HttpClientBuilder apacheBuilder
```
    The Apache HttpClientBuilder 4.3+ instance over which to layer this builder.
- Constructor Detail
  - HttpClientBuilder
```
public HttpClientBuilder()
```
    Constructor.
  - HttpClientBuilder
```
public HttpClientBuilder(@Nonnull
                 HttpClientBuilder builder)
```
    Constructor.
    
    Parameters:
    builder - the Apache HttpClientBuilder 4.3+ instance over which to layer this builder
- Method Detail
  - resetDefaults
```
public void resetDefaults()
```
    Resets all builder parameters to their defaults.
  - getMaxConnectionsTotal
```
public int getMaxConnectionsTotal()
```
    Gets the max total simultaneous connections allowed by the pooling connection manager.
    
    Returns:
    the max total connections
  - setMaxConnectionsTotal
```
public void setMaxConnectionsTotal(int max)
```
    Sets the max total simultaneous connections allowed by the pooling connection manager.
    
    Parameters:
    max - the max total connection
  - getMaxConnectionsPerRoute
```
public int getMaxConnectionsPerRoute()
```
    Gets the max simultaneous connections per route allowed by the pooling connection manager.
    
    Returns:
    the max connections per route
  - setMaxConnectionsPerRoute
```
public void setMaxConnectionsPerRoute(int max)
```
    Sets the max simultaneous connections per route allowed by the pooling connection manager.
    
    Parameters:
    max - the max connections per route
  - getSocketLocalAddress
```
public InetAddress getSocketLocalAddress()
```
    Gets the local IP address used when making requests.
    
    Returns:
    local IP address used when making requests
  - setSocketLocalAddress
```
public void setSocketLocalAddress(InetAddress address)
```
    Sets the local IP address used when making requests.
    
    Parameters:
    address - local IP address used when making requests
  - setSocketLocalAddress
```
public void setSocketLocalAddress(String ipOrHost)
                           throws UnknownHostException
```
    Sets the local IP address used when making requests.
    
    Parameters:
    ipOrHost - IP address or hostname, never null
    
    Throws:
    
    UnknownHostException - thrown if the given IP or hostname can not be resolved
  - getSocketTimeout
```
@Duration
public int getSocketTimeout()
```
    Gets the maximum period inactivity between two consecutive data packets in milliseconds. A value of less than 1 indicates no timeout.
    
    Returns:
    maximum period inactivity between two consecutive data packets in milliseconds
  - setSocketTimeout
```
public void setSocketTimeout(@Duration
                    long timeout)
```
    Sets the maximum period inactivity between two consecutive data packets in milliseconds. A value of less than 1 indicates no timeout.
    
    Parameters:
    timeout - maximum period inactivity between two consecutive data packets in milliseconds
  - getSocketBufferSize
```
public int getSocketBufferSize()
```
    Gets the size of the socket buffer, in bytes, used for request/response buffering.
    
    Returns:
    size of the socket buffer, in bytes, used for request/response buffering
  - setSocketBufferSize
```
public void setSocketBufferSize(int size)
```
    Sets size of the socket buffer, in bytes, used for request/response buffering.
    
    Parameters:
    size - size of the socket buffer, in bytes, used for request/response buffering; must be greater than 0
  - getConnectionTimeout
```
@Duration
public int getConnectionTimeout()
```
    Gets the maximum length of time in milliseconds to wait for the connection to be established. A value of less than 1 indicates no timeout.
    
    Returns:
    maximum length of time in milliseconds to wait for the connection to be established
  - setConnectionTimeout
```
public void setConnectionTimeout(@Duration
                        long timeout)
```
    Sets the maximum length of time in milliseconds to wait for the connection to be established. A value of less than 1 indicates no timeout.
    
    Parameters:
    timeout - maximum length of time in milliseconds to wait for the connection to be established
  - getConnectionRequestTimeout
```
@Duration
public int getConnectionRequestTimeout()
```
    Gets the maximum length of time in milliseconds to wait for a connection to be returned from the connection manager. A value of less than 1 indicates no timeout.
    
    Returns:
    maximum length of time in milliseconds to wait for the connection to be established
  - setConnectionRequestTimeout
```
public void setConnectionRequestTimeout(@Duration
                               long timeout)
```
    Sets the maximum length of time in milliseconds to wait for a connection to be returned from the connection manager. A value of less than 1 indicates no timeout.
    
    Parameters:
    timeout - maximum length of time in milliseconds to wait for the connection to be established
  - isConnectionDisregardTLSCertificate
```
public boolean isConnectionDisregardTLSCertificate()
```
    Gets whether the responder's SSL/TLS certificate should be ignored.
    This flag is overridden and ignored if a custom TLS socket factory is specified via setTLSSocketFactory(org.apache.http.conn.socket.LayeredConnectionSocketFactory).
    
    Returns:
    whether the responder's SSL/TLS certificate should be ignored
  - setConnectionDisregardTLSCertificate
```
public void setConnectionDisregardTLSCertificate(boolean disregard)
```
    Sets whether the responder's SSL/TLS certificate should be ignored.
    This flag is overridden and ignored if a custom TLS socket factory is specified via setTLSSocketFactory(org.apache.http.conn.socket.LayeredConnectionSocketFactory).
    
    Parameters:
    disregard - whether the responder's SSL/TLS certificate should be ignored
  - getTLSSocketFactory
```
@Nullable
public LayeredConnectionSocketFactory getTLSSocketFactory()
```
    Get the TLS socket factory to use.
    
    Returns:
    the socket factory, or null.
  - setTLSSocketFactory
```
public void setTLSSocketFactory(@Nullable
                       LayeredConnectionSocketFactory factory)
```
    Set the TLS socket factory to use.
    
    Parameters:
    factory - the new socket factory, may be null
  - isConnectionCloseAfterResponse
```
public boolean isConnectionCloseAfterResponse()
```
    Gets whether to instruct the server to close the connection after it has sent its response.
    
    Returns:
    whether to instruct the server to close the connection after it has sent its response
  - setConnectionCloseAfterResponse
```
public void setConnectionCloseAfterResponse(boolean close)
```
    Sets whether to instruct the server to close the connection after it has sent its response.
    
    Parameters:
    close - whether to instruct the server to close the connection after it has sent its response
  - isConnectionStalecheck
```
public boolean isConnectionStalecheck()
```
    Deprecated. use isConnectionStaleCheck()
    
    Gets whether reused connections are checked if they are closed before being used by the client.
    
    Returns:
    whether reused connections are checked if they are closed before being used by the client
  - setConnectionStalecheck
```
public void setConnectionStalecheck(boolean check)
```
    Deprecated. use setConnectionStaleCheck(boolean)
    
    Sets whether reused connections are checked if they are closed before being used by the client. Checking can take up to 30ms (per request). If checking is turned off an I/O error occurs if the connection is used request. This should be enabled uncles the code using the client explicitly handles the error case and retries connection as appropriate.
    
    Parameters:
    check - whether reused connections are checked if they are closed before being used by the client
  - isConnectionStaleCheck
```
public boolean isConnectionStaleCheck()
```
    Gets whether reused connections are checked if they are closed before being used by the client.
    
    Returns:
    whether reused connections are checked if they are closed before being used by the client
  - setConnectionStaleCheck
```
public void setConnectionStaleCheck(boolean check)
```
    Sets whether reused connections are checked if they are closed before being used by the client. Checking can take up to 30ms (per request). If checking is turned off an I/O error occurs if the connection is used request. This should be enabled uncles the code using the client explicitly handles the error case and retries connection as appropriate.
    
    Parameters:
    check - whether reused connections are checked if they are closed before being used by the client
  - getConnectionProxyHost
```
@Nullable
public String getConnectionProxyHost()
```
    Gets the hostname of the default proxy used when making connection. A null indicates no default proxy.
    
    Returns:
    hostname of the default proxy used when making connection
  - setConnectionProxyHost
```
public void setConnectionProxyHost(@Nullable
                          String host)
```
    Sets the hostname of the default proxy used when making connection. A null indicates no default proxy.
    
    Parameters:
    host - hostname of the default proxy used when making connection
  - getConnectionProxyPort
```
public int getConnectionProxyPort()
```
    Gets the port of the default proxy used when making connection.
    
    Returns:
    port of the default proxy used when making connection
  - setConnectionProxyPort
```
public void setConnectionProxyPort(int port)
```
    Sets the port of the default proxy used when making connection.
    
    Parameters:
    port - port of the default proxy used when making connection; must be greater than 0 and less than 65536
  - getConnectionProxyUsername
```
@Nullable
public String getConnectionProxyUsername()
```
    Gets the username to use when authenticating to the proxy.
    
    Returns:
    username to use when authenticating to the proxy
  - setConnectionProxyUsername
```
public void setConnectionProxyUsername(@Nullable
                              String usename)
```
    Sets the username to use when authenticating to the proxy.
    
    Parameters:
    usename - username to use when authenticating to the proxy; may be null
  - getConnectionProxyPassword
```
@Nullable
public String getConnectionProxyPassword()
```
    Gets the password used when authenticating to the proxy.
    
    Returns:
    password used when authenticating to the proxy
  - setConnectionProxyPassword
```
public void setConnectionProxyPassword(@Nullable
                              String password)
```
    Sets the password used when authenticating to the proxy.
    
    Parameters:
    password - password used when authenticating to the proxy; may be null
  - isHttpFollowRedirects
```
public boolean isHttpFollowRedirects()
```
    Gets whether HTTP redirects will be followed.
    
    Returns:
    whether HTTP redirects will be followed
  - setHttpFollowRedirects
```
public void setHttpFollowRedirects(boolean followRedirects)
```
    Gets whether HTTP redirects will be followed.
    
    Parameters:
    followRedirects - true if redirects are followed, false otherwise
  - getHttpContentCharSet
```
@Nullable
public String getHttpContentCharSet()
```
    Gets the character set used with the HTTP entity (body).
    
    Returns:
    character set used with the HTTP entity (body)
  - setHttpContentCharSet
```
public void setHttpContentCharSet(@Nullable
                         String charSet)
```
    Sets the character set used with the HTTP entity (body).
    
    Parameters:
    charSet - character set used with the HTTP entity (body)
  - getUserAgent
```
@Nullable
public String getUserAgent()
```
    Gets user agent.
    
    Returns:
    The user agent.
  - setUserAgent
```
public void setUserAgent(@Nullable
                String what)
```
    Sets user agent.
    
    Parameters:
    what - what to set. If this is null Apache will use the default.
  - getHttpRequestRetryHandler
```
@Nullable
public HttpRequestRetryHandler getHttpRequestRetryHandler()
```
    Get the handler which determines if a request should be retried after a recoverable exception during execution.
    
    Returns:
    handler which determines if a request should be retried
  - setHttpRequestRetryHandler
```
public void setHttpRequestRetryHandler(@Nullable
                              HttpRequestRetryHandler handler)
```
    Set the handler which determines if a request should be retried after a recoverable exception during execution.
    
    Parameters:
    handler - handler which determines if a request should be retried
  - getServiceUnavailableRetryHandler
```
@Nullable
public ServiceUnavailableRetryStrategy getServiceUnavailableRetryHandler()
```
    Get the handler which determines if a request should be retried given the response from the target server.
    
    Returns:
    handler which determines if a request should be retried
  - setServiceUnavailableRetryHandler
```
public void setServiceUnavailableRetryHandler(@Nullable
                                     ServiceUnavailableRetryStrategy strategy)
```
    Set the strategy which determines if a request should be retried given the response from the target server.
    
    Parameters:
    strategy - handler which determines if a request should be retried
  - isDisableAuthCaching
```
public boolean isDisableAuthCaching()
```
    Get the flag for disabling auth caching.
    
    Returns:
    true if disabled, false if not
  - setDisableAuthCaching
```
public void setDisableAuthCaching(boolean flag)
```
    Set the flag for disabling auth caching.
    
    Parameters:
    flag - true if disabled, false if not
  - isDisableAutomaticRetries
```
public boolean isDisableAutomaticRetries()
```
    Get the flag for disabling automatic retries.
    
    Returns:
    true if disabled, false if not
  - setDisableAutomaticRetries
```
public void setDisableAutomaticRetries(boolean flag)
```
    Set the flag for disabling automatic retries.
    
    Parameters:
    flag - true if disabled, false if not
  - isDisableConnectionState
```
public boolean isDisableConnectionState()
```
    Get the flag for disabling connection state.
    
    Returns:
    true if disabled, false if not
  - setDisableConnectionState
```
public void setDisableConnectionState(boolean flag)
```
    Set the flag for disabling connection state.
    
    Parameters:
    flag - true if disabled, false if not
  - isDisableContentCompression
```
public boolean isDisableContentCompression()
```
    Get the flag for disabling content compression.
    
    Returns:
    true if disabled, false if not
  - setDisableContentCompression
```
public void setDisableContentCompression(boolean flag)
```
    Set the flag for disabling content compression.
    
    Parameters:
    flag - true if disabled, false if not
  - isDisableCookieManagement
```
public boolean isDisableCookieManagement()
```
    Get the flag for disabling cookie management.
    
    Returns:
    true if disabled, false if not
  - setDisableCookieManagement
```
public void setDisableCookieManagement(boolean flag)
```
    Set the flag for disabling cookie management.
    
    Parameters:
    flag - true if disabled, false if not
  - isDisableRedirectHandling
```
public boolean isDisableRedirectHandling()
```
    Get the flag for disabling redirect handling.
    
    Returns:
    true if disabled, false if not
  - setDisableRedirectHandling
```
public void setDisableRedirectHandling(boolean flag)
```
    Set the flag for disabling redirect handling.
    
    Parameters:
    flag - true if disabled, false if not
  - isUseSystemProperties
```
public boolean isUseSystemProperties()
```
    Get the flag enabling use of system properties.
    
    Returns:
    true if enabled, false if not
  - setUseSystemProperties
```
public void setUseSystemProperties(boolean flag)
```
    Set the flag enabling use of system properties.
    
    Parameters:
    flag - true if enabled, false if not
  - getFirstRequestInterceptors
```
@Nullable
public List<org.apache.http.HttpRequestInterceptor> getFirstRequestInterceptors()
```
    Get the list of request interceptors to add first.
    
    Returns:
    the list of interceptors, may be null
  - setFirstRequestInterceptors
```
public void setFirstRequestInterceptors(@Nullable
                               List<org.apache.http.HttpRequestInterceptor> interceptors)
```
    Set the list of request interceptors to add first.
    
    Parameters:
    interceptors - the list of interceptors, may be null
  - getLastRequestInterceptors
```
@Nullable
public List<org.apache.http.HttpRequestInterceptor> getLastRequestInterceptors()
```
    Get the list of request interceptors to add last.
    
    Returns:
    the list of interceptors, may be null
  - setLastRequestInterceptors
```
public void setLastRequestInterceptors(@Nullable
                              List<org.apache.http.HttpRequestInterceptor> interceptors)
```
    Set the list of request interceptors to add last.
    
    Parameters:
    interceptors - the list of interceptors, may be null
  - getFirstResponseInterceptors
```
@Nullable
public List<org.apache.http.HttpResponseInterceptor> getFirstResponseInterceptors()
```
    Get the list of response interceptors to add first.
    
    Returns:
    the list of interceptors, may be null
  - setFirstResponseInterceptors
```
public void setFirstResponseInterceptors(@Nullable
                                List<org.apache.http.HttpResponseInterceptor> interceptors)
```
    Set the list of response interceptors to add first.
    
    Parameters:
    interceptors - the list of interceptors, may be null
  - getLastResponseInterceptors
```
@Nullable
public List<org.apache.http.HttpResponseInterceptor> getLastResponseInterceptors()
```
    Get the list of response interceptors to add last.
    
    Returns:
    the list of interceptors, may be null
  - setLastResponseInterceptors
```
public void setLastResponseInterceptors(@Nullable
                               List<org.apache.http.HttpResponseInterceptor> interceptors)
```
    Set the list of response interceptors to add last.
    
    Parameters:
    interceptors - the list of interceptors, may be null
  - getStaticContextHandlers
```
@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<HttpClientContextHandler> getStaticContextHandlers()
```
    Get the list of static HttpClientContextHandler.
    
    Returns:
    the list of handlers
  - setStaticContextHandlers
```
public void setStaticContextHandlers(@Nullable
                            List<HttpClientContextHandler> handlers)
```
    Set the list of static HttpClientContextHandler.
    
    Parameters:
    handlers - the list of handlers , may be null
  - normalizeList
```
@Nonnull
@NonnullElements
private <T> List<T> normalizeList(@Nullable
                                                List<T> items)
```
    Normalize and copy the supplied list to remove nulls.
    
    Type Parameters:
    T - type of collection to normalize
    Parameters:
    items - the list of items to normalize
    
    Returns:
    copy of input list without nulls
  - buildClient
```
public HttpClient buildClient()
                       throws Exception
```
    Constructs an HttpClient using the settings of this builder.
    
    Returns:
    the constructed client
    
    Throws:
    
    Exception - if there is any problem building the new client instance
  - decorateApacheBuilder
```
protected void decorateApacheBuilder()
                              throws Exception
```
    Decorate the Apache builder as determined by this builder's parameters. Subclasses will likely add additional decoration.
    
    Throws:
    
    Exception - if there is a problem decorating the Apache builder
  - getApacheBuilder
```
protected HttpClientBuilder getApacheBuilder()
```
    Get the Apache HttpClientBuilder instance over which this builder will be layered. Subclasses may override to return a specialized subclass.
    
    Returns:
    the Apache HttpClientBuilder instance to use

Class HttpClientBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

socketLocalAddress

socketTimeout

socketBufferSize

connectionTimeout

connectionRequestTimeout

maxConnectionsTotal

maxConnectionsPerRoute

connectionDisregardTLSCertificate

tlsSocketFactory

connectionCloseAfterResponse

connectionStaleCheck

connectionProxyHost

userAgent

connectionProxyPort

connectionProxyUsername

connectionProxyPassword

httpFollowRedirects

httpContentCharSet

retryHandler

serviceUnavailStrategy

disableAuthCaching

disableAutomaticRetries

disableConnectionState

disableContentCompression

disableCookieManagement

disableRedirectHandling

useSystemProperties

requestInterceptorsFirst

requestInterceptorsLast

responseInterceptorsFirst

responseInterceptorsLast

staticContextHandlers

apacheBuilder

Constructor Detail

HttpClientBuilder

HttpClientBuilder

Method Detail

resetDefaults

getMaxConnectionsTotal

setMaxConnectionsTotal

getMaxConnectionsPerRoute

setMaxConnectionsPerRoute

getSocketLocalAddress

setSocketLocalAddress

setSocketLocalAddress

getSocketTimeout

setSocketTimeout

getSocketBufferSize

setSocketBufferSize

getConnectionTimeout

setConnectionTimeout

getConnectionRequestTimeout

setConnectionRequestTimeout

isConnectionDisregardTLSCertificate

setConnectionDisregardTLSCertificate

getTLSSocketFactory

setTLSSocketFactory

isConnectionCloseAfterResponse

setConnectionCloseAfterResponse

isConnectionStalecheck

setConnectionStalecheck

isConnectionStaleCheck

setConnectionStaleCheck

getConnectionProxyHost

setConnectionProxyHost

getConnectionProxyPort

setConnectionProxyPort

getConnectionProxyUsername

setConnectionProxyUsername

getConnectionProxyPassword

setConnectionProxyPassword

isHttpFollowRedirects

setHttpFollowRedirects

getHttpContentCharSet