public class ClientConfig extends java.lang.Object implements javax.ws.rs.core.Configurable<ClientConfig>, ExtendedConfig
configurable
contract.Modifier and Type | Class and Description |
---|---|
private static class |
ClientConfig.RuntimeConfigConfigurator |
private static class |
ClientConfig.State
Default encapsulation of the internal configuration state.
|
Modifier and Type | Field and Description |
---|---|
private ClientConfig.State |
state
Internal configuration state.
|
Modifier | Constructor and Description |
---|---|
|
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.
|
private |
ClientConfig(ClientConfig.State state)
Construct a new Jersey configuration instance using the supplied state.
|
(package private) |
ClientConfig(JerseyClient parent)
Construct a new Jersey configuration instance with the features as well as
property values copied from the supplied JAX-RS configuration instance.
|
(package private) |
ClientConfig(JerseyClient parent,
javax.ws.rs.core.Configuration that)
Construct a new Jersey configuration instance with the features as well as
property values copied from the supplied JAX-RS configuration instance.
|
|
ClientConfig(java.lang.Object... providers)
Construct a new Jersey configuration instance and register the provided list of provider instances.
|
Modifier and Type | Method and Description |
---|---|
(package private) void |
checkClient()
Check that the configuration instance has a parent client set.
|
ClientConfig |
connectorProvider(ConnectorProvider connectorProvider)
Register a custom Jersey client connector provider.
|
boolean |
equals(java.lang.Object obj) |
ClientConfig |
executorService(java.util.concurrent.ExecutorService executorService)
Register custom Jersey client async executor.
|
java.util.Set<java.lang.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.
|
java.util.Map<java.lang.Class<?>,java.lang.Integer> |
getContracts(java.lang.Class<?> componentClass) |
java.util.concurrent.ExecutorService |
getExecutorService()
Get custom client executor service.
|
java.util.Set<java.lang.Object> |
getInstances() |
java.util.Map<java.lang.String,java.lang.Object> |
getProperties() |
java.lang.Object |
getProperty(java.lang.String name) |
java.util.Collection<java.lang.String> |
getPropertyNames() |
(package private) ClientRuntime |
getRuntime()
Get the configured runtime.
|
javax.ws.rs.RuntimeType |
getRuntimeType() |
java.util.concurrent.ScheduledExecutorService |
getScheduledExecutorService()
Get custom client scheduled executor service.
|
int |
hashCode() |
boolean |
isEnabled(java.lang.Class<? extends javax.ws.rs.core.Feature> featureClass) |
boolean |
isEnabled(javax.ws.rs.core.Feature feature) |
boolean |
isProperty(java.lang.String name)
Get the value of the property with a given name converted to
boolean . |
boolean |
isRegistered(java.lang.Class<?> componentClass) |
boolean |
isRegistered(java.lang.Object component) |
ClientConfig |
loadFrom(javax.ws.rs.core.Configuration config)
Load the internal configuration state from an externally provided configuration state.
|
(package private) ClientConfig |
preInitialize()
Pre initializes this configuration by initializing
client runtime
including message body workers . |
ClientConfig |
property(java.lang.String name,
java.lang.Object value) |
ClientConfig |
register(java.lang.Class<?> providerClass) |
ClientConfig |
register(java.lang.Class<?> providerClass,
java.lang.Class<?>... contracts) |
ClientConfig |
register(java.lang.Class<?> providerClass,
int bindingPriority) |
ClientConfig |
register(java.lang.Class<?> providerClass,
java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts) |
ClientConfig |
register(java.lang.Object provider) |
ClientConfig |
register(java.lang.Object provider,
java.lang.Class<?>... contracts) |
ClientConfig |
register(java.lang.Object provider,
int bindingPriority) |
ClientConfig |
register(java.lang.Object provider,
java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts) |
ClientConfig |
scheduledExecutorService(java.util.concurrent.ScheduledExecutorService scheduledExecutorService)
Register custom Jersey client scheduler.
|
(package private) ClientConfig |
snapshot()
Take a snapshot of the current configuration and its internal state.
|
private ClientConfig.State state
public ClientConfig()
public ClientConfig(java.lang.Class<?>... providerClasses)
providerClasses
- provider classes to be registered with this client configuration.public ClientConfig(java.lang.Object... providers)
providers
- provider instances to be registered with this client configuration.ClientConfig(JerseyClient parent)
parent
- parent Jersey client instance.ClientConfig(JerseyClient parent, javax.ws.rs.core.Configuration that)
parent
- parent Jersey client instance.that
- original Configuration
.private ClientConfig(ClientConfig.State state)
state
- to be referenced from the new configuration instance.ClientConfig snapshot()
public ClientConfig loadFrom(javax.ws.rs.core.Configuration config)
Calling this method effectively replaces existing configuration state of the instance with the state represented by the externally provided configuration.
config
- external configuration state to replace the configuration of this configurable
instance.public ClientConfig register(java.lang.Class<?> providerClass)
register
in interface javax.ws.rs.core.Configurable<ClientConfig>
public ClientConfig register(java.lang.Object provider)
register
in interface javax.ws.rs.core.Configurable<ClientConfig>
public ClientConfig register(java.lang.Class<?> providerClass, int bindingPriority)
register
in interface javax.ws.rs.core.Configurable<ClientConfig>
public ClientConfig register(java.lang.Class<?> providerClass, java.lang.Class<?>... contracts)
register
in interface javax.ws.rs.core.Configurable<ClientConfig>
public ClientConfig register(java.lang.Class<?> providerClass, java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts)
register
in interface javax.ws.rs.core.Configurable<ClientConfig>
public ClientConfig register(java.lang.Object provider, int bindingPriority)
register
in interface javax.ws.rs.core.Configurable<ClientConfig>
public ClientConfig register(java.lang.Object provider, java.lang.Class<?>... contracts)
register
in interface javax.ws.rs.core.Configurable<ClientConfig>
public ClientConfig register(java.lang.Object provider, java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts)
register
in interface javax.ws.rs.core.Configurable<ClientConfig>
public ClientConfig property(java.lang.String name, java.lang.Object value)
property
in interface javax.ws.rs.core.Configurable<ClientConfig>
public ClientConfig getConfiguration()
getConfiguration
in interface javax.ws.rs.core.Configurable<ClientConfig>
public javax.ws.rs.RuntimeType getRuntimeType()
getRuntimeType
in interface javax.ws.rs.core.Configuration
public java.util.Map<java.lang.String,java.lang.Object> getProperties()
getProperties
in interface javax.ws.rs.core.Configuration
public java.lang.Object getProperty(java.lang.String name)
getProperty
in interface javax.ws.rs.core.Configuration
public java.util.Collection<java.lang.String> getPropertyNames()
getPropertyNames
in interface javax.ws.rs.core.Configuration
public boolean isProperty(java.lang.String name)
ExtendedConfig
boolean
.
Returns false
if the value is not convertible.isProperty
in interface ExtendedConfig
name
- property name.boolean
property value or false
if the property is not
convertible.public boolean isEnabled(javax.ws.rs.core.Feature feature)
isEnabled
in interface javax.ws.rs.core.Configuration
public boolean isEnabled(java.lang.Class<? extends javax.ws.rs.core.Feature> featureClass)
isEnabled
in interface javax.ws.rs.core.Configuration
public boolean isRegistered(java.lang.Object component)
isRegistered
in interface javax.ws.rs.core.Configuration
public java.util.Map<java.lang.Class<?>,java.lang.Integer> getContracts(java.lang.Class<?> componentClass)
getContracts
in interface javax.ws.rs.core.Configuration
public boolean isRegistered(java.lang.Class<?> componentClass)
isRegistered
in interface javax.ws.rs.core.Configuration
public java.util.Set<java.lang.Class<?>> getClasses()
getClasses
in interface javax.ws.rs.core.Configuration
public java.util.Set<java.lang.Object> getInstances()
getInstances
in interface javax.ws.rs.core.Configuration
public ClientConfig connectorProvider(ConnectorProvider connectorProvider)
The registered ConnectorProvider
instance will provide a
Jersey client Connector
for the JerseyClient
instance
created with this client configuration.
connectorProvider
- custom connector provider. Must not be null
.java.lang.NullPointerException
- in case the connectorProvider
is null
.public ClientConfig executorService(java.util.concurrent.ExecutorService executorService)
executorService
- custom executor service instancepublic ClientConfig scheduledExecutorService(java.util.concurrent.ScheduledExecutorService scheduledExecutorService)
scheduledExecutorService
- custom scheduled executor service instancepublic Connector getConnector()
May return null
if no connector has been set.
public ConnectorProvider getConnectorProvider()
If no custom connector provider has been set,
default connector provider
instance is returned.
public java.util.concurrent.ExecutorService getExecutorService()
May return null if no custom executor service has been set.
null
if not set.public java.util.concurrent.ScheduledExecutorService getScheduledExecutorService()
May return null if no custom scheduled executor service has been set.
null
if not set.ClientRuntime getRuntime()
public ClientExecutor getClientExecutor()
public JerseyClient getClient()
May return null
if no parent client has been bound.
null
if not bound.ClientConfig preInitialize()
client runtime
including message body workers
.
Once this method is called no other method implementing Configurable
should be called
on this pre initialized configuration otherwise configuration will change back to uninitialized.
Note that this method must be called only when configuration is attached to the client.void checkClient() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- in case no parent Jersey client has been
bound to the configuration instance yet.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object