org.glassfish.jersey.client

Class JerseyWebTarget

java.lang.Object

org.glassfish.jersey.client.JerseyWebTarget

All Implemented Interfaces:

jakarta.ws.rs.client.WebTarget, jakarta.ws.rs.core.Configurable<jakarta.ws.rs.client.WebTarget>, Initializable<JerseyWebTarget>

public class JerseyWebTarget
extends Object
implements jakarta.ws.rs.client.WebTarget, Initializable<JerseyWebTarget>

Jersey implementation of JAX-RS client target contract.

Author:

Marek Potociar

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JerseyWebTarget(jakarta.ws.rs.core.UriBuilder uriBuilder, ClientConfig clientConfig) Create new web target instance.
protected	JerseyWebTarget(jakarta.ws.rs.core.UriBuilder uriBuilder, JerseyWebTarget that) Create new web target instance.

Method Summary

Modifier and Type	Method and Description
ClientConfig	getConfiguration() Get a live view of an internal client configuration state of this initializable instance.
URI	getUri()
jakarta.ws.rs.core.UriBuilder	getUriBuilder()
JerseyWebTarget	matrixParam(String name, Object... values)
JerseyWebTarget	path(String path)
JerseyWebTarget	preInitialize() Pre-initializes the runtime and runtime configuration of this component in order to improve performance during the first request.
JerseyWebTarget	property(String name, Object value)
JerseyWebTarget	queryParam(String name, Object... values)
JerseyWebTarget	register(Class<?> providerClass)
JerseyWebTarget	register(Class<?> providerClass, Class<?>... contracts)
JerseyWebTarget	register(Class<?> providerClass, int bindingPriority)
JerseyWebTarget	register(Class<?> providerClass, Map<Class<?>,Integer> contracts)
JerseyWebTarget	register(Object provider)
JerseyWebTarget	register(Object provider, Class<?>... contracts)
JerseyWebTarget	register(Object provider, int bindingPriority)
JerseyWebTarget	register(Object provider, Map<Class<?>,Integer> contracts)
JerseyInvocation.Builder	request()
JerseyInvocation.Builder	request(jakarta.ws.rs.core.MediaType... acceptedResponseTypes)
JerseyInvocation.Builder	request(String... acceptedResponseTypes)
JerseyWebTarget	resolveTemplate(String name, Object value)
JerseyWebTarget	resolveTemplate(String name, Object value, boolean encodeSlashInPath)
JerseyWebTarget	resolveTemplateFromEncoded(String name, Object value)
JerseyWebTarget	resolveTemplates(Map<String,Object> templateValues)
JerseyWebTarget	resolveTemplates(Map<String,Object> templateValues, boolean encodeSlashInPath)
JerseyWebTarget	resolveTemplatesFromEncoded(Map<String,Object> templateValues)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JerseyWebTarget

protected JerseyWebTarget(jakarta.ws.rs.core.UriBuilder uriBuilder,
                          JerseyWebTarget that)

Create new web target instance.

Parameters:

uriBuilder - builder for the target URI.

that - original target to copy the internal data from.

JerseyWebTarget

protected JerseyWebTarget(jakarta.ws.rs.core.UriBuilder uriBuilder,
                          ClientConfig clientConfig)

Create new web target instance.

Parameters:

uriBuilder - builder for the target URI.

clientConfig - target configuration.

Method Detail

getUri

public URI getUri()

Specified by:

getUri in interface jakarta.ws.rs.client.WebTarget

getUriBuilder

public jakarta.ws.rs.core.UriBuilder getUriBuilder()

Specified by:

getUriBuilder in interface jakarta.ws.rs.client.WebTarget

path

public JerseyWebTarget path(String path)
                     throws NullPointerException

Specified by:

path in interface jakarta.ws.rs.client.WebTarget

Throws:

NullPointerException

matrixParam

public JerseyWebTarget matrixParam(String name,
                                   Object... values)
                            throws NullPointerException

Specified by:

matrixParam in interface jakarta.ws.rs.client.WebTarget

Throws:

NullPointerException

queryParam

public JerseyWebTarget queryParam(String name,
                                  Object... values)
                           throws NullPointerException

Specified by:

queryParam in interface jakarta.ws.rs.client.WebTarget

Throws:

NullPointerException

request

public JerseyInvocation.Builder request()

Specified by:

request in interface jakarta.ws.rs.client.WebTarget

request

public JerseyInvocation.Builder request(String... acceptedResponseTypes)

Specified by:

request in interface jakarta.ws.rs.client.WebTarget

request

public JerseyInvocation.Builder request(jakarta.ws.rs.core.MediaType... acceptedResponseTypes)

Specified by:

request in interface jakarta.ws.rs.client.WebTarget

resolveTemplate

public JerseyWebTarget resolveTemplate(String name,
                                       Object value)
                                throws NullPointerException

Specified by:

resolveTemplate in interface jakarta.ws.rs.client.WebTarget

Throws:

NullPointerException

resolveTemplate

public JerseyWebTarget resolveTemplate(String name,
                                       Object value,
                                       boolean encodeSlashInPath)
                                throws NullPointerException

Specified by:

resolveTemplate in interface jakarta.ws.rs.client.WebTarget

Throws:

NullPointerException

resolveTemplateFromEncoded

public JerseyWebTarget resolveTemplateFromEncoded(String name,
                                                  Object value)
                                           throws NullPointerException

Specified by:

resolveTemplateFromEncoded in interface jakarta.ws.rs.client.WebTarget

Throws:

NullPointerException

resolveTemplates

public JerseyWebTarget resolveTemplates(Map<String,Object> templateValues)
                                 throws NullPointerException

Specified by:

resolveTemplates in interface jakarta.ws.rs.client.WebTarget

Throws:

NullPointerException

resolveTemplates

public JerseyWebTarget resolveTemplates(Map<String,Object> templateValues,
                                        boolean encodeSlashInPath)
                                 throws NullPointerException

Specified by:

resolveTemplates in interface jakarta.ws.rs.client.WebTarget

Throws:

NullPointerException

resolveTemplatesFromEncoded

public JerseyWebTarget resolveTemplatesFromEncoded(Map<String,Object> templateValues)
                                            throws NullPointerException

Specified by:

resolveTemplatesFromEncoded in interface jakarta.ws.rs.client.WebTarget

Throws:

NullPointerException

register

public JerseyWebTarget register(Class<?> providerClass)

Specified by:

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

register

public JerseyWebTarget register(Object provider)

Specified by:

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

register

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

Specified by:

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

register

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

Specified by:

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

register

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

Specified by:

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

register

public JerseyWebTarget register(Object provider,
                                int bindingPriority)

Specified by:

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

register

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

Specified by:

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

register

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

Specified by:

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

property

public JerseyWebTarget property(String name,
                                Object value)

Specified by:

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

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.WebTarget>

Specified by:

getConfiguration in interface Initializable<JerseyWebTarget>

Returns:

configuration live view of the internal configuration state.

preInitialize

public JerseyWebTarget 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<JerseyWebTarget>

Returns:

pre-initialized Jersey client component.

toString

public String toString()

Overrides:

toString in class Object