be.wegenenverkeer.rxhttp

Class RxHttpClient

java.lang.Object

be.wegenenverkeer.rxhttp.RxHttpClient

public class RxHttpClient
extends java.lang.Object

A Reactive HTTP Client Created by Karel Maesen, Geovise BVBA on 05/12/14.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RxHttpClient.Builder A Builder for RxHttpClient builders.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RxHttpClient(com.ning.http.client.AsyncHttpClient innerClient, be.wegenenverkeer.rxhttp.RxHttpClient.RestClientConfig config)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying connection
<F> java.util.concurrent.CompletableFuture<F>	execute(ClientRequest request, java.util.function.Function<ServerResponse,F> transformer) Executes a request and returns an Observable for the complete response.
rx.Observable<ServerResponseElement>	executeObservably(ClientRequest request) Returns a "cold" Observable for a stream of ServerResponseElements.
<F> rx.Observable<F>	executeObservably(ClientRequest request, java.util.function.Function<byte[],F> transform) Returns a "cold" Observable for a stream of T.
<F> rx.Observable<F>	executeToCompletion(ClientRequest request, java.util.function.Function<ServerResponse,F> transformer) Executes a request and returns an Observable for the complete response.
java.lang.String	getAccept() Returns the configured default ACCEPT header for requests created using this instance's ClientRequestBuilders.
java.lang.String	getBaseUrl() Returns the base URL that this client connects to.
ClientRequestBuilder	requestBuilder() Returns a new ClientRequestBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

RxHttpClient

protected RxHttpClient(com.ning.http.client.AsyncHttpClient innerClient,
                       be.wegenenverkeer.rxhttp.RxHttpClient.RestClientConfig config)

Method Detail

execute

public <F> java.util.concurrent.CompletableFuture<F> execute(ClientRequest request,
                                                             java.util.function.Function<ServerResponse,F> transformer)

Executes a request and returns an Observable for the complete response.

executeToCompletion

public <F> rx.Observable<F> executeToCompletion(ClientRequest request,
                                                java.util.function.Function<ServerResponse,F> transformer)

Executes a request and returns an Observable for the complete response.

When available, the complete response will be presented to any subscriber. Only one HTTP request will be made, regardless of the number of subscribers.

Type Parameters:

F - the type of return value

Parameters:

request - the request to send

transformer - a function that transforms the ServerResponse to a value of F

Returns:

An Observable that returns the transformed server response.

executeObservably

public rx.Observable<ServerResponseElement> executeObservably(ClientRequest request)

Returns a "cold" Observable for a stream of ServerResponseElements.

The returned Observable is "deferred", i.e. on each subscription a new HTTP request is made and the response elements returned as a new Observable. So for each subscriber, a separate HTTP request will be made.

Parameters:

request - the request to send

Returns:

a cold observable of ServerResponseElements

See Also:

Observable.defer(rx.functions.Func0<rx.Observable<T>>)

executeObservably

public <F> rx.Observable<F> executeObservably(ClientRequest request,
                                              java.util.function.Function<byte[],F> transform)

Returns a "cold" Observable for a stream of T.

The returned Observable is "deferred", i.e. on each subscription a new HTTP request is made and the response elements returned as a new Observable. So for each subscriber, a separate HTTP request will be made.

Type Parameters:

F - return type of the transform

Parameters:

request - the request to send

transform - the function that transforms the response body (chunks) into objects of type F

Returns:

a cold observable of ServerResponseElements

See Also:

Observable.defer(rx.functions.Func0<rx.Observable<T>>)

getBaseUrl

public java.lang.String getBaseUrl()

Returns the base URL that this client connects to.

Returns:

the base URL that this client connects to.

getAccept

public java.lang.String getAccept()

Returns the configured default ACCEPT header for requests created using this instance's ClientRequestBuilders.

Returns:

the configured default ACCEPT header for requests created using this instance's ClientRequestBuilders.

close

public void close()

Closes the underlying connection

requestBuilder

public ClientRequestBuilder requestBuilder()

Returns a new ClientRequestBuilder.

Returns:

a new ClientRequestBuilder.