org.everit.http.restclient

Class RestClient

java.lang.Object

org.everit.http.restclient.RestClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class RestClient
extends Object
implements Closeable

Calls REST endpoints.

Constructor Summary

Constructors

Constructor and Description
RestClient(org.everit.http.client.HttpClient httpClient, JSONObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	callEndpoint(RestRequest restRequest, Optional<RestRequestEnhancer> requestEnhancer) Calls a rest endpoint asynchronously where there is no response body.
<T> io.reactivex.Single<T>	callEndpoint(RestRequest restRequest, Optional<RestRequestEnhancer> requestEnhancer, TypeReference<T> returnType) Calls a rest endpoint asynchronously.
void	close()
JSONObjectMapper	getObjectMapper()

Methods inherited from class java.lang.Object

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

Constructor Detail

RestClient

public RestClient(org.everit.http.client.HttpClient httpClient,
                  JSONObjectMapper objectMapper)

Method Detail

callEndpoint

public io.reactivex.Completable callEndpoint(RestRequest restRequest,
                                             Optional<RestRequestEnhancer> requestEnhancer)

Calls a rest endpoint asynchronously where there is no response body.

Parameters:

restRequest - The request that is used to call the endpoint.

requestEnhancer - If specified, it is used to enhance the rest request before sending it.

Returns:

An asynchronous instance that is notified when the response without a body has arrived back.

callEndpoint

public <T> io.reactivex.Single<T> callEndpoint(RestRequest restRequest,
                                               Optional<RestRequestEnhancer> requestEnhancer,
                                               TypeReference<T> returnType)

Calls a rest endpoint asynchronously.

Type Parameters:

T - Type of the response body.

Parameters:

restRequest - The request that is used to call the endpoint.

requestEnhancer - If specified, it is used to enhance the rest request before sending it.

returnType - Type of the response body, Jackson is used to convert it from JSON to a typed java object.

Returns:

An asynchronous object that is notified when the response is processed to the return type.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getObjectMapper

public JSONObjectMapper getObjectMapper()