org.glassfish.jersey.client.rx

Interface RxInvocationBuilder<RX extends RxInvoker>

Type Parameters:

RX - the concrete reactive invocation type.

All Superinterfaces:

javax.ws.rs.client.Invocation.Builder, javax.ws.rs.client.SyncInvoker

public interface RxInvocationBuilder<RX extends RxInvoker>
extends javax.ws.rs.client.Invocation.Builder

A reactive client request invocation builder.

The builder is enhanced with two methods in addition to the invocation builder from JAX-RS, rx() and rx(java.util.concurrent.ExecutorService), giving access to reactive invoker that provide means to invoke reactive client requests.

Since:

2.13

Author:

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

See Also:

Invocation.Builder, RxInvoker

Method Summary

Modifier and Type	Method and Description
RxInvocationBuilder<RX>	accept(javax.ws.rs.core.MediaType... mediaTypes)
RxInvocationBuilder<RX>	accept(String... mediaTypes)
RxInvocationBuilder<RX>	acceptEncoding(String... encodings)
RxInvocationBuilder<RX>	acceptLanguage(Locale... locales)
RxInvocationBuilder<RX>	acceptLanguage(String... locales)
RxInvocationBuilder<RX>	cacheControl(javax.ws.rs.core.CacheControl cacheControl)
RxInvocationBuilder<RX>	cookie(javax.ws.rs.core.Cookie cookie)
RxInvocationBuilder<RX>	cookie(String name, String value)
RxInvocationBuilder<RX>	header(String name, Object value)
RxInvocationBuilder<RX>	headers(javax.ws.rs.core.MultivaluedMap<String,Object> headers)
RxInvocationBuilder<RX>	property(String name, Object value)
RX	rx() Access the reactive request invocation interface to invoke the built request.
RX	rx(ExecutorService executorService) Access the reactive request invocation interface to invoke the built request on a given executor service.

Methods inherited from interface javax.ws.rs.client.Invocation.Builder

async, build, build, buildDelete, buildGet, buildPost, buildPut

Methods inherited from interface javax.ws.rs.client.SyncInvoker

delete, delete, delete, get, get, get, head, method, method, method, method, method, method, options, options, options, post, post, post, put, put, put, trace, trace, trace

Method Detail

rx

RX rx()

Access the reactive request invocation interface to invoke the built request.

Returns:

reactive request invocation interface or null if a invoker for a given type cannot be created.

rx

RX rx(ExecutorService executorService)

Access the reactive request invocation interface to invoke the built request on a given executor service.

Parameters:

executorService - the executor service to execute current reactive request.

Returns:

reactive request invocation interface or null if a invoker for a given type cannot be created.

accept

RxInvocationBuilder<RX> accept(String... mediaTypes)

Specified by:

accept in interface javax.ws.rs.client.Invocation.Builder

accept

RxInvocationBuilder<RX> accept(javax.ws.rs.core.MediaType... mediaTypes)

Specified by:

accept in interface javax.ws.rs.client.Invocation.Builder

acceptLanguage

RxInvocationBuilder<RX> acceptLanguage(Locale... locales)

Specified by:

acceptLanguage in interface javax.ws.rs.client.Invocation.Builder

acceptLanguage

RxInvocationBuilder<RX> acceptLanguage(String... locales)

Specified by:

acceptLanguage in interface javax.ws.rs.client.Invocation.Builder

acceptEncoding

RxInvocationBuilder<RX> acceptEncoding(String... encodings)

Specified by:

acceptEncoding in interface javax.ws.rs.client.Invocation.Builder

cookie

RxInvocationBuilder<RX> cookie(javax.ws.rs.core.Cookie cookie)

Specified by:

cookie in interface javax.ws.rs.client.Invocation.Builder

cookie

RxInvocationBuilder<RX> cookie(String name,
                               String value)

Specified by:

cookie in interface javax.ws.rs.client.Invocation.Builder

cacheControl

RxInvocationBuilder<RX> cacheControl(javax.ws.rs.core.CacheControl cacheControl)

Specified by:

cacheControl in interface javax.ws.rs.client.Invocation.Builder

header

RxInvocationBuilder<RX> header(String name,
                               Object value)

Specified by:

header in interface javax.ws.rs.client.Invocation.Builder

headers

RxInvocationBuilder<RX> headers(javax.ws.rs.core.MultivaluedMap<String,Object> headers)

Specified by:

headers in interface javax.ws.rs.client.Invocation.Builder

property

RxInvocationBuilder<RX> property(String name,
                                 Object value)

Specified by:

property in interface javax.ws.rs.client.Invocation.Builder