Package org.glassfish.jersey.client

Class JerseyClient

java.lang.Object

org.glassfish.jersey.client.JerseyClient

All Implemented Interfaces:

jakarta.ws.rs.client.Client, jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>, AutoCloseable, Initializable<JerseyClient>

public class JerseyClient
extends Object
implements jakarta.ws.rs.client.Client, Initializable<JerseyClient>

Jersey implementation of JAX-RS Client contract.

Author:

Marek Potociar

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JerseyClient()	Create a new Jersey client instance using a default configuration.
protected	JerseyClient(jakarta.ws.rs.core.Configuration config, SSLContext sslContext, HostnameVerifier verifier)	Create a new Jersey client instance.
protected	JerseyClient(jakarta.ws.rs.core.Configuration config, SSLContext sslContext, HostnameVerifier verifier, DefaultSslContextProvider defaultSslContextProvider)	Create a new Jersey client instance.
protected	JerseyClient(jakarta.ws.rs.core.Configuration config, org.glassfish.jersey.internal.util.collection.UnsafeValue<SSLContext,IllegalStateException> sslContextProvider, HostnameVerifier verifier)	Create a new Jersey client instance.
protected	JerseyClient(jakarta.ws.rs.core.Configuration config, org.glassfish.jersey.internal.util.collection.UnsafeValue<SSLContext,IllegalStateException> sslContextProvider, HostnameVerifier verifier, DefaultSslContextProvider defaultSslContextProvider)	Create a new Jersey client instance.

Method Summary

Modifier and Type	Method	Description
void	close()
ClientConfig	getConfiguration()	Get a live view of an internal client configuration state of this initializable instance.
ExecutorService	getExecutorService()
HostnameVerifier	getHostnameVerifier()
ScheduledExecutorService	getScheduledExecutorService()
SSLContext	getSslContext()
JerseyInvocation.Builder	invocation(jakarta.ws.rs.core.Link link)
boolean	isClosed()	Check client state.
boolean	isDefaultSslContext()	Get information about used SSLContext.
JerseyClient	preInitialize()	Pre-initializes the runtime and runtime configuration of this component in order to improve performance during the first request.
JerseyClient	property(String name, Object value)
JerseyClient	register(Class<?> providerClass)
JerseyClient	register(Class<?> providerClass, int bindingPriority)
JerseyClient	register(Class<?> providerClass, Class<?>... contracts)
JerseyClient	register(Class<?> providerClass, Map<Class<?>,Integer> contracts)
JerseyClient	register(Object provider)
JerseyClient	register(Object provider, int bindingPriority)
JerseyClient	register(Object provider, Class<?>... contracts)
JerseyClient	register(Object provider, Map<Class<?>,Integer> contracts)
JerseyWebTarget	target(jakarta.ws.rs.core.Link link)
JerseyWebTarget	target(jakarta.ws.rs.core.UriBuilder uriBuilder)
JerseyWebTarget	target(String uri)
JerseyWebTarget	target(URI uri)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JerseyClient

protected JerseyClient()

Create a new Jersey client instance using a default configuration.

JerseyClient

protected JerseyClient(jakarta.ws.rs.core.Configuration config,
                       SSLContext sslContext,
                       HostnameVerifier verifier)

Create a new Jersey client instance.

Parameters:

config - jersey client configuration.

sslContext - jersey client SSL context.

verifier - jersey client host name verifier.

JerseyClient

protected JerseyClient(jakarta.ws.rs.core.Configuration config,
                       SSLContext sslContext,
                       HostnameVerifier verifier,
                       DefaultSslContextProvider defaultSslContextProvider)

Create a new Jersey client instance.

Parameters:

config - jersey client configuration.

sslContext - jersey client SSL context.

verifier - jersey client host name verifier.

defaultSslContextProvider - default SSL context provider.

JerseyClient

protected JerseyClient(jakarta.ws.rs.core.Configuration config,
                       org.glassfish.jersey.internal.util.collection.UnsafeValue<SSLContext,IllegalStateException> sslContextProvider,
                       HostnameVerifier verifier)

Create a new Jersey client instance.

Parameters:

config - jersey client configuration.

sslContextProvider - jersey client SSL context provider.

verifier - jersey client host name verifier.

JerseyClient

protected JerseyClient(jakarta.ws.rs.core.Configuration config,
                       org.glassfish.jersey.internal.util.collection.UnsafeValue<SSLContext,IllegalStateException> sslContextProvider,
                       HostnameVerifier verifier,
                       DefaultSslContextProvider defaultSslContextProvider)

Create a new Jersey client instance.

Parameters:

config - jersey client configuration.

sslContextProvider - jersey client SSL context provider. Non null provider is expected to return non-default value.

verifier - jersey client host name verifier.

defaultSslContextProvider - default SSL context provider.

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface jakarta.ws.rs.client.Client

isClosed

public boolean isClosed()

Check client state.

Returns:

true if current JerseyClient instance is closed, otherwise false.

See Also:

close()

isDefaultSslContext

public boolean isDefaultSslContext()

Get information about used SSLContext.

Returns:

true when used SSLContext is acquired from SslConfigurator.getDefaultContext(), false otherwise.

target

public JerseyWebTarget target(String uri)

Specified by:

target in interface jakarta.ws.rs.client.Client

target

public JerseyWebTarget target(URI uri)

Specified by:

target in interface jakarta.ws.rs.client.Client

target

public JerseyWebTarget target(jakarta.ws.rs.core.UriBuilder uriBuilder)

Specified by:

target in interface jakarta.ws.rs.client.Client

target

public JerseyWebTarget target(jakarta.ws.rs.core.Link link)

Specified by:

target in interface jakarta.ws.rs.client.Client

invocation

public JerseyInvocation.Builder invocation(jakarta.ws.rs.core.Link link)

Specified by:

invocation in interface jakarta.ws.rs.client.Client

register

public JerseyClient register(Class<?> providerClass)

Specified by:

register in interface jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>

register

public JerseyClient register(Object provider)

Specified by:

register in interface jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>

register

public JerseyClient register(Class<?> providerClass,
                             int bindingPriority)

Specified by:

register in interface jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>

register

public JerseyClient register(Class<?> providerClass,
                             Class<?>... contracts)

Specified by:

register in interface jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>

register

public JerseyClient register(Class<?> providerClass,
                             Map<Class<?>,Integer> contracts)

Specified by:

register in interface jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>

register

public JerseyClient register(Object provider,
                             int bindingPriority)

Specified by:

register in interface jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>

register

public JerseyClient register(Object provider,
                             Class<?>... contracts)

Specified by:

register in interface jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>

register

public JerseyClient register(Object provider,
                             Map<Class<?>,Integer> contracts)

Specified by:

register in interface jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>

property

public JerseyClient property(String name,
                             Object value)

Specified by:

property in interface jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>

getConfiguration

public ClientConfig getConfiguration()

Description copied from interface: Initializable

Get a live view of an internal client configuration state of this initializable instance.

Specified by:

getConfiguration in interface jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.Client>

Specified by:

getConfiguration in interface Initializable<JerseyClient>

Returns:

configuration live view of the internal configuration state.

getSslContext

public SSLContext getSslContext()

Specified by:

getSslContext in interface jakarta.ws.rs.client.Client

getHostnameVerifier

public HostnameVerifier getHostnameVerifier()

Specified by:

getHostnameVerifier in interface jakarta.ws.rs.client.Client

getExecutorService

public ExecutorService getExecutorService()

getScheduledExecutorService

public ScheduledExecutorService getScheduledExecutorService()

preInitialize

public JerseyClient preInitialize()

Description copied from interface: Initializable

Pre-initializes the runtime and runtime configuration of this component in order to improve performance during the first request.

Once this method is called no other method implementing Configurable should be called on this pre initialized component, otherwise the initialized client runtime will be discarded and the configuration will change back to uninitialized.

Specified by:

preInitialize in interface Initializable<JerseyClient>

Returns:

pre-initialized Jersey client component.