io.dropwizard.client

Class HttpClientBuilder

java.lang.Object

io.dropwizard.client.HttpClientBuilder

public class HttpClientBuilder
extends Object

A convenience class for building HttpClient instances.

Among other things,

• Disables stale connection checks by default
• Disables Nagle's algorithm
• Disables cookie management by default

Constructor Summary

Constructors

Constructor and Description
HttpClientBuilder(Environment environment)
HttpClientBuilder(com.codahale.metrics.MetricRegistry metricRegistry)

Method Summary

Modifier and Type	Method and Description
org.apache.http.impl.client.CloseableHttpClient	build(String name) Builds the HttpClient.
protected com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager	configureConnectionManager(com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager connectionManager)
protected org.apache.http.auth.Credentials	configureCredentials(AuthConfiguration auth) determine the Credentials implementation to use
protected org.apache.http.impl.client.HttpClientBuilder	createBuilder() Creates an Apache HttpClientBuilder.
protected ConfiguredCloseableHttpClient	createClient(org.apache.http.impl.client.HttpClientBuilder builder, com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager manager, String name) Map the parameters in HttpClientConfiguration to configuration on a HttpClientBuilder instance
protected com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager	createConnectionManager(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry, String name) Create a InstrumentedHttpClientConnectionManager based on the HttpClientConfiguration.
protected org.apache.http.protocol.HttpRequestExecutor	createRequestExecutor(String name) Creates a HttpRequestExecutor.
protected String	createUserAgent(String name) Create a user agent string using the configured user agent if defined, otherwise using a combination of the environment name and this client name
protected org.apache.http.impl.client.HttpClientBuilder	customizeBuilder(org.apache.http.impl.client.HttpClientBuilder builder) Configures an Apache HttpClientBuilder.
HttpClientBuilder	disableContentCompression(boolean disableContentCompression) Disable support of decompression of responses
HttpClientBuilder	name(String environmentName) Use the given environment name.
HttpClientBuilder	using(org.apache.http.client.CredentialsProvider credentialsProvider) Use the given CredentialsProvider instance.
HttpClientBuilder	using(org.apache.http.conn.DnsResolver resolver) Use the given DnsResolver instance.
HttpClientBuilder	using(HostnameVerifier verifier) Use the given HostnameVerifier instance.
HttpClientBuilder	using(HttpClientConfiguration configuration) Use the given HttpClientConfiguration instance.
HttpClientBuilder	using(com.codahale.metrics.httpclient.HttpClientMetricNameStrategy metricNameStrategy) Use the given HttpClientMetricNameStrategy instance.
HttpClientBuilder	using(org.apache.http.protocol.HttpProcessor httpProcessor) Deprecated.
HttpClientBuilder	using(org.apache.http.client.HttpRequestRetryHandler httpRequestRetryHandler) Uses the HttpRequestRetryHandler for handling request retries.
HttpClientBuilder	using(org.apache.http.conn.routing.HttpRoutePlanner routePlanner) Use the given HttpRoutePlanner instance.
HttpClientBuilder	using(List<? extends org.apache.http.Header> defaultHeaders) Use the given default headers for each HTTP request
HttpClientBuilder	using(org.apache.http.client.RedirectStrategy redirectStrategy) Use the given RedirectStrategy instance.
HttpClientBuilder	using(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry) Use the given Registry instance.
HttpClientBuilder	using(org.apache.http.client.ServiceUnavailableRetryStrategy serviceUnavailableRetryStrategy) Deprecated. will be combined with using(HttpRequestRetryHandler) in using(HttpRequestRetryStrategy)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientBuilder

public HttpClientBuilder(com.codahale.metrics.MetricRegistry metricRegistry)

HttpClientBuilder

public HttpClientBuilder(Environment environment)

Method Detail

name

public HttpClientBuilder name(String environmentName)

Use the given environment name. This is used in the user agent.

Parameters:

environmentName - an environment name to use in the user agent.

Returns:

this

using

public HttpClientBuilder using(HttpClientConfiguration configuration)

Use the given HttpClientConfiguration instance.

Parameters:

configuration - a HttpClientConfiguration instance

Returns:

this

using

public HttpClientBuilder using(org.apache.http.conn.DnsResolver resolver)

Use the given DnsResolver instance.

Parameters:

resolver - a DnsResolver instance

Returns:

this

using

public HttpClientBuilder using(HostnameVerifier verifier)

Use the given HostnameVerifier instance.

Parameters:

verifier - a HostnameVerifier instance

Returns:

this

using

public HttpClientBuilder using(org.apache.http.client.HttpRequestRetryHandler httpRequestRetryHandler)

Uses the HttpRequestRetryHandler for handling request retries.

Parameters:

httpRequestRetryHandler - an httpRequestRetryHandler

Returns:

this

using

public HttpClientBuilder using(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry)

Use the given Registry instance.

Parameters:

registry -

Returns:

this

using

public HttpClientBuilder using(org.apache.http.conn.routing.HttpRoutePlanner routePlanner)

Use the given HttpRoutePlanner instance.

Parameters:

routePlanner - a HttpRoutePlanner instance

Returns:

this

using

public HttpClientBuilder using(org.apache.http.client.CredentialsProvider credentialsProvider)

Use the given CredentialsProvider instance.

Parameters:

credentialsProvider - a CredentialsProvider instance

Returns:

this

using

public HttpClientBuilder using(com.codahale.metrics.httpclient.HttpClientMetricNameStrategy metricNameStrategy)

Use the given HttpClientMetricNameStrategy instance.

Parameters:

metricNameStrategy - a HttpClientMetricNameStrategy instance

Returns:

this

using

public HttpClientBuilder using(org.apache.http.client.RedirectStrategy redirectStrategy)

Use the given RedirectStrategy instance.

Parameters:

redirectStrategy - a RedirectStrategy instance

Returns:

this

using

public HttpClientBuilder using(List<? extends org.apache.http.Header> defaultHeaders)

Use the given default headers for each HTTP request

Parameters:

defaultHeaders - HTTP headers

Returns:

this

using

@Deprecated
public HttpClientBuilder using(org.apache.http.protocol.HttpProcessor httpProcessor)

Deprecated.

Use the given HttpProcessor instance

Parameters:

httpProcessor - a HttpProcessor instance

Returns:

this

using

@Deprecated
public HttpClientBuilder using(org.apache.http.client.ServiceUnavailableRetryStrategy serviceUnavailableRetryStrategy)

Deprecated. will be combined with using(HttpRequestRetryHandler) in using(HttpRequestRetryStrategy)

Use the given ServiceUnavailableRetryStrategy instance

Parameters:

serviceUnavailableRetryStrategy - a ServiceUnavailableRetryStrategy instance

Returns:

this

disableContentCompression

public HttpClientBuilder disableContentCompression(boolean disableContentCompression)

Disable support of decompression of responses

Parameters:

disableContentCompression - true, if disabled

Returns:

this

build

public org.apache.http.impl.client.CloseableHttpClient build(String name)

Builds the HttpClient.

Parameters:

name -

Returns:

an CloseableHttpClient

createRequestExecutor

protected org.apache.http.protocol.HttpRequestExecutor createRequestExecutor(String name)

Creates a HttpRequestExecutor. Intended for use by subclasses to provide a customized request executor. The default implementation is an InstrumentedHttpRequestExecutor

Parameters:

name -

Returns:

a HttpRequestExecutor

Since:

2.0

createBuilder

protected org.apache.http.impl.client.HttpClientBuilder createBuilder()

Creates an Apache HttpClientBuilder. Intended for use by subclasses to create builder instance from subclass of HttpClientBuilder

Returns:

an HttpClientBuilder

Since:

2.0

customizeBuilder

protected org.apache.http.impl.client.HttpClientBuilder customizeBuilder(org.apache.http.impl.client.HttpClientBuilder builder)

Configures an Apache HttpClientBuilder. Intended for use by subclasses to inject HttpClientBuilder configuration. The default implementation is an identity function.

createClient

protected ConfiguredCloseableHttpClient createClient(org.apache.http.impl.client.HttpClientBuilder builder,
                                                     com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager manager,
                                                     String name)

Map the parameters in HttpClientConfiguration to configuration on a HttpClientBuilder instance

Parameters:

builder -

manager -

name -

Returns:

the configured CloseableHttpClient

createUserAgent

protected String createUserAgent(String name)

Create a user agent string using the configured user agent if defined, otherwise using a combination of the environment name and this client name

Parameters:

name - the name of this client

Returns:

the user agent string to be used by this client

createConnectionManager

protected com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager createConnectionManager(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry,
                                                                                                          String name)

Create a InstrumentedHttpClientConnectionManager based on the HttpClientConfiguration. It sets the maximum connections per route and the maximum total connections that the connection manager can create

Parameters:

registry -

name -

Returns:

a InstrumentedHttpClientConnectionManger instance

configureConnectionManager

protected com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager configureConnectionManager(com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager connectionManager)

configureCredentials

protected org.apache.http.auth.Credentials configureCredentials(AuthConfiguration auth)

determine the Credentials implementation to use

Parameters:

auth -

Returns:

a Credentials instance, either {UsernamePasswordCredentials or NTCredentials}