io.dropwizard.client

Class JerseyClientBuilder

java.lang.Object

io.dropwizard.client.JerseyClientBuilder

public class JerseyClientBuilder
extends Object

A convenience class for building Client instances.

Among other things,

• Backed by Apache HttpClient
• Disables stale connection checks
• Disables Nagle's algorithm
• Disables cookie management by default
• Compress requests and decompress responses using GZIP
• Supports parsing and generating JSON data using Jackson

See Also:

HttpClientBuilder

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.client.Client	build(String name) Builds the Client instance.
JerseyClientBuilder	name(String environmentName) Use the given environment name.
void	setApacheHttpClientBuilder(HttpClientBuilder apacheHttpClientBuilder)
JerseyClientBuilder	using(org.glassfish.jersey.client.spi.ConnectorProvider connectorProvider) Use the given ConnectorProvider instance.
JerseyClientBuilder	using(org.apache.http.client.CredentialsProvider credentialsProvider) Use the given CredentialsProvider instance.
JerseyClientBuilder	using(org.apache.http.conn.DnsResolver resolver) Use the given DnsResolver instance.
JerseyClientBuilder	using(Environment environment) Uses the given Environment.
JerseyClientBuilder	using(ExecutorService executorService, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Uses the given ExecutorService and ObjectMapper.
JerseyClientBuilder	using(com.codahale.metrics.httpclient.HttpClientMetricNameStrategy metricNameStrategy) Use the given HttpClientMetricNameStrategy instance.
JerseyClientBuilder	using(org.apache.http.client.HttpRequestRetryHandler httpRequestRetryHandler) Uses the HttpRequestRetryHandler for handling request retries.
JerseyClientBuilder	using(org.apache.http.conn.routing.HttpRoutePlanner routePlanner) Use the given HttpRoutePlanner instance.
JerseyClientBuilder	using(JerseyClientConfiguration configuration) Uses the given JerseyClientConfiguration.
JerseyClientBuilder	using(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry) Use the given Registry instance of connection socket factories.
JerseyClientBuilder	using(javax.validation.Validator validator) Use the given Validator instance.
JerseyClientBuilder	withProperty(String propertyName, Object propertyValue) Sets the state of the given Jersey property.
JerseyClientBuilder	withProvider(Class<?> klass) Adds the given class as a Jersey provider.
JerseyClientBuilder	withProvider(Object provider) Adds the given object as a Jersey provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

JerseyClientBuilder

public JerseyClientBuilder(Environment environment)

JerseyClientBuilder

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

Method Detail

setApacheHttpClientBuilder

public void setApacheHttpClientBuilder(HttpClientBuilder apacheHttpClientBuilder)

withProvider

public JerseyClientBuilder withProvider(Object provider)

Adds the given object as a Jersey provider.

Parameters:

provider - a Jersey provider

Returns:

this

withProvider

public JerseyClientBuilder withProvider(Class<?> klass)

Adds the given class as a Jersey provider.

N.B.: This class must either have a no-args constructor or use Jersey's built-in dependency injection.

Parameters:

klass - a Jersey provider class

Returns:

this

withProperty

public JerseyClientBuilder withProperty(String propertyName,
                               Object propertyValue)

Sets the state of the given Jersey property.

WARNING: The default connector ignores Jersey properties. Use JerseyClientConfiguration instead.

Parameters:

propertyName - the name of the Jersey property

propertyValue - the state of the Jersey property

Returns:

this

using

public JerseyClientBuilder using(JerseyClientConfiguration configuration)

Uses the given JerseyClientConfiguration.

Parameters:

configuration - a configuration object

Returns:

this

using

public JerseyClientBuilder using(Environment environment)

Uses the given Environment.

Parameters:

environment - a Dropwizard Environment

Returns:

this

See Also:

using(java.util.concurrent.ExecutorService, com.fasterxml.jackson.databind.ObjectMapper)

using

public JerseyClientBuilder using(javax.validation.Validator validator)

Use the given Validator instance.

Parameters:

validator - a Validator instance

Returns:

this

using

public JerseyClientBuilder using(ExecutorService executorService,
                        com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Uses the given ExecutorService and ObjectMapper.

Parameters:

executorService - a thread pool

objectMapper - an object mapper

Returns:

this

See Also:

using(io.dropwizard.setup.Environment)

using

public JerseyClientBuilder using(org.glassfish.jersey.client.spi.ConnectorProvider connectorProvider)

Use the given ConnectorProvider instance.

WARNING: Use it with a caution. Most of features will not work in a custom connection provider.

Parameters:

connectorProvider - a ConnectorProvider instance

Returns:

this

using

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

Uses the HttpRequestRetryHandler for handling request retries.

Parameters:

httpRequestRetryHandler - a HttpRequestRetryHandler

Returns:

this

using

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

Use the given DnsResolver instance.

Parameters:

resolver - a DnsResolver instance

Returns:

this

using

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

Use the given Registry instance of connection socket factories.

Parameters:

registry - a Registry instance of connection socket factories

Returns:

this

using

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

Use the given HttpClientMetricNameStrategy instance.

Parameters:

metricNameStrategy - a HttpClientMetricNameStrategy instance

Returns:

this

name

public JerseyClientBuilder 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 JerseyClientBuilder using(org.apache.http.conn.routing.HttpRoutePlanner routePlanner)

Use the given HttpRoutePlanner instance.

Parameters:

routePlanner - a HttpRoutePlanner instance

Returns:

this

using

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

Use the given CredentialsProvider instance.

Parameters:

credentialsProvider - a CredentialsProvider instance

Returns:

this

build

public javax.ws.rs.client.Client build(String name)

Builds the Client instance.

Returns:

a fully-configured Client