public class ClientInvocationBuilder extends Object implements Invocation.Builder
| Modifier and Type | Field and Description |
|---|---|
protected ClientInvocation |
invocation |
| Constructor and Description |
|---|
ClientInvocationBuilder(ResteasyClient client,
URI uri,
ClientConfiguration configuration) |
| Modifier and Type | Method and Description |
|---|---|
Invocation.Builder |
accept(MediaType... mediaTypes)
Add the accepted response media types.
|
Invocation.Builder |
accept(String... mediaTypes)
Add the accepted response media types.
|
Invocation.Builder |
acceptEncoding(String... encodings)
Add acceptable encodings.
|
Invocation.Builder |
acceptLanguage(Locale... locales)
Add acceptable languages.
|
Invocation.Builder |
acceptLanguage(String... locales)
Add acceptable languages.
|
AsyncInvoker |
async()
Access the asynchronous uniform request invocation interface to
asynchronously invoke the built request.
|
Invocation |
build(String method)
Build a request invocation using an arbitrary request method name.
|
Invocation |
build(String method,
Entity<?> entity)
Build a request invocation using an arbitrary request method name and
request entity.
|
Invocation |
buildDelete()
Build a DELETE request invocation.
|
Invocation |
buildGet()
Build a GET request invocation.
|
Invocation |
buildPost(Entity<?> entity)
Build a POST request invocation.
|
Invocation |
buildPut(Entity<?> entity)
Build a PUT request invocation.
|
Invocation.Builder |
cacheControl(CacheControl cacheControl)
Set the cache control data of the message.
|
Invocation.Builder |
cookie(Cookie cookie)
Add a cookie to be set.
|
Invocation.Builder |
cookie(String name,
String value)
Add a cookie to be set.
|
protected ClientInvocation |
createClientInvocation(ResteasyClient client,
URI uri,
ClientRequestHeaders headers,
ClientConfiguration parent) |
Response |
delete()
Invoke HTTP DELETE method for the current request synchronously.
|
<T> T |
delete(Class<T> responseType)
Invoke HTTP DELETE method for the current request synchronously.
|
<T> T |
delete(GenericType<T> responseType)
Invoke HTTP DELETE method for the current request synchronously.
|
Response |
get()
Invoke HTTP GET method for the current request synchronously.
|
<T> T |
get(Class<T> responseType)
Invoke HTTP GET method for the current request synchronously.
|
<T> T |
get(GenericType<T> responseType)
Invoke HTTP GET method for the current request synchronously.
|
ClientRequestHeaders |
getHeaders() |
ClientInvocation |
getInvocation() |
WebTarget |
getTarget() |
URI |
getURI() |
Response |
head()
Invoke HTTP HEAD method for the current request synchronously.
|
Invocation.Builder |
header(String name,
Object value)
Add an arbitrary header.
|
Invocation.Builder |
headers(MultivaluedMap<String,Object> headers)
Replaces all existing headers with the newly supplied headers.
|
boolean |
isChunked() |
Response |
method(String name)
Invoke an arbitrary method for the current request synchronously.
|
<T> T |
method(String name,
Class<T> responseType)
Invoke an arbitrary method for the current request synchronously.
|
Response |
method(String name,
Entity<?> entity)
Invoke an arbitrary method for the current request synchronously.
|
<T> T |
method(String name,
Entity<?> entity,
Class<T> responseType)
Invoke an arbitrary method for the current request synchronously.
|
<T> T |
method(String name,
Entity<?> entity,
GenericType<T> responseType)
Invoke an arbitrary method for the current request synchronously.
|
<T> T |
method(String name,
GenericType<T> responseType)
Invoke an arbitrary method for the current request synchronously.
|
Response |
options()
Invoke HTTP OPTIONS method for the current request synchronously.
|
<T> T |
options(Class<T> responseType)
Invoke HTTP OPTIONS method for the current request synchronously.
|
<T> T |
options(GenericType<T> responseType)
Invoke HTTP OPTIONS method for the current request synchronously.
|
Response |
patch(Entity<?> entity) |
<T> T |
patch(Entity<?> entity,
Class<T> responseType) |
<T> T |
patch(Entity<?> entity,
GenericType<T> responseType) |
Response |
post(Entity<?> entity)
Invoke HTTP POST method for the current request synchronously.
|
<T> T |
post(Entity<?> entity,
Class<T> responseType)
Invoke HTTP POST method for the current request synchronously.
|
<T> T |
post(Entity<?> entity,
GenericType<T> responseType)
Invoke HTTP POST method for the current request synchronously.
|
Invocation.Builder |
property(String name,
Object value)
Set a new property in the context of a request represented by this invocation builder.
|
Response |
put(Entity<?> entity)
Invoke HTTP PUT method for the current request synchronously.
|
<T> T |
put(Entity<?> entity,
Class<T> responseType)
Invoke HTTP PUT method for the current request synchronously.
|
<T> T |
put(Entity<?> entity,
GenericType<T> responseType)
Invoke HTTP PUT method for the current request synchronously.
|
CompletionStageRxInvoker |
rx()
Access the default reactive invoker based on
CompletionStage. |
<T extends RxInvoker> |
rx(Class<T> clazz)
Access a reactive invoker based on a
RxInvoker subclass provider. |
void |
setChunked(boolean chunked) |
void |
setInvocation(ClientInvocation invocation) |
void |
setTarget(WebTarget target) |
Response |
trace()
Invoke HTTP TRACE method for the current request synchronously.
|
<T> T |
trace(Class<T> responseType)
Invoke HTTP TRACE method for the current request synchronously.
|
<T> T |
trace(GenericType<T> responseType)
Invoke HTTP TRACE method for the current request synchronously.
|
protected ClientInvocation invocation
public ClientInvocationBuilder(ResteasyClient client, URI uri, ClientConfiguration configuration)
protected ClientInvocation createClientInvocation(ResteasyClient client, URI uri, ClientRequestHeaders headers, ClientConfiguration parent)
public ClientInvocation getInvocation()
public void setInvocation(ClientInvocation invocation)
public ClientRequestHeaders getHeaders()
public Invocation.Builder accept(String... mediaTypes)
Invocation.Builderaccept in interface Invocation.BuildermediaTypes - accepted response media types.public Invocation.Builder accept(MediaType... mediaTypes)
Invocation.Builderaccept in interface Invocation.BuildermediaTypes - accepted response media types.public Invocation.Builder acceptLanguage(Locale... locales)
Invocation.BuilderacceptLanguage in interface Invocation.Builderlocales - an array of the acceptable languages.public Invocation.Builder acceptLanguage(String... locales)
Invocation.BuilderacceptLanguage in interface Invocation.Builderlocales - an array of the acceptable languages.public Invocation.Builder acceptEncoding(String... encodings)
Invocation.BuilderacceptEncoding in interface Invocation.Builderencodings - an array of the acceptable encodings.public Invocation.Builder cookie(Cookie cookie)
Invocation.Buildercookie in interface Invocation.Buildercookie - to be set.public Invocation.Builder cookie(String name, String value)
Invocation.Buildercookie in interface Invocation.Buildername - the name of the cookie.value - the value of the cookie.public Invocation.Builder cacheControl(CacheControl cacheControl)
Invocation.BuildercacheControl in interface Invocation.BuildercacheControl - the cache control directives, if null
any existing cache control directives will be removed.public Invocation.Builder header(String name, Object value)
Invocation.Builderheader in interface Invocation.Buildername - the name of the headervalue - the value of the header, the header will be serialized
using a RuntimeDelegate.HeaderDelegate if
one is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class)
for the class of value or using its toString method
if a header delegate is not available. If value is null
then all current headers of the same name will be removed.public Invocation.Builder headers(MultivaluedMap<String,Object> headers)
Invocation.Builderheaders in interface Invocation.Builderheaders - new headers to be set, if null all existing
headers will be removed.public Invocation build(String method)
Invocation.Builderbuild in interface Invocation.Buildermethod - request method name.public Invocation build(String method, Entity<?> entity)
Invocation.Builderbuild in interface Invocation.Buildermethod - request method name.entity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.public Invocation buildGet()
Invocation.BuilderbuildGet in interface Invocation.Builderpublic Invocation buildDelete()
Invocation.BuilderbuildDelete in interface Invocation.Builderpublic Invocation buildPost(Entity<?> entity)
Invocation.BuilderbuildPost in interface Invocation.Builderentity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.public Invocation buildPut(Entity<?> entity)
Invocation.BuilderbuildPut in interface Invocation.Builderentity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.public AsyncInvoker async()
Invocation.Builderasync in interface Invocation.Builderpublic Response get()
SyncInvokerget in interface SyncInvokerpublic <T> T get(Class<T> responseType)
SyncInvokerget in interface SyncInvokerT - response entity type.responseType - Java type the response entity will be converted to.public <T> T get(GenericType<T> responseType)
SyncInvokerget in interface SyncInvokerT - generic response entity type.responseType - representation of a generic Java type the response
entity will be converted to.public Response put(Entity<?> entity)
SyncInvokerput in interface SyncInvokerentity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.public <T> T put(Entity<?> entity, Class<T> responseType)
SyncInvokerput in interface SyncInvokerT - response entity type.entity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.responseType - Java type the response entity will be converted to.public <T> T put(Entity<?> entity, GenericType<T> responseType)
SyncInvokerput in interface SyncInvokerT - generic response entity type.entity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.responseType - representation of a generic Java type the response
entity will be converted to.public Response post(Entity<?> entity)
SyncInvokerpost in interface SyncInvokerentity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.public <T> T post(Entity<?> entity, Class<T> responseType)
SyncInvokerpost in interface SyncInvokerT - response entity type.entity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.responseType - Java type the response entity will be converted to.public <T> T post(Entity<?> entity, GenericType<T> responseType)
SyncInvokerpost in interface SyncInvokerT - generic response entity type.entity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.responseType - representation of a generic Java type the response
entity will be converted to.public Response delete()
SyncInvokerdelete in interface SyncInvokerpublic <T> T delete(Class<T> responseType)
SyncInvokerdelete in interface SyncInvokerT - response entity type.responseType - Java type the response entity will be converted to.public <T> T delete(GenericType<T> responseType)
SyncInvokerdelete in interface SyncInvokerT - generic response entity type.responseType - representation of a generic Java type the response
entity will be converted to.public Response head()
SyncInvokerhead in interface SyncInvokerpublic Response options()
SyncInvokeroptions in interface SyncInvokerpublic <T> T options(Class<T> responseType)
SyncInvokeroptions in interface SyncInvokerT - response entity type.responseType - Java type the response entity will be converted to.public <T> T options(GenericType<T> responseType)
SyncInvokeroptions in interface SyncInvokerT - generic response entity type.responseType - representation of a generic Java type the response
entity will be converted to.public Response trace()
SyncInvokertrace in interface SyncInvokerpublic <T> T trace(Class<T> responseType)
SyncInvokertrace in interface SyncInvokerT - response entity type.responseType - Java type the response entity will be converted to.public <T> T trace(GenericType<T> responseType)
SyncInvokertrace in interface SyncInvokerT - generic response entity type.responseType - representation of a generic Java type the response
entity will be converted to.public Response method(String name)
SyncInvokermethod in interface SyncInvokername - method name.public <T> T method(String name, Class<T> responseType)
SyncInvokermethod in interface SyncInvokerT - response entity type.name - method name.responseType - Java type the response entity will be converted to.public <T> T method(String name, GenericType<T> responseType)
SyncInvokermethod in interface SyncInvokerT - generic response entity type.name - method name.responseType - representation of a generic Java type the response
entity will be converted to.public Response method(String name, Entity<?> entity)
SyncInvokermethod in interface SyncInvokername - method name.entity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.public <T> T method(String name, Entity<?> entity, Class<T> responseType)
SyncInvokermethod in interface SyncInvokerT - response entity type.name - method name.entity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.responseType - Java type the response entity will be converted to.public <T> T method(String name, Entity<?> entity, GenericType<T> responseType)
SyncInvokermethod in interface SyncInvokerT - generic response entity type.name - method name.entity - request entity, including it's full Variant information.
Any variant-related HTTP headers previously set (namely Content-Type,
Content-Language and Content-Encoding) will be overwritten using
the entity variant information.responseType - representation of a generic Java type the response
entity will be converted to.public Invocation.Builder property(String name, Object value)
Invocation.Builder
The property is available for a later retrieval via ClientRequestContext.getProperty(String)
or InterceptorContext.getProperty(String).
If a property with a given name is already set in the request context,
the existing value of the property will be updated.
Setting a null value into a property effectively removes the property
from the request property bag.
property in interface Invocation.Buildername - property name.value - (new) property value. null value removes the property
with the given name.Invocation.property(String, Object)public boolean isChunked()
public void setChunked(boolean chunked)
public CompletionStageRxInvoker rx()
Invocation.BuilderCompletionStage.rx in interface Invocation.BuilderInvocation.Builder.rx(Class)public <T extends RxInvoker> T rx(Class<T> clazz)
Invocation.BuilderRxInvoker subclass provider. Note
that corresponding RxInvokerProvider must be registered in the client runtime.
This method is an extension point for JAX-RS implementations to support other types representing asynchronous computations.
rx in interface Invocation.Builderclazz - RxInvoker subclass.Configurable.register(Class)public <T> T patch(Entity<?> entity, GenericType<T> responseType)
public URI getURI()
public WebTarget getTarget()
public void setTarget(WebTarget target)
Copyright © 2019 JBoss by Red Hat. All rights reserved.