Package org.glassfish.jersey.client
Class ClientConfig
- 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-RSconfigurablecontract.- Author:
- Marek Potociar, Martin Matula, Libor Kramolis, Gaurav Gupta (gaurav.gupta@payara.fish)
-
-
Constructor Summary
Constructors Constructor 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 Description ClientConfigconnectorProvider(ConnectorProvider connectorProvider)Register a custom Jersey client connector provider.booleanequals(Object obj)ClientConfigexecutorService(ExecutorService executorService)Register custom Jersey client async executor.Set<Class<?>>getClasses()JerseyClientgetClient()Get the parent Jersey client this configuration is bound to.ClientExecutorgetClientExecutor()ClientConfiggetConfiguration()ConnectorgetConnector()Get the client transport connector.ConnectorProvidergetConnectorProvider()Get the client transport connector provider.Map<Class<?>,Integer>getContracts(Class<?> componentClass)ExecutorServicegetExecutorService()Get custom client executor service.Set<Object>getInstances()Map<String,Object>getProperties()ObjectgetProperty(String name)Collection<String>getPropertyNames()RuntimeTypegetRuntimeType()ScheduledExecutorServicegetScheduledExecutorService()Get custom client scheduled executor service.inthashCode()booleanisEnabled(Feature feature)booleanisEnabled(Class<? extends Feature> featureClass)booleanisProperty(String name)booleanisRegistered(Class<?> componentClass)booleanisRegistered(Object component)ClientConfigloadFrom(Configuration config)Load the internal configuration state from an externally provided configuration state.ClientConfigproperty(String name, Object value)ClientConfigregister(Class<?> providerClass)ClientConfigregister(Class<?> providerClass, int bindingPriority)ClientConfigregister(Class<?> providerClass, Class<?>... contracts)ClientConfigregister(Class<?> providerClass, Map<Class<?>,Integer> contracts)ClientConfigregister(Object provider)ClientConfigregister(Object provider, int bindingPriority)ClientConfigregister(Object provider, Class<?>... contracts)ClientConfigregister(Object provider, Map<Class<?>,Integer> contracts)ClientConfigscheduledExecutorService(ScheduledExecutorService scheduledExecutorService)Register custom Jersey client scheduler.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface jakarta.ws.rs.core.Configuration
hasProperty
-
-
-
-
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:
registerin interfaceConfigurable<ClientConfig>
-
register
public ClientConfig register(Object provider)
- Specified by:
registerin interfaceConfigurable<ClientConfig>
-
register
public ClientConfig register(Class<?> providerClass, int bindingPriority)
- Specified by:
registerin interfaceConfigurable<ClientConfig>
-
register
public ClientConfig register(Class<?> providerClass, Class<?>... contracts)
- Specified by:
registerin interfaceConfigurable<ClientConfig>
-
register
public ClientConfig register(Class<?> providerClass, Map<Class<?>,Integer> contracts)
- Specified by:
registerin interfaceConfigurable<ClientConfig>
-
register
public ClientConfig register(Object provider, int bindingPriority)
- Specified by:
registerin interfaceConfigurable<ClientConfig>
-
register
public ClientConfig register(Object provider, Class<?>... contracts)
- Specified by:
registerin interfaceConfigurable<ClientConfig>
-
register
public ClientConfig register(Object provider, Map<Class<?>,Integer> contracts)
- Specified by:
registerin interfaceConfigurable<ClientConfig>
-
property
public ClientConfig property(String name, Object value)
- Specified by:
propertyin interfaceConfigurable<ClientConfig>
-
getConfiguration
public ClientConfig getConfiguration()
- Specified by:
getConfigurationin interfaceConfigurable<ClientConfig>
-
getRuntimeType
public RuntimeType getRuntimeType()
- Specified by:
getRuntimeTypein interfaceConfiguration
-
getProperties
public Map<String,Object> getProperties()
- Specified by:
getPropertiesin interfaceConfiguration
-
getProperty
public Object getProperty(String name)
- Specified by:
getPropertyin interfaceConfiguration
-
getPropertyNames
public Collection<String> getPropertyNames()
- Specified by:
getPropertyNamesin interfaceConfiguration
-
isProperty
public boolean isProperty(String name)
- Specified by:
isPropertyin interfaceExtendedConfig
-
isEnabled
public boolean isEnabled(Feature feature)
- Specified by:
isEnabledin interfaceConfiguration
-
isEnabled
public boolean isEnabled(Class<? extends Feature> featureClass)
- Specified by:
isEnabledin interfaceConfiguration
-
isRegistered
public boolean isRegistered(Object component)
- Specified by:
isRegisteredin interfaceConfiguration
-
getContracts
public Map<Class<?>,Integer> getContracts(Class<?> componentClass)
- Specified by:
getContractsin interfaceConfiguration
-
isRegistered
public boolean isRegistered(Class<?> componentClass)
- Specified by:
isRegisteredin interfaceConfiguration
-
getClasses
public Set<Class<?>> getClasses()
- Specified by:
getClassesin interfaceConfiguration
-
getInstances
public Set<Object> getInstances()
- Specified by:
getInstancesin interfaceConfiguration
-
connectorProvider
public ClientConfig connectorProvider(ConnectorProvider connectorProvider)
Register a custom Jersey client connector provider.The registered
ConnectorProviderinstance will provide a Jersey clientConnectorfor theJerseyClientinstance created with this client configuration.- Parameters:
connectorProvider- custom connector provider. Must not benull.- Returns:
- this client config instance.
- Throws:
NullPointerException- in case theconnectorProviderisnull.- 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
nullif 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 providerinstance 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
nullif 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
nullif 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
nullif no parent client has been bound.- Returns:
- bound parent Jersey client or
nullif not bound.
-
-