cloud.orbit.rest.async

Class RestClient

java.lang.Object

cloud.orbit.rest.async.RestClient

public class RestClient
extends Object

Utility class to create proxies for JAX-RS client interfaces.

This class is thread safe and immutable.

Author:

Daniel Sperry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestClient.RestInvocationCallback<T>

Constructor Summary

Constructors

Constructor and Description
RestClient(String basePath)
RestClient(javax.ws.rs.client.WebTarget webTarget) Constructs an orbit rest client from a jax-rs WebTarget.
RestClient(javax.ws.rs.client.WebTarget target, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers)

Method Summary

Modifier and Type	Method and Description
<T extends RestClient> T	addHeader(String key, String value) Returns a new OrbitRestClient with where with an extra header
protected CompletableFuture<Object>	createFuture(Method method)
<T> T	get(Class<T> interfaceClass) Returns an implementation of a jax-rs interface.
javax.ws.rs.core.MultivaluedMap<String,Object>	getHeaders() Returns a copy of the headers.
protected Object	handleInvokeException(Throwable e)
protected <T extends RestClient> T	newClient(javax.ws.rs.client.WebTarget target, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers)
<T extends RestClient> T	property(String propertyName, Object propertyValue) Builds a new Rest Client with a WebTarget that applies the specified property.
protected static <TThrowable extends Throwable,TResult> TResult	reThrow(Throwable throwable) Allows Rest Clients to filter exceptions that may arises from invoked calls.
<T extends RestClient> T	setHeader(String key, String value) Returns a new OrbitRestClient with the header key replaced/set
<T extends RestClient> T	setHeaders(javax.ws.rs.core.MultivaluedMap<String,Object> headers) Returns a new orbit rest client replacing all the headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestClient

public RestClient(String basePath)

RestClient

public RestClient(javax.ws.rs.client.WebTarget webTarget)

Constructs an orbit rest client from a jax-rs WebTarget.

Parameters:

webTarget - a jax-rx target, can be obtained with a jax-rs implementation, for instance org.glassfish.jersey.core:jersey-clien.

RestClient

public RestClient(javax.ws.rs.client.WebTarget target,
                  javax.ws.rs.core.MultivaluedHashMap<String,Object> headers)

Method Detail

getHeaders

public javax.ws.rs.core.MultivaluedMap<String,Object> getHeaders()

Returns a copy of the headers.

setHeaders

public <T extends RestClient> T setHeaders(javax.ws.rs.core.MultivaluedMap<String,Object> headers)

Returns a new orbit rest client replacing all the headers

setHeader

public <T extends RestClient> T setHeader(String key,
                                          String value)

Returns a new OrbitRestClient with the header key replaced/set

addHeader

public <T extends RestClient> T addHeader(String key,
                                          String value)

Returns a new OrbitRestClient with where with an extra header

newClient

protected <T extends RestClient> T newClient(javax.ws.rs.client.WebTarget target,
                                             javax.ws.rs.core.MultivaluedHashMap<String,Object> headers)

get

public <T> T get(Class<T> interfaceClass)

Returns an implementation of a jax-rs interface.

The methods will issue remote calls to the web target provided on the OrbitRestClient constructor.

The there are other implementation of rest proxies. The special benefit of OrbitRestClient is that the interface method can return CompletableFuture or cloud.orbit.concurrent.Task If that is the case, those methods will return immediately and the Future will be completed asynchronously.

Type Parameters:

T - The interface type

Parameters:

interfaceClass - the jax-rs annotated interface class

Returns:

an implementation of the interface that will make remote rest calls

reThrow

protected static <TThrowable extends Throwable,TResult> TResult reThrow(Throwable throwable)
                                                                 throws TThrowable extends Throwable

Allows Rest Clients to filter exceptions that may arises from invoked calls.

Type Parameters:

TThrowable - The Throwable type that will be returned

TResult - The actual type returned

Parameters:

throwable - The exception that was encountered

Returns:

The filtered exception

Throws:

TThrowable

TThrowable extends Throwable

handleInvokeException

protected Object handleInvokeException(Throwable e)

createFuture

protected CompletableFuture<Object> createFuture(Method method)

property

public <T extends RestClient> T property(String propertyName,
                                         Object propertyValue)

Builds a new Rest Client with a WebTarget that applies the specified property.

Type Parameters:

T - Rest Client

Parameters:

propertyName - Property to set a value on

propertyValue - Value to apply

Returns:

new Rest Client with applied change