org.glassfish.jersey.client
Class ClientConfig

java.lang.Object
  org.glassfish.jersey.client.ClientConfig

All Implemented Interfaces:

Configuration, Configurable, Config

public class ClientConfig
extends java.lang.Object
implements Configuration, Config, Configurable

Jersey implementation of JAX-RS client configuration contract.

Author:

Marek Potociar (marek.potociar at oracle.com), Martin Matula (martin.matula at oracle.com)

Constructor Summary

ClientConfig()
Construct a new Jersey configuration instance with the default features and property values.

ClientConfig(java.lang.Class<?>... providerClasses)
Construct a new Jersey configuration instance and register the provided list of provider classes.

ClientConfig(java.lang.Object... providers)
Construct a new Jersey configuration instance and register the provided list of provider instances.

Method Summary

ClientConfig	binders(Binder... binders) Register custom HK2 binders.
ClientConfig	connector(Connector connector) Set Jersey client transport connector.
boolean	equals(java.lang.Object obj)
JerseyClient	getClient() Get the parent Jersey client this configuration is bound to.
Connector	getConnector() Get the client transport connector.
java.util.Set<Feature>	getFeatures()
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
java.lang.Object	getProperty(java.lang.String name)
java.util.Set<java.lang.Class<?>>	getProviderClasses()
java.util.Set<java.lang.Object>	getProviderInstances()
int	hashCode()
boolean	isEnabled(java.lang.Class<? extends Feature> feature) Check if the given feature is enabled or not.
boolean	isProperty(java.lang.String name)
ClientConfig	register(java.lang.Class<?> providerClass)
ClientConfig	register(java.lang.Class<?> providerClass, int bindingPriority)
<T> ClientConfig	register(java.lang.Class<T> providerClass, java.lang.Class<? super T>... contracts)
<T> ClientConfig	register(java.lang.Class<T> providerClass, int bindingPriority, java.lang.Class<? super T>... contracts)
ClientConfig	register(java.lang.Object provider)
<T> ClientConfig	register(java.lang.Object provider, java.lang.Class<? super T>... contracts)
ClientConfig	register(java.lang.Object provider, int bindingPriority)
<T> ClientConfig	register(java.lang.Object provider, int bindingPriority, java.lang.Class<? super T>... contracts)
ClientConfig	setProperties(java.util.Map<java.lang.String,?> properties)
ClientConfig	setProperty(java.lang.String name, java.lang.Object value)
ClientConfig	updateFrom(Configurable configuration)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientConfig

public ClientConfig()

Construct a new Jersey configuration instance with the default features and property values.

ClientConfig

public ClientConfig(java.lang.Class<?>... providerClasses)

Construct a new Jersey configuration instance and register the provided list of provider classes.

Parameters:

providerClasses - provider classes to be registered with this client configuration.

ClientConfig

public ClientConfig(java.lang.Object... providers)

Construct a new Jersey configuration instance and register the provided list of provider instances.

Parameters:

providers - provider instances to be registered with this client configuration.

Method Detail

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Specified by:

getProperties in interface Configurable

Specified by:

getProperties in interface Config

getProperty

public java.lang.Object getProperty(java.lang.String name)

Specified by:

getProperty in interface Configurable

Specified by:

getProperty in interface Config

isProperty

public boolean isProperty(java.lang.String name)

Specified by:

isProperty in interface Config

getFeatures

public java.util.Set<Feature> getFeatures()

Specified by:

getFeatures in interface Configurable

isEnabled

public boolean isEnabled(java.lang.Class<? extends Feature> feature)

Check if the given feature is enabled or not.

Parameters:

feature - tested feature.

Returns:

true in case

getProviderClasses

public java.util.Set<java.lang.Class<?>> getProviderClasses()

Specified by:

getProviderClasses in interface Configurable

getProviderInstances

public java.util.Set<java.lang.Object> getProviderInstances()

Specified by:

getProviderInstances in interface Configurable

updateFrom

public ClientConfig updateFrom(Configurable configuration)

Specified by:

updateFrom in interface Configuration

register

public ClientConfig register(java.lang.Class<?> providerClass)

Specified by:

register in interface Configuration

Specified by:

register in interface Configurable

register

public ClientConfig register(java.lang.Object provider)

Specified by:

register in interface Configuration

Specified by:

register in interface Configurable

register

public ClientConfig register(java.lang.Class<?> providerClass,
                             int bindingPriority)

Specified by:

register in interface Configuration

Specified by:

register in interface Configurable

register

public <T> ClientConfig register(java.lang.Class<T> providerClass,
                                 java.lang.Class<? super T>... contracts)

Specified by:

register in interface Configuration

Specified by:

register in interface Configurable

register

public <T> ClientConfig register(java.lang.Class<T> providerClass,
                                 int bindingPriority,
                                 java.lang.Class<? super T>... contracts)

Specified by:

register in interface Configuration

Specified by:

register in interface Configurable

register

public ClientConfig register(java.lang.Object provider,
                             int bindingPriority)

Specified by:

register in interface Configuration

Specified by:

register in interface Configurable

register

public <T> ClientConfig register(java.lang.Object provider,
                                 java.lang.Class<? super T>... contracts)

Specified by:

register in interface Configuration

Specified by:

register in interface Configurable

register

public <T> ClientConfig register(java.lang.Object provider,
                                 int bindingPriority,
                                 java.lang.Class<? super T>... contracts)

Specified by:

register in interface Configuration

Specified by:

register in interface Configurable

setProperties

public ClientConfig setProperties(java.util.Map<java.lang.String,?> properties)

Specified by:

setProperties in interface Configuration

Specified by:

setProperties in interface Configurable

setProperty

public ClientConfig setProperty(java.lang.String name,
                                java.lang.Object value)

Specified by:

setProperty in interface Configuration

Specified by:

setProperty in interface Configurable

connector

public ClientConfig connector(Connector connector)

Set Jersey client transport connector.

Parameters:

connector - client transport connector.

Returns:

this client config instance.

binders

public ClientConfig binders(Binder... binders)

Register custom HK2 binders.

Parameters:

binders - custom HK2 binders to be registered with the Jersey client.

Returns:

this client config instance.

getConnector

public Connector getConnector()

Get the client transport connector. May return null if no connector has been set.

Returns:

client transport connector or {code null} if not set.

getClient

public JerseyClient getClient()

Get the parent Jersey client this configuration is bound to. May return null if no parent client has been bound.

Returns:

bound parent Jersey client or null if not bound.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object