org.jboss.resteasy.client.jaxrs

Class ResteasyClientBuilder

java.lang.Object

javax.ws.rs.client.ClientBuilder

org.jboss.resteasy.client.jaxrs.ResteasyClientBuilder

All Implemented Interfaces:

javax.ws.rs.core.Configurable<javax.ws.rs.client.ClientBuilder>

public class ResteasyClientBuilder
extends javax.ws.rs.client.ClientBuilder

Abstraction for creating Clients. Allows SSL configuration. Uses Apache Http Client under the covers. If used with other ClientHttpEngines though, all configuration options are ignored.

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResteasyClientBuilder.HostnameVerificationPolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected ExecutorService	asyncExecutor
protected boolean	cleanupExecutor
protected KeyStore	clientKeyStore
protected String	clientPrivateKeyPassword
protected int	connectionCheckoutTimeoutMs
protected int	connectionPoolSize
protected long	connectionTTL
protected TimeUnit	connectionTTLUnit
protected org.apache.http.HttpHost	defaultProxy
protected boolean	disableTrustManager
protected long	establishConnectionTimeout
protected TimeUnit	establishConnectionTimeoutUnits
protected ClientHttpEngine	httpEngine
protected int	maxPooledPerRoute
protected ResteasyClientBuilder.HostnameVerificationPolicy	policy
protected Map<String,Object>	properties
static String	PROPERTY_PROXY_HOST Client properties to enable proxy.
static String	PROPERTY_PROXY_PORT Proxy port property name (integer).
static String	PROPERTY_PROXY_SCHEME Proxy scheme property name (string).
protected ResteasyProviderFactory	providerFactory
protected int	responseBufferSize
protected ScheduledExecutorService	scheduledExecutorService
protected List<String>	sniHostNames
protected long	socketTimeout
protected TimeUnit	socketTimeoutUnits
protected SSLContext	sslContext
protected boolean	trustSelfSignedCertificates
protected KeyStore	truststore
protected HostnameVerifier	verifier

Fields inherited from class javax.ws.rs.client.ClientBuilder

JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ResteasyClientBuilder()

Method Summary

Modifier and Type	Method and Description
ResteasyClientBuilder	asyncExecutor(ExecutorService asyncExecutor) Deprecated. use executorService(ExecutorService) instead
ResteasyClientBuilder	asyncExecutor(ExecutorService asyncExecutor, boolean cleanupExecutor) Deprecated.
ResteasyClient	build()
ResteasyClient	buildOld() Deprecated.
ResteasyClientBuilder	connectionCheckoutTimeout(long timeout, TimeUnit unit) If connection pooling is enabled, how long will we wait to get a connection?
ResteasyClientBuilder	connectionPoolSize(int connectionPoolSize) Number of connections allowed to pool.
ResteasyClientBuilder	connectionTTL(long ttl, TimeUnit unit) If there is a connection pool, set the time to live in the pool.
ResteasyClientBuilder	connectTimeout(long timeout, TimeUnit unit)
protected ResteasyClient	createResteasyClient(ClientHttpEngine engine, ExecutorService executor, boolean cleanupExecutor, ScheduledExecutorService scheduledExecutorService, ClientConfiguration config)
ResteasyClientBuilder	defaultProxy(String hostname) Specify a default proxy.
ResteasyClientBuilder	defaultProxy(String hostname, int port) Specify a default proxy host and port.
ResteasyClientBuilder	defaultProxy(String hostname, int port, String scheme) Specify default proxy.
ResteasyClientBuilder	disableTrustManager() Disable trust management and hostname verification.
ResteasyClientBuilder	establishConnectionTimeout(long timeout, TimeUnit unit) Deprecated.
javax.ws.rs.client.ClientBuilder	executorService(ExecutorService executorService)
javax.ws.rs.core.Configuration	getConfiguration()
protected ResteasyProviderFactory	getProviderFactory()
ResteasyClientBuilder	hostnameVerification(ResteasyClientBuilder.HostnameVerificationPolicy policy) SSL policy used to verify hostnames
ResteasyClientBuilder	hostnameVerifier(HostnameVerifier verifier)
ResteasyClientBuilder	httpEngine(ClientHttpEngine httpEngine) Negates all ssl and connection specific configuration
boolean	isTrustSelfSignedCertificates()
ResteasyClientBuilder	keyStore(KeyStore keyStore, char[] password)
ResteasyClientBuilder	keyStore(KeyStore keyStore, String password)
ResteasyClientBuilder	maxPooledPerRoute(int maxPooledPerRoute) If connection pooling enabled, how many connections to pool per url?
protected void	prepareSocketForSni(SSLSocket socket)
ResteasyClientBuilder	property(String name, Object value)
ResteasyClientBuilder	providerFactory(ResteasyProviderFactory providerFactory) Changing the providerFactory will wipe clean any registered components or properties.
ResteasyClientBuilder	readTimeout(long timeout, TimeUnit unit)
ResteasyClientBuilder	register(Class<?> componentClass)
ResteasyClientBuilder	register(Class<?> componentClass, Class<?>... contracts)
ResteasyClientBuilder	register(Class<?> componentClass, int priority)
ResteasyClientBuilder	register(Class<?> componentClass, Map<Class<?>,Integer> contracts)
ResteasyClientBuilder	register(Object component)
ResteasyClientBuilder	register(Object component, Class<?>... contracts)
ResteasyClientBuilder	register(Object component, int priority)
ResteasyClientBuilder	register(Object component, Map<Class<?>,Integer> contracts)
ResteasyClientBuilder	responseBufferSize(int size) Response stream is wrapped in a BufferedInputStream.
javax.ws.rs.client.ClientBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
void	setIsTrustSelfSignedCertificates(boolean b) When the user is not using a TrustManager (see disableTrustManager) and does not define an SSLContext object but they want all defined trustStores to use the TrustSelfSignedCertificates trust strategy set this value to true.
ResteasyClientBuilder	sniHostNames(String... sniHostNames) Adds a TLS/SSL SNI Host Name for authentication.
ResteasyClientBuilder	socketTimeout(long timeout, TimeUnit unit) Deprecated.
ResteasyClientBuilder	sslContext(SSLContext sslContext)
ResteasyClientBuilder	trustStore(KeyStore truststore)
ResteasyClientBuilder	useAsyncHttpEngine()
ResteasyClientBuilder	withConfig(javax.ws.rs.core.Configuration config)

Methods inherited from class javax.ws.rs.client.ClientBuilder

newBuilder, newClient, newClient

Methods inherited from class java.lang.Object

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

Field Detail

truststore

protected KeyStore truststore

clientKeyStore

protected KeyStore clientKeyStore

clientPrivateKeyPassword

protected String clientPrivateKeyPassword

disableTrustManager

protected boolean disableTrustManager

policy

protected ResteasyClientBuilder.HostnameVerificationPolicy policy

providerFactory

protected ResteasyProviderFactory providerFactory

asyncExecutor

protected ExecutorService asyncExecutor

scheduledExecutorService

protected ScheduledExecutorService scheduledExecutorService

cleanupExecutor

protected boolean cleanupExecutor

sslContext

protected SSLContext sslContext

properties

protected Map<String,Object> properties

httpEngine

protected ClientHttpEngine httpEngine

connectionPoolSize

protected int connectionPoolSize

maxPooledPerRoute

protected int maxPooledPerRoute

connectionTTL

protected long connectionTTL

connectionTTLUnit

protected TimeUnit connectionTTLUnit

socketTimeout

protected long socketTimeout

socketTimeoutUnits

protected TimeUnit socketTimeoutUnits

establishConnectionTimeout

protected long establishConnectionTimeout

establishConnectionTimeoutUnits

protected TimeUnit establishConnectionTimeoutUnits

connectionCheckoutTimeoutMs

protected int connectionCheckoutTimeoutMs

verifier

protected HostnameVerifier verifier

defaultProxy

protected org.apache.http.HttpHost defaultProxy

responseBufferSize

protected int responseBufferSize

sniHostNames

protected List<String> sniHostNames

trustSelfSignedCertificates

protected boolean trustSelfSignedCertificates

PROPERTY_PROXY_HOST

public static final String PROPERTY_PROXY_HOST

Client properties to enable proxy. Proxy host property name (string).

See Also:

Constant Field Values

PROPERTY_PROXY_PORT

public static final String PROPERTY_PROXY_PORT

Proxy port property name (integer).

See Also:

Constant Field Values

PROPERTY_PROXY_SCHEME

public static final String PROPERTY_PROXY_SCHEME

Proxy scheme property name (string).

See Also:

Constant Field Values

Constructor Detail

ResteasyClientBuilder

public ResteasyClientBuilder()

Method Detail

providerFactory

public ResteasyClientBuilder providerFactory(ResteasyProviderFactory providerFactory)

Changing the providerFactory will wipe clean any registered components or properties.

Parameters:

providerFactory - provider factory

Returns:

an updated client builder instance

asyncExecutor

@Deprecated
public ResteasyClientBuilder asyncExecutor(ExecutorService asyncExecutor)

Deprecated. use executorService(ExecutorService) instead

Executor to use to run AsyncInvoker invocations.

Parameters:

asyncExecutor - executor service

Returns:

an updated client builder instance

asyncExecutor

@Deprecated
public ResteasyClientBuilder asyncExecutor(ExecutorService asyncExecutor,
                                                       boolean cleanupExecutor)

Deprecated.

Executor to use to run AsyncInvoker invocations.

Parameters:

asyncExecutor - executor service

cleanupExecutor - true if the Client should close the executor when it is closed

Returns:

an updated client builder instance

connectionTTL

public ResteasyClientBuilder connectionTTL(long ttl,
                                           TimeUnit unit)

If there is a connection pool, set the time to live in the pool.

Parameters:

ttl - time to live

unit - the time unit of the ttl argument

Returns:

an updated client builder instance

readTimeout

public ResteasyClientBuilder readTimeout(long timeout,
                                         TimeUnit unit)

Specified by:

readTimeout in class javax.ws.rs.client.ClientBuilder

socketTimeout

@Deprecated
public ResteasyClientBuilder socketTimeout(long timeout,
                                                       TimeUnit unit)

Deprecated.

The timeout for waiting for data. A timeout value of zero is interpreted as an infinite timeout

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

an updated client builder instance

connectTimeout

public ResteasyClientBuilder connectTimeout(long timeout,
                                            TimeUnit unit)

Specified by:

connectTimeout in class javax.ws.rs.client.ClientBuilder

establishConnectionTimeout

@Deprecated
public ResteasyClientBuilder establishConnectionTimeout(long timeout,
                                                                    TimeUnit unit)

Deprecated.

When trying to make an initial socket connection, what is the timeout?

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

an updated client builder instance

maxPooledPerRoute

public ResteasyClientBuilder maxPooledPerRoute(int maxPooledPerRoute)

If connection pooling enabled, how many connections to pool per url?

Parameters:

maxPooledPerRoute - max pool size per url

Returns:

an updated client builder instance

connectionCheckoutTimeout

public ResteasyClientBuilder connectionCheckoutTimeout(long timeout,
                                                       TimeUnit unit)

If connection pooling is enabled, how long will we wait to get a connection?

Parameters:

timeout - the timeout

unit - the units the timeout is in

Returns:

an updated client builder instance

connectionPoolSize

public ResteasyClientBuilder connectionPoolSize(int connectionPoolSize)

Number of connections allowed to pool.

Parameters:

connectionPoolSize - connection pool size

Returns:

an updated client builder instance

responseBufferSize

public ResteasyClientBuilder responseBufferSize(int size)

Response stream is wrapped in a BufferedInputStream. Default is 8192. Value of 0 will not wrap it. Value of -1 will use a SelfExpandingBufferedInputStream.

Parameters:

size - response buffer size

Returns:

an updated client builder instance

disableTrustManager

public ResteasyClientBuilder disableTrustManager()

Disable trust management and hostname verification. NOTE this is a security hole, so only set this option if you cannot or do not want to verify the identity of the host you are communicating with.

Returns:

an updated client builder instance

setIsTrustSelfSignedCertificates

public void setIsTrustSelfSignedCertificates(boolean b)

When the user is not using a TrustManager (see disableTrustManager) and does not define an SSLContext object but they want all defined trustStores to use the TrustSelfSignedCertificates trust strategy set this value to true.

Parameters:

b - A value of true assigns trust strategy TrustSelfSignedCertificates to the trustStores. A value of false assigns a null to the trust strategy. The default value is true in order to maintain backward compatibility.

isTrustSelfSignedCertificates

public boolean isTrustSelfSignedCertificates()

hostnameVerification

public ResteasyClientBuilder hostnameVerification(ResteasyClientBuilder.HostnameVerificationPolicy policy)

SSL policy used to verify hostnames

Parameters:

policy - SSL policy

Returns:

an updated client builder instance

httpEngine

public ResteasyClientBuilder httpEngine(ClientHttpEngine httpEngine)

Negates all ssl and connection specific configuration

Parameters:

httpEngine - http engine

Returns:

an updated client builder instance

useAsyncHttpEngine

public ResteasyClientBuilder useAsyncHttpEngine()

sslContext

public ResteasyClientBuilder sslContext(SSLContext sslContext)

Specified by:

sslContext in class javax.ws.rs.client.ClientBuilder

trustStore

public ResteasyClientBuilder trustStore(KeyStore truststore)

Specified by:

trustStore in class javax.ws.rs.client.ClientBuilder

keyStore

public ResteasyClientBuilder keyStore(KeyStore keyStore,
                                      String password)

Overrides:

keyStore in class javax.ws.rs.client.ClientBuilder

keyStore

public ResteasyClientBuilder keyStore(KeyStore keyStore,
                                      char[] password)

Specified by:

keyStore in class javax.ws.rs.client.ClientBuilder

property

public ResteasyClientBuilder property(String name,
                                      Object value)

sniHostNames

public ResteasyClientBuilder sniHostNames(String... sniHostNames)

Adds a TLS/SSL SNI Host Name for authentication.

Parameters:

sniHostNames - host names

Returns:

an updated client builder instance

defaultProxy

public ResteasyClientBuilder defaultProxy(String hostname)

Specify a default proxy. Default port and schema will be used.

Parameters:

hostname - host name

Returns:

an updated client builder instance

defaultProxy

public ResteasyClientBuilder defaultProxy(String hostname,
                                          int port)

Specify a default proxy host and port. Default schema will be used.

Parameters:

hostname - host name

port - port

Returns:

an updated client builder instance

defaultProxy

public ResteasyClientBuilder defaultProxy(String hostname,
                                          int port,
                                          String scheme)

Specify default proxy.

Parameters:

hostname - host name

port - port

scheme - scheme

Returns:

an updated client builder instance

getProviderFactory

protected ResteasyProviderFactory getProviderFactory()

buildOld

@Deprecated
public ResteasyClient buildOld()

Deprecated.

build

public ResteasyClient build()

Specified by:

build in class javax.ws.rs.client.ClientBuilder

createResteasyClient

protected ResteasyClient createResteasyClient(ClientHttpEngine engine,
                                              ExecutorService executor,
                                              boolean cleanupExecutor,
                                              ScheduledExecutorService scheduledExecutorService,
                                              ClientConfiguration config)

prepareSocketForSni

protected void prepareSocketForSni(SSLSocket socket)

hostnameVerifier

public ResteasyClientBuilder hostnameVerifier(HostnameVerifier verifier)

Specified by:

hostnameVerifier in class javax.ws.rs.client.ClientBuilder

getConfiguration

public javax.ws.rs.core.Configuration getConfiguration()

register

public ResteasyClientBuilder register(Class<?> componentClass)

register

public ResteasyClientBuilder register(Class<?> componentClass,
                                      int priority)

register

public ResteasyClientBuilder register(Class<?> componentClass,
                                      Class<?>... contracts)

register

public ResteasyClientBuilder register(Class<?> componentClass,
                                      Map<Class<?>,Integer> contracts)

register

public ResteasyClientBuilder register(Object component)

register

public ResteasyClientBuilder register(Object component,
                                      int priority)

register

public ResteasyClientBuilder register(Object component,
                                      Class<?>... contracts)

register

public ResteasyClientBuilder register(Object component,
                                      Map<Class<?>,Integer> contracts)

withConfig

public ResteasyClientBuilder withConfig(javax.ws.rs.core.Configuration config)

Specified by:

withConfig in class javax.ws.rs.client.ClientBuilder

executorService

public javax.ws.rs.client.ClientBuilder executorService(ExecutorService executorService)

Specified by:

executorService in class javax.ws.rs.client.ClientBuilder

scheduledExecutorService

public javax.ws.rs.client.ClientBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)

Specified by:

scheduledExecutorService in class javax.ws.rs.client.ClientBuilder