JerseyInvocation.Builder (Jersey 3.0.15 API)

java.lang.Object
- org.glassfish.jersey.client.JerseyInvocation.Builder

All Implemented Interfaces:

Invocation.Builder, SyncInvoker

Enclosing class:

JerseyInvocation
```
public static class JerseyInvocation.Builder
extends Object
implements Invocation.Builder
```
Jersey-specific client invocation builder.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Builder(URI uri, ClientConfig configuration)
Create new Jersey-specific client invocation builder.

Constructors
Modifier	Constructor and Description
`protected`	`Builder(URI uri, ClientConfig configuration)` Create new Jersey-specific client invocation builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JerseyInvocation.Builder`	`accept(MediaType... mediaTypes)` Add the accepted response media types.
`JerseyInvocation.Builder`	`accept(String... mediaTypes)` Add the accepted response media types.
`Invocation.Builder`	`acceptEncoding(String... encodings)` Add acceptable encodings.
`JerseyInvocation.Builder`	`acceptLanguage(Locale... locales)` Add acceptable languages.
`JerseyInvocation.Builder`	`acceptLanguage(String... locales)` Add acceptable languages.
`AsyncInvoker`	`async()` Access the asynchronous uniform request invocation interface to asynchronously invoke the built request.
`JerseyInvocation`	`build(String method)` Build a request invocation using an arbitrary request method name.
`JerseyInvocation`	`build(String method, Entity<?> entity)` Build a request invocation using an arbitrary request method name and request entity.
`JerseyInvocation`	`buildDelete()` Build a DELETE request invocation.
`JerseyInvocation`	`buildGet()` Build a GET request invocation.
`JerseyInvocation`	`buildPost(Entity<?> entity)` Build a POST request invocation.
`JerseyInvocation`	`buildPut(Entity<?> entity)` Build a PUT request invocation.
`JerseyInvocation.Builder`	`cacheControl(CacheControl cacheControl)` Set the cache control data of the message.
`JerseyInvocation.Builder`	`cookie(Cookie cookie)` Add a cookie to be set.
`JerseyInvocation.Builder`	`cookie(String name, String value)` Add a cookie to be set.
`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.
`Response`	`head()` Invoke HTTP HEAD method for the current request synchronously.
`JerseyInvocation.Builder`	`header(String name, Object value)` Add an arbitrary header.
`JerseyInvocation.Builder`	`headers(MultivaluedMap<String,Object> headers)` Replaces all existing headers with the newly supplied headers.
`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`	`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.
`JerseyInvocation.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> T`	`rx(Class<T> clazz)` Access a reactive invoker based on a `RxInvoker` subclass provider.
`JerseyInvocation.Builder`	`setCancellable(Future cancellable)` Sets Future that backs `ClientRequest` `ClientRequest.isCancelled()` method.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
protected Builder(URI uri,
                  ClientConfig configuration)
```
    Create new Jersey-specific client invocation builder.
    
    Parameters:
    
    uri - invoked request URI.
    
    configuration - Jersey client configuration.
- Method Detail
  - build
```
public JerseyInvocation build(String method)
```
    Description copied from interface: Invocation.Builder
    
    Build a request invocation using an arbitrary request method name.
    
    Specified by:
    
    build in interface Invocation.Builder
    
    Parameters:
    
    method - request method name.
    
    Returns:
    
    invocation encapsulating the built request.
  - build
```
public JerseyInvocation build(String method,
                              Entity<?> entity)
```
    Description copied from interface: Invocation.Builder
    
    Build a request invocation using an arbitrary request method name and request entity.
    
    Specified by:
    
    build in interface Invocation.Builder
    
    Parameters:
    
    method - 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.
    
    Returns:
    
    invocation encapsulating the built request.
  - buildGet
```
public JerseyInvocation buildGet()
```
    Description copied from interface: Invocation.Builder
    
    Build a GET request invocation.
    
    Specified by:
    
    buildGet in interface Invocation.Builder
    
    Returns:
    
    invocation encapsulating the built GET request.
  - buildDelete
```
public JerseyInvocation buildDelete()
```
    Description copied from interface: Invocation.Builder
    
    Build a DELETE request invocation.
    
    Specified by:
    
    buildDelete in interface Invocation.Builder
    
    Returns:
    
    invocation encapsulating the built DELETE request.
  - buildPost
```
public JerseyInvocation buildPost(Entity<?> entity)
```
    Description copied from interface: Invocation.Builder
    
    Build a POST request invocation.
    
    Specified by:
    
    buildPost in interface Invocation.Builder
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation encapsulating the built POST request.
  - buildPut
```
public JerseyInvocation buildPut(Entity<?> entity)
```
    Description copied from interface: Invocation.Builder
    
    Build a PUT request invocation.
    
    Specified by:
    
    buildPut in interface Invocation.Builder
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation encapsulating the built PUT request.
  - async
```
public AsyncInvoker async()
```
    Description copied from interface: Invocation.Builder
    
    Access the asynchronous uniform request invocation interface to asynchronously invoke the built request.
    
    Specified by:
    
    async in interface Invocation.Builder
    
    Returns:
    
    asynchronous uniform request invocation interface.
  - accept
```
public JerseyInvocation.Builder accept(String... mediaTypes)
```
    Description copied from interface: Invocation.Builder
    
    Add the accepted response media types.
    
    Specified by:
    
    accept in interface Invocation.Builder
    
    Parameters:
    
    mediaTypes - accepted response media types.
    
    Returns:
    
    the updated builder.
  - accept
```
public JerseyInvocation.Builder accept(MediaType... mediaTypes)
```
    Description copied from interface: Invocation.Builder
    
    Add the accepted response media types.
    
    Specified by:
    
    accept in interface Invocation.Builder
    
    Parameters:
    
    mediaTypes - accepted response media types.
    
    Returns:
    
    the updated builder.
  - acceptEncoding
```
public Invocation.Builder acceptEncoding(String... encodings)
```
    Description copied from interface: Invocation.Builder
    
    Add acceptable encodings.
    
    Specified by:
    
    acceptEncoding in interface Invocation.Builder
    
    Parameters:
    
    encodings - an array of the acceptable encodings.
    
    Returns:
    
    the updated builder.
  - acceptLanguage
```
public JerseyInvocation.Builder acceptLanguage(Locale... locales)
```
    Description copied from interface: Invocation.Builder
    
    Add acceptable languages.
    
    Specified by:
    
    acceptLanguage in interface Invocation.Builder
    
    Parameters:
    
    locales - an array of the acceptable languages.
    
    Returns:
    
    the updated builder.
  - acceptLanguage
```
public JerseyInvocation.Builder acceptLanguage(String... locales)
```
    Description copied from interface: Invocation.Builder
    
    Add acceptable languages.
    
    Specified by:
    
    acceptLanguage in interface Invocation.Builder
    
    Parameters:
    
    locales - an array of the acceptable languages.
    
    Returns:
    
    the updated builder.
  - cookie
```
public JerseyInvocation.Builder cookie(Cookie cookie)
```
    Description copied from interface: Invocation.Builder
    
    Add a cookie to be set.
    
    Specified by:
    
    cookie in interface Invocation.Builder
    
    Parameters:
    
    cookie - to be set.
    
    Returns:
    
    the updated builder.
  - cookie
```
public JerseyInvocation.Builder cookie(String name,
                                       String value)
```
    Description copied from interface: Invocation.Builder
    
    Add a cookie to be set.
    
    Specified by:
    
    cookie in interface Invocation.Builder
    
    Parameters:
    
    name - the name of the cookie.
    
    value - the value of the cookie.
    
    Returns:
    
    the updated builder.
  - cacheControl
```
public JerseyInvocation.Builder cacheControl(CacheControl cacheControl)
```
    Description copied from interface: Invocation.Builder
    
    Set the cache control data of the message.
    
    Specified by:
    
    cacheControl in interface Invocation.Builder
    
    Parameters:
    
    cacheControl - the cache control directives, if null any existing cache control directives will be removed.
    
    Returns:
    
    the updated builder.
  - header
```
public JerseyInvocation.Builder header(String name,
                                       Object value)
```
    Description copied from interface: Invocation.Builder
    
    Add an arbitrary header.
    
    Specified by:
    
    header in interface Invocation.Builder
    
    Parameters:
    
    name - the name of the header
    
    value - 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.
    
    Returns:
    
    the updated builder.
  - headers
```
public JerseyInvocation.Builder headers(MultivaluedMap<String,Object> headers)
```
    Description copied from interface: Invocation.Builder
    
    Replaces all existing headers with the newly supplied headers.
    
    Specified by:
    
    headers in interface Invocation.Builder
    
    Parameters:
    
    headers - new headers to be set, if null all existing headers will be removed.
    
    Returns:
    
    the updated builder.
  - get
```
public Response get()
             throws ProcessingException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP GET method for the current request synchronously.
    
    Specified by:
    
    get in interface SyncInvoker
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ProcessingException - in case the invocation processing has failed.
  - get
```
public <T> T get(Class<T> responseType)
          throws ProcessingException,
                 WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP GET method for the current request synchronously.
    
    Specified by:
    
    get in interface SyncInvoker
    
    Type Parameters:
    
    T - response entity type.
    
    Parameters:
    
    responseType - Java type the response entity will be converted to.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified response type is not Response.
  - get
```
public <T> T get(GenericType<T> responseType)
          throws ProcessingException,
                 WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP GET method for the current request synchronously.
    
    Specified by:
    
    get in interface SyncInvoker
    
    Type Parameters:
    
    T - generic response entity type.
    
    Parameters:
    
    responseType - representation of a generic Java type the response entity will be converted to.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified generic response type does not represent Response
  - put
```
public Response put(Entity<?> entity)
             throws ProcessingException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP PUT method for the current request synchronously.
    
    Specified by:
    
    put in interface SyncInvoker
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
  - put
```
public <T> T put(Entity<?> entity,
                 Class<T> responseType)
          throws ProcessingException,
                 WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP PUT method for the current request synchronously.
    
    Specified by:
    
    put in interface SyncInvoker
    
    Type Parameters:
    
    T - response entity type.
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified response type is not Response.
  - put
```
public <T> T put(Entity<?> entity,
                 GenericType<T> responseType)
          throws ProcessingException,
                 WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP PUT method for the current request synchronously.
    
    Specified by:
    
    put in interface SyncInvoker
    
    Type Parameters:
    
    T - generic response entity type.
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified generic response type does not represent Response.
  - post
```
public Response post(Entity<?> entity)
              throws ProcessingException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP POST method for the current request synchronously.
    
    Specified by:
    
    post in interface SyncInvoker
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
  - post
```
public <T> T post(Entity<?> entity,
                  Class<T> responseType)
           throws ProcessingException,
                  WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP POST method for the current request synchronously.
    
    Specified by:
    
    post in interface SyncInvoker
    
    Type Parameters:
    
    T - response entity type.
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified response type is not Response.
  - post
```
public <T> T post(Entity<?> entity,
                  GenericType<T> responseType)
           throws ProcessingException,
                  WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP POST method for the current request synchronously.
    
    Specified by:
    
    post in interface SyncInvoker
    
    Type Parameters:
    
    T - generic response entity type.
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified generic response type does not represent Response.
  - delete
```
public Response delete()
                throws ProcessingException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP DELETE method for the current request synchronously.
    
    Specified by:
    
    delete in interface SyncInvoker
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
  - delete
```
public <T> T delete(Class<T> responseType)
             throws ProcessingException,
                    WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP DELETE method for the current request synchronously.
    
    Specified by:
    
    delete in interface SyncInvoker
    
    Type Parameters:
    
    T - response entity type.
    
    Parameters:
    
    responseType - Java type the response entity will be converted to.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified response type is not Response.
  - delete
```
public <T> T delete(GenericType<T> responseType)
             throws ProcessingException,
                    WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP DELETE method for the current request synchronously.
    
    Specified by:
    
    delete in interface SyncInvoker
    
    Type Parameters:
    
    T - generic response entity type.
    
    Parameters:
    
    responseType - representation of a generic Java type the response entity will be converted to.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified generic response type does not represent Response.
  - head
```
public Response head()
              throws ProcessingException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP HEAD method for the current request synchronously.
    
    Specified by:
    
    head in interface SyncInvoker
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
  - options
```
public Response options()
                 throws ProcessingException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP OPTIONS method for the current request synchronously.
    
    Specified by:
    
    options in interface SyncInvoker
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
  - options
```
public <T> T options(Class<T> responseType)
              throws ProcessingException,
                     WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP OPTIONS method for the current request synchronously.
    
    Specified by:
    
    options in interface SyncInvoker
    
    Type Parameters:
    
    T - response entity type.
    
    Parameters:
    
    responseType - Java type the response entity will be converted to.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified response type is not Response.
  - options
```
public <T> T options(GenericType<T> responseType)
              throws ProcessingException,
                     WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP OPTIONS method for the current request synchronously.
    
    Specified by:
    
    options in interface SyncInvoker
    
    Type Parameters:
    
    T - generic response entity type.
    
    Parameters:
    
    responseType - representation of a generic Java type the response entity will be converted to.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified generic response type does not represent Response.
  - trace
```
public Response trace()
               throws ProcessingException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP TRACE method for the current request synchronously.
    
    Specified by:
    
    trace in interface SyncInvoker
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
  - trace
```
public <T> T trace(Class<T> responseType)
            throws ProcessingException,
                   WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP TRACE method for the current request synchronously.
    
    Specified by:
    
    trace in interface SyncInvoker
    
    Type Parameters:
    
    T - response entity type.
    
    Parameters:
    
    responseType - Java type the response entity will be converted to.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified response type is not Response.
  - trace
```
public <T> T trace(GenericType<T> responseType)
            throws ProcessingException,
                   WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke HTTP TRACE method for the current request synchronously.
    
    Specified by:
    
    trace in interface SyncInvoker
    
    Type Parameters:
    
    T - generic response entity type.
    
    Parameters:
    
    responseType - representation of a generic Java type the response entity will be converted to.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified generic response type does not represent Response.
  - method
```
public Response method(String name)
                throws ProcessingException
```
    Description copied from interface: SyncInvoker
    
    Invoke an arbitrary method for the current request synchronously.
    
    Specified by:
    
    method in interface SyncInvoker
    
    Parameters:
    
    name - method name.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
  - method
```
public <T> T method(String name,
                    Class<T> responseType)
             throws ProcessingException,
                    WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke an arbitrary method for the current request synchronously.
    
    Specified by:
    
    method in interface SyncInvoker
    
    Type Parameters:
    
    T - response entity type.
    
    Parameters:
    
    name - method name.
    
    responseType - Java type the response entity will be converted to.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified response type is not Response.
  - method
```
public <T> T method(String name,
                    GenericType<T> responseType)
             throws ProcessingException,
                    WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke an arbitrary method for the current request synchronously.
    
    Specified by:
    
    method in interface SyncInvoker
    
    Type Parameters:
    
    T - generic response entity type.
    
    Parameters:
    
    name - method name.
    
    responseType - representation of a generic Java type the response entity will be converted to.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified generic response type does not represent Response.
  - method
```
public Response method(String name,
                       Entity<?> entity)
                throws ProcessingException
```
    Description copied from interface: SyncInvoker
    
    Invoke an arbitrary method for the current request synchronously.
    
    Specified by:
    
    method in interface SyncInvoker
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
  - method
```
public <T> T method(String name,
                    Entity<?> entity,
                    Class<T> responseType)
             throws ProcessingException,
                    WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke an arbitrary method for the current request synchronously.
    
    Specified by:
    
    method in interface SyncInvoker
    
    Type Parameters:
    
    T - response entity type.
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified response type is not Response.
  - method
```
public <T> T method(String name,
                    Entity<?> entity,
                    GenericType<T> responseType)
             throws ProcessingException,
                    WebApplicationException
```
    Description copied from interface: SyncInvoker
    
    Invoke an arbitrary method for the current request synchronously.
    
    Specified by:
    
    method in interface SyncInvoker
    
    Type Parameters:
    
    T - generic response entity type.
    
    Parameters:
    
    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.
    
    Returns:
    
    invocation response.
    
    Throws:
    
    ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during conversion of the response entity data to an instance of a particular Java type).
    
    ProcessingException - in case the request processing or subsequent I/O operation fails.
    
    WebApplicationException - in case the response status code of the response returned by the server is not successful and the specified generic response type does not represent Response.
  - property
```
public JerseyInvocation.Builder property(String name,
                                         Object value)
```
    Description copied from interface: Invocation.Builder
    
    Set a new property in the context of a request represented by this 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.
    
    Specified by:
    
    property in interface Invocation.Builder
    
    Parameters:
    
    name - property name.
    
    value - (new) property value. null value removes the property with the given name.
    
    Returns:
    
    the updated builder.
    
    See Also:
    
    Invocation.property(String, Object)
  - rx
```
public CompletionStageRxInvoker rx()
```
    Description copied from interface: Invocation.Builder
    
    Access the default reactive invoker based on CompletionStage.
    
    Specified by:
    
    rx in interface Invocation.Builder
    
    Returns:
    
    default reactive invoker instance.
    
    See Also:
    
    Invocation.Builder.rx(Class)
  - rx
```
public <T extends RxInvoker> T rx(Class<T> clazz)
```
    Description copied from interface: Invocation.Builder
    
    Access a reactive invoker based on a RxInvoker 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.
    
    Specified by:
    
    rx in interface Invocation.Builder
    
    Type Parameters:
    
    T - generic invoker type.
    
    Parameters:
    
    clazz - RxInvoker subclass.
    
    Returns:
    
    reactive invoker instance.
    
    See Also:
    
    Configurable.register(Class)
  - setCancellable
```
public JerseyInvocation.Builder setCancellable(Future cancellable)
```
    Sets Future that backs ClientRequest ClientRequest.isCancelled() method. Can be used for instance by CompletionStageRxInvoker to pass the created CompletableFuture to the provided SyncInvoker.
    
    Parameters:
    
    cancellable - the Future whose result of Future.cancel(boolean) will be available by ClientRequest.isCancelled().
    
    Returns:
    
    the updated builder.

Class JerseyInvocation.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

build

buildGet

buildDelete

buildPost

buildPut

async

accept

accept

acceptEncoding

acceptLanguage

acceptLanguage

cookie

cookie

cacheControl

header

headers

get

get

get

put

put

put

post

post

post

delete

delete

delete

head

options

options

options

trace

trace

trace

method

method

method

method

method

method

property

rx

rx

setCancellable