ClientConfig (Jersey 2.45 API)

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

All Implemented Interfaces:

Configurable<ClientConfig>, Configuration, ExtendedConfig
```
public class ClientConfig
extends Object
implements Configurable<ClientConfig>, ExtendedConfig
```
Jersey externalized implementation of client-side JAX-RS configurable contract.

Author:

Marek Potociar, Martin Matula, Libor Kramolis, Gaurav Gupta (gaurav.gupta@payara.fish)

Constructor Summary

Constructors
Constructor and Description
`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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientConfig`	`connectorProvider(ConnectorProvider connectorProvider)` Register a custom Jersey client connector provider.
`boolean`	`equals(Object obj)`
`ClientConfig`	`executorService(ExecutorService executorService)` Register custom Jersey client async executor.
`Set<Class<?>>`	`getClasses()`
`JerseyClient`	`getClient()` Get the parent Jersey client this configuration is bound to.
`ClientExecutor`	`getClientExecutor()`
`ClientConfig`	`getConfiguration()`
`Connector`	`getConnector()` Get the client transport connector.
`ConnectorProvider`	`getConnectorProvider()` Get the client transport connector provider.
`Map<Class<?>,Integer>`	`getContracts(Class<?> componentClass)`
`ExecutorService`	`getExecutorService()` Get custom client executor service.
`Set<Object>`	`getInstances()`
`Map<String,Object>`	`getProperties()`
`Object`	`getProperty(String name)`
`Collection<String>`	`getPropertyNames()`
`RuntimeType`	`getRuntimeType()`
`ScheduledExecutorService`	`getScheduledExecutorService()` Get custom client scheduled executor service.
`int`	`hashCode()`
`boolean`	`isEnabled(Class<? extends Feature> featureClass)`
`boolean`	`isEnabled(Feature feature)`
`boolean`	`isProperty(String name)` Get the value of the property with a given name converted to `boolean`.
`boolean`	`isRegistered(Class<?> componentClass)`
`boolean`	`isRegistered(Object component)`
`ClientConfig`	`loadFrom(Configuration config)` Load the internal configuration state from an externally provided configuration state.
`ClientConfig`	`property(String name, Object value)`
`ClientConfig`	`register(Class<?> providerClass)`
`ClientConfig`	`register(Class<?> providerClass, Class<?>... contracts)`
`ClientConfig`	`register(Class<?> providerClass, int bindingPriority)`
`ClientConfig`	`register(Class<?> providerClass, Map<Class<?>,Integer> contracts)`
`ClientConfig`	`register(Object provider)`
`ClientConfig`	`register(Object provider, Class<?>... contracts)`
`ClientConfig`	`register(Object provider, int bindingPriority)`
`ClientConfig`	`register(Object provider, Map<Class<?>,Integer> contracts)`
`ClientConfig`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Register custom Jersey client scheduler.

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)
```
    Specified by:
    
    register in interface Configurable<ClientConfig>
  - register
```
public ClientConfig register(Object provider)
```
    Specified by:
    
    register in interface Configurable<ClientConfig>
  - register
```
public ClientConfig register(Class<?> providerClass,
                             int bindingPriority)
```
    Specified by:
    
    register in interface Configurable<ClientConfig>
  - register
```
public ClientConfig register(Class<?> providerClass,
                             Class<?>... contracts)
```
    Specified by:
    
    register in interface Configurable<ClientConfig>
  - register
```
public ClientConfig register(Class<?> providerClass,
                             Map<Class<?>,Integer> contracts)
```
    Specified by:
    
    register in interface Configurable<ClientConfig>
  - register
```
public ClientConfig register(Object provider,
                             int bindingPriority)
```
    Specified by:
    
    register in interface Configurable<ClientConfig>
  - register
```
public ClientConfig register(Object provider,
                             Class<?>... contracts)
```
    Specified by:
    
    register in interface Configurable<ClientConfig>
  - register
```
public ClientConfig register(Object provider,
                             Map<Class<?>,Integer> contracts)
```
    Specified by:
    
    register in interface Configurable<ClientConfig>
  - property
```
public ClientConfig property(String name,
                             Object value)
```
    Specified by:
    
    property in interface Configurable<ClientConfig>
  - getConfiguration
```
public ClientConfig getConfiguration()
```
    Specified by:
    
    getConfiguration in interface Configurable<ClientConfig>
  - getRuntimeType
```
public RuntimeType getRuntimeType()
```
    Specified by:
    
    getRuntimeType in interface Configuration
  - getProperties
```
public Map<String,Object> getProperties()
```
    Specified by:
    
    getProperties in interface Configuration
  - getProperty
```
public Object getProperty(String name)
```
    Specified by:
    
    getProperty in interface Configuration
  - getPropertyNames
```
public Collection<String> getPropertyNames()
```
    Specified by:
    
    getPropertyNames in interface Configuration
  - isProperty
```
public boolean isProperty(String name)
```
    Description copied from interface: ExtendedConfig
    
    Get the value of the property with a given name converted to boolean. Returns false if the value is not convertible.
    
    Specified by:
    
    isProperty in interface ExtendedConfig
    
    Parameters:
    
    name - property name.
    
    Returns:
    
    boolean property value or false if the property is not convertible.
  - isEnabled
```
public boolean isEnabled(Feature feature)
```
    Specified by:
    
    isEnabled in interface Configuration
  - isEnabled
```
public boolean isEnabled(Class<? extends Feature> featureClass)
```
    Specified by:
    
    isEnabled in interface Configuration
  - isRegistered
```
public boolean isRegistered(Object component)
```
    Specified by:
    
    isRegistered in interface Configuration
  - getContracts
```
public Map<Class<?>,Integer> getContracts(Class<?> componentClass)
```
    Specified by:
    
    getContracts in interface Configuration
  - isRegistered
```
public boolean isRegistered(Class<?> componentClass)
```
    Specified by:
    
    isRegistered in interface Configuration
  - getClasses
```
public Set<Class<?>> getClasses()
```
    Specified by:
    
    getClasses in interface Configuration
  - getInstances
```
public Set<Object> getInstances()
```
    Specified by:
    
    getInstances in interface Configuration
  - connectorProvider
```
public ClientConfig connectorProvider(ConnectorProvider connectorProvider)
```
    Register a custom Jersey client connector provider.
    The registered ConnectorProvider instance will provide a Jersey client Connector for the JerseyClient instance created with this client configuration.
    
    Parameters:
    
    connectorProvider - custom connector provider. Must not be null.
    
    Returns:
    
    this client config instance.
    
    Throws:
    
    NullPointerException - in case the connectorProvider is null.
    
    Since:
    
    2.5
  - executorService
```
public ClientConfig executorService(ExecutorService executorService)
```
    Register custom Jersey client async executor.
    
    Parameters:
    
    executorService - custom executor service instance
    
    Returns:
    
    this client config instance
  - scheduledExecutorService
```
public ClientConfig scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
```
    Register custom Jersey client scheduler.
    
    Parameters:
    
    scheduledExecutorService - custom scheduled executor service instance
    
    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.
  - getConnectorProvider
```
public ConnectorProvider getConnectorProvider()
```
    Get the client transport connector provider.
    If no custom connector provider has been set, default connector provider instance is returned.
    
    Returns:
    
    configured client transport connector provider.
    
    Since:
    
    2.5
  - getExecutorService
```
public ExecutorService getExecutorService()
```
    Get custom client executor service.
    May return null if no custom executor service has been set.
    
    Returns:
    
    custom executor service instance or null if not set.
    
    Since:
    
    2.26
  - getScheduledExecutorService
```
public ScheduledExecutorService getScheduledExecutorService()
```
    Get custom client scheduled executor service.
    May return null if no custom scheduled executor service has been set.
    
    Returns:
    
    custom executor service instance or null if not set.
    
    Since:
    
    2.26
  - getClientExecutor
```
public ClientExecutor getClientExecutor()
```
  - 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

Class ClientConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientConfig

ClientConfig

ClientConfig

Method Detail

loadFrom

register

register

register

register

register

register

register

register

property

getConfiguration

getRuntimeType

getProperties

getProperty

getPropertyNames

isProperty

isEnabled

isEnabled

isRegistered

getContracts

isRegistered

getClasses

getInstances

connectorProvider

executorService

scheduledExecutorService

getConnector

getConnectorProvider

getExecutorService

getScheduledExecutorService

getClientExecutor

getClient

equals

hashCode