public class JerseyClientBuilder extends ClientBuilder
JAX-RS client builder.JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY| Constructor and Description |
|---|
JerseyClientBuilder()
Create new Jersey client builder instance.
|
| Modifier and Type | Method and Description |
|---|---|
JerseyClient |
build()
Build a new client instance using all the configuration previously specified in this client builder.
|
ClientBuilder |
connectTimeout(long timeout,
TimeUnit unit)
Set the connect timeout.
|
static JerseyClient |
createClient()
Create a new custom-configured
JerseyClient instance. |
static JerseyClient |
createClient(Configuration configuration)
Create a new custom-configured
JerseyClient instance. |
ClientBuilder |
executorService(ExecutorService executorService)
Set the client-side
ExecutorService. |
ClientConfig |
getConfiguration()
Get a live view of an internal configuration state of this configurable instance.
|
JerseyClientBuilder |
hostnameVerifier(HostnameVerifier hostnameVerifier)
Set the hostname verifier to be used by the client to verify the endpoint's hostname against it's identification
information.
|
JerseyClientBuilder |
keyStore(KeyStore keyStore,
char[] password)
Set the client-side key store.
|
JerseyClientBuilder |
property(String name,
Object value)
Set the new configuration property, if already set, the existing value of the property will be updated.
|
ClientBuilder |
readTimeout(long timeout,
TimeUnit unit)
Set the read timeout.
|
JerseyClientBuilder |
register(Class<?> componentClass)
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. |
JerseyClientBuilder |
register(Class<?> componentClass,
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. |
JerseyClientBuilder |
register(Class<?> componentClass,
int priority)
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. |
JerseyClientBuilder |
register(Class<?> componentClass,
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. |
JerseyClientBuilder |
register(Object component)
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. |
JerseyClientBuilder |
register(Object component,
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. |
JerseyClientBuilder |
register(Object component,
int priority)
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. |
JerseyClientBuilder |
register(Object component,
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. |
ClientBuilder |
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Set the client-side
ScheduledExecutorService. |
JerseyClientBuilder |
sslContext(SSLContext sslContext)
Set the SSL context that will be used when creating secured transport connections to server endpoints from
web targets created by the client instance that is using this SSL context. |
JerseyClientBuilder |
trustStore(KeyStore trustStore)
Set the client-side trust store.
|
JerseyClientBuilder |
withConfig(Configuration config)
Set the internal configuration state to an externally provided configuration state.
|
keyStore, newBuilder, newClient, newClientpublic JerseyClientBuilder()
public static JerseyClient createClient()
JerseyClient instance.public static JerseyClient createClient(Configuration configuration)
JerseyClient instance.configuration - data used to provide initial configuration for the new
Jersey client instance.public JerseyClientBuilder sslContext(SSLContext sslContext)
ClientBuilderweb targets created by the client instance that is using this SSL context. The SSL context is
expected to have all the security infrastructure initialized, including the key and trust managers.
Setting a SSL context instance resets any key store or
trust store values previously specified.
sslContext in class ClientBuildersslContext - secure socket protocol implementation which acts as a factory for secure socket factories or
SSL engines. Must not be null.ClientBuilder.keyStore(java.security.KeyStore, char[]),
ClientBuilder.keyStore(java.security.KeyStore, String),
ClientBuilder.trustStore(java.security.KeyStore)public JerseyClientBuilder keyStore(KeyStore keyStore, char[] password)
ClientBuilder
Setting a key store instance resets any SSL context instance value
previously specified.
Note that a custom key store is only required if you want to enable a custom setup of a 2-way SSL connections (client certificate authentication).
keyStore in class ClientBuilderkeyStore - client-side key store. Must not be null.password - client key password. Must not be null.ClientBuilder.sslContext(javax.net.ssl.SSLContext),
ClientBuilder.keyStore(java.security.KeyStore, String),
ClientBuilder.trustStore(java.security.KeyStore)public JerseyClientBuilder trustStore(KeyStore trustStore)
ClientBuilder
Setting a trust store instance resets any SSL context instance value
previously specified.
In case a custom trust store or custom SSL context is not specified, the trust management will be configured to use the default Java runtime settings.
trustStore in class ClientBuildertrustStore - client-side trust store. Must not be null.ClientBuilder.sslContext(javax.net.ssl.SSLContext),
ClientBuilder.keyStore(java.security.KeyStore, char[]),
ClientBuilder.keyStore(java.security.KeyStore, String)public JerseyClientBuilder hostnameVerifier(HostnameVerifier hostnameVerifier)
ClientBuilderhostnameVerifier in class ClientBuilderhostnameVerifier - hostname verifier.public ClientBuilder executorService(ExecutorService executorService)
ClientBuilderExecutorService.
Provided executor service will be used for executing asynchronous tasks.
When running in a Jakarta EE container, implementations are required to use the container-managed executor service by default. In Java SE, the default is implementation-specific. In either case, calling this method will override the default.
executorService in class ClientBuilderexecutorService - executor service to be used for async invocations.Invocation.Builder.async(),
Invocation.Builder.rx(),
RxInvokerProvider.getRxInvoker(SyncInvoker, ExecutorService)public ClientBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
ClientBuilderScheduledExecutorService.
Provided executor service will be used for executing scheduled asynchronous tasks.
When running in a Jakarta EE container, implementations are required to use the container-managed scheduled executor service by default. In Java SE the default is implementation-specific. In either case, calling this method will override the default.
scheduledExecutorService in class ClientBuilderscheduledExecutorService - executor service to be used for scheduled async invocations.SseEventSource.Builder.reconnectingEvery(long, TimeUnit)public ClientBuilder connectTimeout(long timeout, TimeUnit unit)
ClientBuilder
Value 0 represents infinity. Negative values are not allowed.
connectTimeout in class ClientBuildertimeout - the maximum time to wait.unit - the time unit of the timeout argument.public ClientBuilder readTimeout(long timeout, TimeUnit unit)
ClientBuilder
The value is the timeout to read a response. If the server doesn't respond within the defined timeframe,
ProcessingException is thrown with TimeoutException as a cause.
Value 0 represents infinity. Negative values are not allowed.
readTimeout in class ClientBuildertimeout - the maximum time to wait.unit - the time unit of the timeout argument.public JerseyClient build()
ClientBuilderbuild in class ClientBuilderpublic ClientConfig getConfiguration()
ConfigurableConfigurable 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.
public JerseyClientBuilder property(String name, Object value)
Configurablenull value into a property effectively removes the property from the property bag.name - property name.value - (new) property value. null value removes the property with the given name.public JerseyClientBuilder register(Class<?> componentClass)
Configurablefeature 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.
componentClass - JAX-RS component class to be configured in the scope of this configurable context.public JerseyClientBuilder register(Class<?> componentClass, int priority)
Configurablefeature 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 jakarta.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.
componentClass - JAX-RS component class to be configured in the scope of this configurable context.priority - the overriding priority for the registered component and all the provider contracts the component
implements.public JerseyClientBuilder register(Class<?> componentClass, Class<?>... contracts)
Configurablefeature 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).
componentClass - 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.public JerseyClientBuilder register(Class<?> componentClass, Map<Class<?>,Integer> contracts)
Configurablefeature 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 jakarta.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.
componentClass - 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).public JerseyClientBuilder register(Object component)
Configurablefeature 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.
component - JAX-RS component instance to be configured in the scope of this configurable context.public JerseyClientBuilder register(Object component, int priority)
Configurablefeature 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 jakarta.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.
component - JAX-RS component instance to be configured in the scope of this configurable context.priority - the overriding priority for the registered component and all the provider contracts the component
implements.public JerseyClientBuilder register(Object component, Class<?>... contracts)
Configurablefeature 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).
component - 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.public JerseyClientBuilder register(Object component, Map<Class<?>,Integer> contracts)
Configurablefeature 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 jakarta.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.
component - 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).public JerseyClientBuilder withConfig(Configuration config)
ClientBuilderwithConfig in class ClientBuilderconfig - external configuration state to replace the configuration of this configurable instance.Copyright © 2007-2021, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.