org.glassfish.jersey.client.rx

Interface RxInvoker<T>

Type Parameters:

T - the asynchronous/event-based completion aware type. The given type should be parametrized with the actual response type.

All Known Implementing Classes:

AbstractRxInvoker

@Beta
public interface RxInvoker<T>

Uniform interface for reactive invocation of HTTP methods.

The RxInvoker is intended to be extended and not used directly to preserve type safety. Extensions are supposed to override all methods present in this interface specifying the actual return types. For example, reactive invoker providing support for CompletionStage from Java 8 the overridden methods should look like:

 @Override
 public CompletionStage get();

 @Override
 public <T> CompletionStage get(Class<T> responseType);

Instances of RxInvoker extensions are created using the RxInvokerProvider SPI contract.

Since:

2.13

Author:

Michal Gajdos (michal.gajdos at oracle.com), Marek Potociar (marek.potociar at oracle.com)

See Also:

SyncInvoker, RxInvokerProvider

Method Summary

Modifier and Type	Method and Description
T	delete() Invoke HTTP DELETE method for the current request.
<R> T	delete(Class<R> responseType) Invoke HTTP DELETE method for the current request.
<R> T	delete(javax.ws.rs.core.GenericType<R> responseType) Invoke HTTP DELETE method for the current request.
T	get() Invoke HTTP GET method for the current request.
<R> T	get(Class<R> responseType) Invoke HTTP GET method for the current request.
<R> T	get(javax.ws.rs.core.GenericType<R> responseType) Invoke HTTP GET method for the current request.
T	head() Invoke HTTP HEAD method for the current request.
T	method(String name) Invoke an arbitrary method for the current request.
<R> T	method(String name, Class<R> responseType) Invoke an arbitrary method for the current request.
T	method(String name, javax.ws.rs.client.Entity<?> entity) Invoke an arbitrary method for the current request.
<R> T	method(String name, javax.ws.rs.client.Entity<?> entity, Class<R> responseType) Invoke an arbitrary method for the current request.
<R> T	method(String name, javax.ws.rs.client.Entity<?> entity, javax.ws.rs.core.GenericType<R> responseType) Invoke an arbitrary method for the current request.
<R> T	method(String name, javax.ws.rs.core.GenericType<R> responseType) Invoke an arbitrary method for the current request.
T	options() Invoke HTTP OPTIONS method for the current request.
<R> T	options(Class<R> responseType) Invoke HTTP OPTIONS method for the current request.
<R> T	options(javax.ws.rs.core.GenericType<R> responseType) Invoke HTTP OPTIONS method for the current request.
T	post(javax.ws.rs.client.Entity<?> entity) Invoke HTTP POST method for the current request.
<R> T	post(javax.ws.rs.client.Entity<?> entity, Class<R> responseType) Invoke HTTP POST method for the current request.
<R> T	post(javax.ws.rs.client.Entity<?> entity, javax.ws.rs.core.GenericType<R> responseType) Invoke HTTP POST method for the current request.
T	put(javax.ws.rs.client.Entity<?> entity) Invoke HTTP PUT method for the current request.
<R> T	put(javax.ws.rs.client.Entity<?> entity, Class<R> responseType) Invoke HTTP PUT method for the current request.
<R> T	put(javax.ws.rs.client.Entity<?> entity, javax.ws.rs.core.GenericType<R> responseType) Invoke HTTP PUT method for the current request.
T	trace() Invoke HTTP TRACE method for the current request.
<R> T	trace(Class<R> responseType) Invoke HTTP OPTIONS method for the current request.
<R> T	trace(javax.ws.rs.core.GenericType<R> responseType) Invoke HTTP TRACE method for the current request.

Method Detail

get

T get()

Invoke HTTP GET method for the current request.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

get

<R> T get(Class<R> responseType)

Invoke HTTP GET method for the current request.

Type Parameters:

R - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

<R> T get(javax.ws.rs.core.GenericType<R> responseType)

Invoke HTTP GET method for the current request.

Type Parameters:

R - generic response entity type.

Parameters:

responseType - representation of a generic Java type the response entity will be converted to.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

T put(javax.ws.rs.client.Entity<?> entity)

Invoke HTTP PUT method for the current request.

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 wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

put

<R> T put(javax.ws.rs.client.Entity<?> entity,
          Class<R> responseType)

Invoke HTTP PUT method for the current request.

Type Parameters:

R - 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 wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

<R> T put(javax.ws.rs.client.Entity<?> entity,
          javax.ws.rs.core.GenericType<R> responseType)

Invoke HTTP PUT method for the current request.

Type Parameters:

R - 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 wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

T post(javax.ws.rs.client.Entity<?> entity)

Invoke HTTP POST method for the current request.

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 wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

post

<R> T post(javax.ws.rs.client.Entity<?> entity,
           Class<R> responseType)

Invoke HTTP POST method for the current request.

Type Parameters:

R - 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 wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

<R> T post(javax.ws.rs.client.Entity<?> entity,
           javax.ws.rs.core.GenericType<R> responseType)

Invoke HTTP POST method for the current request.

Type Parameters:

R - 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 wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

T delete()

Invoke HTTP DELETE method for the current request.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

delete

<R> T delete(Class<R> responseType)

Invoke HTTP DELETE method for the current request.

Type Parameters:

R - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

<R> T delete(javax.ws.rs.core.GenericType<R> responseType)

Invoke HTTP DELETE method for the current request.

Type Parameters:

R - generic response entity type.

Parameters:

responseType - representation of a generic Java type the response entity will be converted to.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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.

head

T head()

Invoke HTTP HEAD method for the current request.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

options

T options()

Invoke HTTP OPTIONS method for the current request.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

options

<R> T options(Class<R> responseType)

Invoke HTTP OPTIONS method for the current request.

Type Parameters:

R - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

<R> T options(javax.ws.rs.core.GenericType<R> responseType)

Invoke HTTP OPTIONS method for the current request.

Type Parameters:

R - generic response entity type.

Parameters:

responseType - representation of a generic Java type the response entity will be converted to.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

T trace()

Invoke HTTP TRACE method for the current request.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

trace

<R> T trace(Class<R> responseType)

Invoke HTTP OPTIONS method for the current request.

Type Parameters:

R - response entity type.

Parameters:

responseType - Java type the response entity will be converted to.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

<R> T trace(javax.ws.rs.core.GenericType<R> responseType)

Invoke HTTP TRACE method for the current request.

Type Parameters:

R - generic response entity type.

Parameters:

responseType - representation of a generic Java type the response entity will be converted to.

Returns:

invocation response wrapped in the completion aware type.

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

T method(String name)

Invoke an arbitrary method for the current request.

Parameters:

name - method name.

Returns:

invocation response wrapped in the completion aware type..

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

method

<R> T method(String name,
             Class<R> responseType)

Invoke an arbitrary method for the current request.

Type Parameters:

R - response entity type.

Parameters:

name - method name.

responseType - Java type the response entity will be converted to.

Returns:

invocation response wrapped in the completion aware type..

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

<R> T method(String name,
             javax.ws.rs.core.GenericType<R> responseType)

Invoke an arbitrary method for the current request.

Type Parameters:

R - 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 wrapped in the completion aware type..

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

T method(String name,
         javax.ws.rs.client.Entity<?> entity)

Invoke an arbitrary method for the current request.

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 wrapped in the completion aware type..

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

method

<R> T method(String name,
             javax.ws.rs.client.Entity<?> entity,
             Class<R> responseType)

Invoke an arbitrary method for the current request.

Type Parameters:

R - 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 wrapped in the completion aware type..

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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

<R> T method(String name,
             javax.ws.rs.client.Entity<?> entity,
             javax.ws.rs.core.GenericType<R> responseType)

Invoke an arbitrary method for the current request.

Type Parameters:

R - 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 wrapped in the completion aware type..

Throws:

javax.ws.rs.client.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).

javax.ws.rs.ProcessingException - in case the request processing or subsequent I/O operation fails.

javax.ws.rs.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.