org.glassfish.jersey.client
Class ClientConfig

java.lang.Object
  extended by org.glassfish.jersey.client.ClientConfig
All Implemented Interfaces:
Configurable<ClientConfig>, Configuration

public class ClientConfig
extends Object
implements Configurable<ClientConfig>, Configuration

Jersey externalized implementation of client-side JAX-RS configurable 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(Class<?>... providerClasses)
          Construct a new Jersey configuration instance and register the provided list of provider classes.
ClientConfig(Object... providers)
          Construct a new Jersey configuration instance and register the provided list of provider instances.
 
Method Summary
 ClientConfig connector(Connector connector)
          Set Jersey client transport connector.
 boolean equals(Object obj)
           
 Set<Class<?>> getClasses()
          Get the immutable set of registered JAX-RS component (such as provider or feature) classes to be instantiated, injected and utilized in the scope of the configurable instance.
 JerseyClient getClient()
          Get the parent Jersey client this configuration is bound to.
 ClientConfig getConfiguration()
          Get a live view of an internal configuration state of this configurable instance.
 Connector getConnector()
          Get the client transport connector.
 Map<Class<?>,Integer> getContracts(Class<?> componentClass)
          Get the extension contract registration information for a component of a given class.
 Set<Object> getInstances()
          Get the immutable set of registered JAX-RS component (such as provider or feature) instances to be utilized by the configurable instance.
 Map<String,Object> getProperties()
          Get the immutable bag of configuration properties.
 Object getProperty(String name)
          Get the value for the property with a given name.
 Collection<String> getPropertyNames()
          Returns an immutable collection containing the property names available within the context of the current configuration instance.
 RuntimeType getRuntimeType()
          Get the runtime type of this configuration context.
 int hashCode()
           
 boolean isEnabled(Class<? extends Feature> featureClass)
          Check if a feature instance of featureClass class has been previously enabled in the runtime configuration context.
 boolean isEnabled(Feature feature)
          Check if a particular feature instance has been previously enabled in the runtime configuration context.
 boolean isRegistered(Class<?> componentClass)
          Check if a JAX-RS component of the supplied componentClass class has been previously registered in the runtime configuration context.
 boolean isRegistered(Object component)
          Check if a particular JAX-RS component instance (such as providers or features) has been previously registered in the runtime configuration context.
 ClientConfig loadFrom(Configuration config)
          Load the internal configuration state from an externally provided configuration state.
 ClientConfig property(String name, Object value)
          Set the new configuration property, if already set, the existing value of the property will be updated.
 ClientConfig register(Class<?> providerClass)
          Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
 ClientConfig register(Class<?> providerClass, Class<?>... contracts)
          Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
 ClientConfig register(Class<?> providerClass, int bindingPriority)
          Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
 ClientConfig register(Class<?> providerClass, Map<Class<?>,Integer> contracts)
          Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
 ClientConfig register(Object provider)
          Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
 ClientConfig register(Object provider, Class<?>... contracts)
          Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
 ClientConfig register(Object provider, int bindingPriority)
          Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
 ClientConfig register(Object provider, Map<Class<?>,Integer> contracts)
          Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
 
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(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(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

loadFrom

public ClientConfig loadFrom(Configuration config)
Load the internal configuration state from an externally provided configuration state. Calling this method effectively replaces existing configuration state of the instance with the state represented by the externally provided configuration.

Parameters:
config - external configuration state to replace the configuration of this configurable instance.
Returns:
the updated client configuration instance.

register

public ClientConfig register(Class<?> providerClass)
Description copied from interface: Configurable
Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context. Implementations SHOULD warn about and ignore registrations that do not conform to the requirements of supported JAX-RS component types in the given configurable context. Any subsequent registration attempts for a component type, for which a class or instance-based registration already exists in the system MUST be rejected by the JAX-RS implementation and a warning SHOULD be raised to inform the user about the rejected registration. The registered JAX-RS component class is registered as a contract provider of all the recognized JAX-RS or implementation-specific extension contracts including meta-provider contracts, such as Feature or DynamicFeature.

As opposed to component instances registered via Configurable.register(Object) method, the lifecycle of components registered using this class-based register(...) method is fully managed by the JAX-RS implementation or any underlying IoC container supported by the implementation.

Specified by:
register in interface Configurable<ClientConfig>
Parameters:
providerClass - JAX-RS component class to be configured in the scope of this configurable context.
Returns:
the updated configurable context.

register

public ClientConfig register(Object provider)
Description copied from interface: Configurable
Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context. Implementations SHOULD warn about and ignore registrations that do not conform to the requirements of supported JAX-RS component types in the given configurable context. Any subsequent registration attempts for a component type, for which a class or instance-based registration already exists in the system MUST be rejected by the JAX-RS implementation and a warning SHOULD be raised to inform the user about the rejected registration. The registered JAX-RS component is registered as a contract provider of all the recognized JAX-RS or implementation-specific extension contracts including meta-provider contracts, such as Feature or DynamicFeature.

As opposed to components registered via Configurable.register(Class) method, the lifecycle of providers registered using this instance-based register(...) is not managed by JAX-RS runtime. The same registered component instance is used during the whole lifespan of the configurable context. Fields and properties of all registered JAX-RS component instances are injected with their declared dependencies (see Context) by the JAX-RS runtime prior to use.

Specified by:
register in interface Configurable<ClientConfig>
Parameters:
provider - JAX-RS component instance to be configured in the scope of this configurable context.
Returns:
the updated configurable context.

register

public ClientConfig register(Class<?> providerClass,
                             int bindingPriority)
Description copied from interface: Configurable
Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides the same functionality as Configurable.register(Class) except that any priority specified on the registered JAX-RS component class via javax.annotation.Priority annotation is overridden with the supplied priority value.

Note that in case the priority is not applicable to a particular provider contract implemented by the class of the registered component, the supplied priority value will be ignored for that contract.

Specified by:
register in interface Configurable<ClientConfig>
Parameters:
providerClass - JAX-RS component class to be configured in the scope of this configurable context.
bindingPriority - the overriding priority for the registered component and all the provider contracts the component implements.
Returns:
the updated configurable context.

register

public ClientConfig register(Class<?> providerClass,
                             Class<?>... contracts)
Description copied from interface: Configurable
Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides the same functionality as Configurable.register(Class) except the JAX-RS component class is only registered as a provider of the listed extension provider or meta-provider contracts. All explicitly enumerated contract types must represent a class or an interface implemented or extended by the registered component. Contracts that are not assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s).

Specified by:
register in interface Configurable<ClientConfig>
Parameters:
providerClass - JAX-RS component class to be configured in the scope of this configurable context.
contracts - the specific extension provider or meta-provider contracts implemented by the component for which the component should be registered. Implementations MUST ignore attempts to register a component class for an empty or null collection of contracts via this method and SHOULD raise a warning about such event.
Returns:
the updated configurable context.

register

public ClientConfig register(Class<?> providerClass,
                             Map<Class<?>,Integer> contracts)
Description copied from interface: Configurable
Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides same functionality as Configurable.register(Class, Class[]) except that any priority specified on the registered JAX-RS component class via javax.annotation.Priority annotation is overridden for each extension provider contract type separately with an integer priority value specified as a value in the supplied map of [contract type, priority] pairs.

Note that in case a priority is not applicable to a provider contract registered for the JAX-RS component, the supplied priority value is ignored for such contract.

Specified by:
register in interface Configurable<ClientConfig>
Parameters:
providerClass - JAX-RS component class to be configured in the scope of this configurable context.
contracts - map of the specific extension provider and meta-provider contracts and their associated priorities for which the JAX-RS component is registered. All contracts in the map must represent a class or an interface implemented or extended by the JAX-RS component. Contracts that are not assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s).
Returns:
the updated configurable context.

register

public ClientConfig register(Object provider,
                             int bindingPriority)
Description copied from interface: Configurable
Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides the same functionality as Configurable.register(Object) except that any priority specified on the registered JAX-RS component class via javax.annotation.Priority annotation is overridden with the supplied priority value.

Note that in case the priority is not applicable to a particular provider contract implemented by the class of the registered component, the supplied priority value will be ignored for that contract.

Specified by:
register in interface Configurable<ClientConfig>
Parameters:
provider - JAX-RS component instance to be configured in the scope of this configurable context.
bindingPriority - the overriding priority for the registered component and all the provider contracts the component implements.
Returns:
the updated configurable context.

register

public ClientConfig register(Object provider,
                             Class<?>... contracts)
Description copied from interface: Configurable
Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides the same functionality as Configurable.register(Object) except the JAX-RS component class is only registered as a provider of the listed extension provider or meta-provider contracts. All explicitly enumerated contract types must represent a class or an interface implemented or extended by the registered component. Contracts that are not assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s).

Specified by:
register in interface Configurable<ClientConfig>
Parameters:
provider - JAX-RS component instance to be configured in the scope of this configurable context.
contracts - the specific extension provider or meta-provider contracts implemented by the component for which the component should be registered. Implementations MUST ignore attempts to register a component class for an empty or null collection of contracts via this method and SHOULD raise a warning about such event.
Returns:
the updated configurable context.

register

public ClientConfig register(Object provider,
                             Map<Class<?>,Integer> contracts)
Description copied from interface: Configurable
Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides same functionality as Configurable.register(Object, Class[]) except that any priority specified on the registered JAX-RS component class via javax.annotation.Priority annotation is overridden for each extension provider contract type separately with an integer priority value specified as a value in the supplied map of [contract type, priority] pairs.

Note that in case a priority is not applicable to a provider contract registered for the JAX-RS component, the supplied priority value is ignored for such contract.

Specified by:
register in interface Configurable<ClientConfig>
Parameters:
provider - JAX-RS component instance to be configured in the scope of this configurable context.
contracts - map of the specific extension provider and meta-provider contracts and their associated priorities for which the JAX-RS component is registered. All contracts in the map must represent a class or an interface implemented or extended by the JAX-RS component. Contracts that are not assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s).
Returns:
the updated configurable context.

property

public ClientConfig property(String name,
                             Object value)
Description copied from interface: Configurable
Set the new configuration property, if already set, the existing value of the property will be updated. Setting a null value into a property effectively removes the property from the property bag.

Specified by:
property in interface Configurable<ClientConfig>
Parameters:
name - property name.
value - (new) property value. null value removes the property with the given name.
Returns:
the updated configurable instance.

getConfiguration

public ClientConfig getConfiguration()
Description copied from interface: Configurable
Get a live view of an internal configuration state of this configurable instance. Any changes made using methods of this Configurable instance will be reflected in the returned Configuration instance.

The returned Configuration instance and the collection data it provides are not thread-safe wrt. modification made using methods on the parent configurable object.

Specified by:
getConfiguration in interface Configurable<ClientConfig>
Returns:
configuration live view of the internal configuration state.

getRuntimeType

public RuntimeType getRuntimeType()
Description copied from interface: Configuration
Get the runtime type of this configuration context.

Specified by:
getRuntimeType in interface Configuration
Returns:
configuration context runtime type.

getProperties

public Map<String,Object> getProperties()
Description copied from interface: Configuration
Get the immutable bag of configuration properties.

Specified by:
getProperties in interface Configuration
Returns:
the immutable view of configuration properties.

getProperty

public Object getProperty(String name)
Description copied from interface: Configuration
Get the value for the property with a given name.

Specified by:
getProperty in interface Configuration
Parameters:
name - property name.
Returns:
the property value for the specified property name or null if the property with such name is not configured.

getPropertyNames

public Collection<String> getPropertyNames()
Description copied from interface: Configuration
Returns an immutable collection containing the property names available within the context of the current configuration instance.

Use the Configuration.getProperty(java.lang.String) method with a property name to get the value of a property.

Specified by:
getPropertyNames in interface Configuration
Returns:
an immutable collection of property names.
See Also:
Configuration.getProperty(java.lang.String)

isEnabled

public boolean isEnabled(Feature feature)
Description copied from interface: Configuration
Check if a particular feature instance has been previously enabled in the runtime configuration context.

Method returns true only in case an instance equal to the feature instance is already present among the features previously successfully enabled in the configuration context.

Specified by:
isEnabled in interface Configuration
Parameters:
feature - a feature instance to test for.
Returns:
true if the feature instance has been previously enabled in this configuration context, false otherwise.

isEnabled

public boolean isEnabled(Class<? extends Feature> featureClass)
Description copied from interface: Configuration
Check if a feature instance of featureClass class has been previously enabled in the runtime configuration context.

Method returns true in case any instance of the featureClass class is already present among the features previously successfully enabled in the configuration context.

Specified by:
isEnabled in interface Configuration
Parameters:
featureClass - a feature class to test for.
Returns:
true if a feature of a given class has been previously enabled in this configuration context, false otherwise.

isRegistered

public boolean isRegistered(Object component)
Description copied from interface: Configuration
Check if a particular JAX-RS component instance (such as providers or features) has been previously registered in the runtime configuration context.

Method returns true only in case an instance equal to the component instance is already present among the components previously registered in the configuration context.

Specified by:
isRegistered in interface Configuration
Parameters:
component - a component instance to test for.
Returns:
true if the component instance has been previously registered in this configuration context, false otherwise.
See Also:
Configuration.isEnabled(Feature)

getContracts

public Map<Class<?>,Integer> getContracts(Class<?> componentClass)
Description copied from interface: Configuration
Get the extension contract registration information for a component of a given class. For component classes that are not configured in this configuration context the method returns an empty Map. Method does not return null.

Specified by:
getContracts in interface Configuration
Returns:
map of extension contracts and their priorities for which the component class is registered. May return an empty map in case the component has not been registered for any extension contract supported by the implementation.

isRegistered

public boolean isRegistered(Class<?> componentClass)
Description copied from interface: Configuration
Check if a JAX-RS component of the supplied componentClass class has been previously registered in the runtime configuration context.

Method returns true in case a component of the supplied componentClass class is already present among the previously registered component classes or instances in the configuration context.

Specified by:
isRegistered in interface Configuration
Parameters:
componentClass - a component class to test for.
Returns:
true if a component of a given class has been previously registered in this configuration context, false otherwise.
See Also:
Configuration.isEnabled(Class)

getClasses

public Set<Class<?>> getClasses()
Description copied from interface: Configuration
Get the immutable set of registered JAX-RS component (such as provider or feature) classes to be instantiated, injected and utilized in the scope of the configurable instance.

For each component type, there can be only a single class-based or instance-based registration present in the configuration context at any given time.

Specified by:
getClasses in interface Configuration
Returns:
the immutable set of registered JAX-RS component classes. The returned value may be empty but will never be null.
See Also:
Configuration.getInstances()

getInstances

public Set<Object> getInstances()
Description copied from interface: Configuration
Get the immutable set of registered JAX-RS component (such as provider or feature) instances to be utilized by the configurable instance. Fields and properties of returned instances are injected with their declared dependencies (see Context) by the runtime prior to use.

For each component type, there can be only a single class-based or instance-based registration present in the configuration context at any given time.

Specified by:
getInstances in interface Configuration
Returns:
the immutable set of registered JAX-RS component instances. The returned value may be empty but will never be null.
See Also:
Configuration.getClasses()

connector

public ClientConfig connector(Connector connector)
Set Jersey client transport connector.

Parameters:
connector - client transport connector.
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(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2007-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.