public class JerseyWebTarget extends java.lang.Object implements javax.ws.rs.client.WebTarget, Initializable<JerseyWebTarget>
JAX-RS client target
contract.Modifier and Type | Field and Description |
---|---|
private ClientConfig |
config |
private javax.ws.rs.core.UriBuilder |
targetUri |
Modifier | Constructor and Description |
---|---|
(package private) |
JerseyWebTarget(javax.ws.rs.core.Link link,
JerseyClient parent)
Create new web target instance.
|
(package private) |
JerseyWebTarget(java.lang.String uri,
JerseyClient parent)
Create new web target instance.
|
protected |
JerseyWebTarget(javax.ws.rs.core.UriBuilder uriBuilder,
ClientConfig clientConfig)
Create new web target instance.
|
(package private) |
JerseyWebTarget(javax.ws.rs.core.UriBuilder uriBuilder,
JerseyClient parent)
Create new web target instance.
|
protected |
JerseyWebTarget(javax.ws.rs.core.UriBuilder uriBuilder,
JerseyWebTarget that)
Create new web target instance.
|
(package private) |
JerseyWebTarget(java.net.URI uri,
JerseyClient parent)
Create new web target instance.
|
Modifier and Type | Method and Description |
---|---|
private static void |
checkForNullValues(java.lang.String name,
java.lang.Object[] values) |
private void |
checkNotClosed() |
private void |
checkTemplateValues(java.util.Map<java.lang.String,java.lang.Object> templateValues)
Check template values for
null values. |
ClientConfig |
getConfiguration()
Get a live view of an internal client configuration state of this initializable instance.
|
java.net.URI |
getUri() |
javax.ws.rs.core.UriBuilder |
getUriBuilder() |
JerseyWebTarget |
matrixParam(java.lang.String name,
java.lang.Object... values) |
JerseyWebTarget |
path(java.lang.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(java.lang.String name,
java.lang.Object value) |
JerseyWebTarget |
queryParam(java.lang.String name,
java.lang.Object... values) |
JerseyWebTarget |
register(java.lang.Class<?> providerClass) |
JerseyWebTarget |
register(java.lang.Class<?> providerClass,
java.lang.Class<?>... contracts) |
JerseyWebTarget |
register(java.lang.Class<?> providerClass,
int bindingPriority) |
JerseyWebTarget |
register(java.lang.Class<?> providerClass,
java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts) |
JerseyWebTarget |
register(java.lang.Object provider) |
JerseyWebTarget |
register(java.lang.Object provider,
java.lang.Class<?>... contracts) |
JerseyWebTarget |
register(java.lang.Object provider,
int bindingPriority) |
JerseyWebTarget |
register(java.lang.Object provider,
java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts) |
JerseyInvocation.Builder |
request() |
JerseyInvocation.Builder |
request(javax.ws.rs.core.MediaType... acceptedResponseTypes) |
JerseyInvocation.Builder |
request(java.lang.String... acceptedResponseTypes) |
JerseyWebTarget |
resolveTemplate(java.lang.String name,
java.lang.Object value) |
JerseyWebTarget |
resolveTemplate(java.lang.String name,
java.lang.Object value,
boolean encodeSlashInPath) |
JerseyWebTarget |
resolveTemplateFromEncoded(java.lang.String name,
java.lang.Object value) |
JerseyWebTarget |
resolveTemplates(java.util.Map<java.lang.String,java.lang.Object> templateValues) |
JerseyWebTarget |
resolveTemplates(java.util.Map<java.lang.String,java.lang.Object> templateValues,
boolean encodeSlashInPath) |
JerseyWebTarget |
resolveTemplatesFromEncoded(java.util.Map<java.lang.String,java.lang.Object> templateValues) |
private static javax.ws.rs.core.UriBuilder |
setQueryParam(javax.ws.rs.core.UriBuilder uriBuilder,
java.lang.String name,
java.lang.Object[] values) |
java.lang.String |
toString() |
private final ClientConfig config
private final javax.ws.rs.core.UriBuilder targetUri
JerseyWebTarget(java.lang.String uri, JerseyClient parent)
uri
- target URI.parent
- parent client.JerseyWebTarget(java.net.URI uri, JerseyClient parent)
uri
- target URI.parent
- parent client.JerseyWebTarget(javax.ws.rs.core.UriBuilder uriBuilder, JerseyClient parent)
uriBuilder
- builder for the target URI.parent
- parent client.JerseyWebTarget(javax.ws.rs.core.Link link, JerseyClient parent)
link
- link to the target URI.parent
- parent client.protected JerseyWebTarget(javax.ws.rs.core.UriBuilder uriBuilder, JerseyWebTarget that)
uriBuilder
- builder for the target URI.that
- original target to copy the internal data from.protected JerseyWebTarget(javax.ws.rs.core.UriBuilder uriBuilder, ClientConfig clientConfig)
uriBuilder
- builder for the target URI.clientConfig
- target configuration.public java.net.URI getUri()
getUri
in interface javax.ws.rs.client.WebTarget
private void checkNotClosed()
public javax.ws.rs.core.UriBuilder getUriBuilder()
getUriBuilder
in interface javax.ws.rs.client.WebTarget
public JerseyWebTarget path(java.lang.String path) throws java.lang.NullPointerException
path
in interface javax.ws.rs.client.WebTarget
java.lang.NullPointerException
public JerseyWebTarget matrixParam(java.lang.String name, java.lang.Object... values) throws java.lang.NullPointerException
matrixParam
in interface javax.ws.rs.client.WebTarget
java.lang.NullPointerException
public JerseyWebTarget queryParam(java.lang.String name, java.lang.Object... values) throws java.lang.NullPointerException
queryParam
in interface javax.ws.rs.client.WebTarget
java.lang.NullPointerException
private static javax.ws.rs.core.UriBuilder setQueryParam(javax.ws.rs.core.UriBuilder uriBuilder, java.lang.String name, java.lang.Object[] values)
private static void checkForNullValues(java.lang.String name, java.lang.Object[] values)
public JerseyInvocation.Builder request()
request
in interface javax.ws.rs.client.WebTarget
public JerseyInvocation.Builder request(java.lang.String... acceptedResponseTypes)
request
in interface javax.ws.rs.client.WebTarget
public JerseyInvocation.Builder request(javax.ws.rs.core.MediaType... acceptedResponseTypes)
request
in interface javax.ws.rs.client.WebTarget
public JerseyWebTarget resolveTemplate(java.lang.String name, java.lang.Object value) throws java.lang.NullPointerException
resolveTemplate
in interface javax.ws.rs.client.WebTarget
java.lang.NullPointerException
public JerseyWebTarget resolveTemplate(java.lang.String name, java.lang.Object value, boolean encodeSlashInPath) throws java.lang.NullPointerException
resolveTemplate
in interface javax.ws.rs.client.WebTarget
java.lang.NullPointerException
public JerseyWebTarget resolveTemplateFromEncoded(java.lang.String name, java.lang.Object value) throws java.lang.NullPointerException
resolveTemplateFromEncoded
in interface javax.ws.rs.client.WebTarget
java.lang.NullPointerException
public JerseyWebTarget resolveTemplates(java.util.Map<java.lang.String,java.lang.Object> templateValues) throws java.lang.NullPointerException
resolveTemplates
in interface javax.ws.rs.client.WebTarget
java.lang.NullPointerException
public JerseyWebTarget resolveTemplates(java.util.Map<java.lang.String,java.lang.Object> templateValues, boolean encodeSlashInPath) throws java.lang.NullPointerException
resolveTemplates
in interface javax.ws.rs.client.WebTarget
java.lang.NullPointerException
public JerseyWebTarget resolveTemplatesFromEncoded(java.util.Map<java.lang.String,java.lang.Object> templateValues) throws java.lang.NullPointerException
resolveTemplatesFromEncoded
in interface javax.ws.rs.client.WebTarget
java.lang.NullPointerException
private void checkTemplateValues(java.util.Map<java.lang.String,java.lang.Object> templateValues) throws java.lang.NullPointerException
null
values. Throws NullPointerException
if the name-value map or any of the
names or encoded values in the map is null
.templateValues
- map to check.java.lang.NullPointerException
- if the name-value map or any of the names or encoded values in the map
is null
.public JerseyWebTarget register(java.lang.Class<?> providerClass)
register
in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
public JerseyWebTarget register(java.lang.Object provider)
register
in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
public JerseyWebTarget register(java.lang.Class<?> providerClass, int bindingPriority)
register
in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
public JerseyWebTarget register(java.lang.Class<?> providerClass, java.lang.Class<?>... contracts)
register
in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
public JerseyWebTarget register(java.lang.Class<?> providerClass, java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts)
register
in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
public JerseyWebTarget register(java.lang.Object provider, int bindingPriority)
register
in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
public JerseyWebTarget register(java.lang.Object provider, java.lang.Class<?>... contracts)
register
in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
public JerseyWebTarget register(java.lang.Object provider, java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts)
register
in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
public JerseyWebTarget property(java.lang.String name, java.lang.Object value)
property
in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
public ClientConfig getConfiguration()
Initializable
getConfiguration
in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
getConfiguration
in interface Initializable<JerseyWebTarget>
public JerseyWebTarget preInitialize()
Initializable
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.
preInitialize
in interface Initializable<JerseyWebTarget>
public java.lang.String toString()
toString
in class java.lang.Object