io.micronaut.http.client

Interface RxHttpClient

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, HttpClient, LifeCycle<HttpClient>

All Known Subinterfaces:

RxStreamingHttpClient

All Known Implementing Classes:

DefaultHttpClient

public interface RxHttpClient
extends HttpClient

Extended version of HttpClient that exposes an RxJava 2.x specific interface.

Since:

1.0

Author:

graemerocher

Field Summary

Fields inherited from interface io.micronaut.http.client.HttpClient

DEFAULT_ERROR_TYPE

Method Summary

Modifier and Type	Method and Description
static RxHttpClient	create(java.net.URL url) Create a new HttpClient.
default <I> io.reactivex.Flowable<HttpResponse<ByteBuffer>>	exchange(HttpRequest<I> request) Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher.
default <I,O> io.reactivex.Flowable<HttpResponse<O>>	exchange(HttpRequest<I> request, Argument<O> bodyType) Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.
<I,O,E> io.reactivex.Flowable<HttpResponse<O>>	exchange(HttpRequest<I> request, Argument<O> bodyType, Argument<E> errorType) Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.
default <I,O> io.reactivex.Flowable<HttpResponse<O>>	exchange(HttpRequest<I> request, java.lang.Class<O> bodyType) Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.
default io.reactivex.Flowable<HttpResponse<ByteBuffer>>	exchange(java.lang.String uri) Perform an HTTP GET request for the given request object emitting the full HTTP response from returned Publisher.
default <O> io.reactivex.Flowable<HttpResponse<O>>	exchange(java.lang.String uri, java.lang.Class<O> bodyType) Perform an HTTP GET request for the given request object emitting the full HTTP response from returned Publisher.
default <I> io.reactivex.Flowable<java.lang.String>	retrieve(HttpRequest<I> request) Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.
default <I,O> io.reactivex.Flowable<O>	retrieve(HttpRequest<I> request, Argument<O> bodyType) Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.
default <I,O,E> io.reactivex.Flowable<O>	retrieve(HttpRequest<I> request, Argument<O> bodyType, Argument<E> errorType) Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.
default <I,O> io.reactivex.Flowable<O>	retrieve(HttpRequest<I> request, java.lang.Class<O> bodyType) Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.
default io.reactivex.Flowable<java.lang.String>	retrieve(java.lang.String uri) Perform an HTTP GET request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.

Methods inherited from interface io.micronaut.http.client.HttpClient

create, refresh, toBlocking

Methods inherited from interface io.micronaut.context.LifeCycle

close, isRunning, start, stop

Method Detail

exchange

default <I,O> io.reactivex.Flowable<HttpResponse<O>> exchange(HttpRequest<I> request,
                                                              Argument<O> bodyType)

Description copied from interface: HttpClient

Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.

This method will send a Content-Length header and except a content length header the response and is designed for simple non-streaming exchanges of data

By default the exchange Content-Type is application/json, unless otherwise specified in the passed HttpRequest

Specified by:

exchange in interface HttpClient

Type Parameters:

I - The request body type

O - The response body type

Parameters:

request - The HttpRequest to execute

bodyType - The body type

Returns:

A Publisher that emits the full HttpResponse object

exchange

<I,O,E> io.reactivex.Flowable<HttpResponse<O>> exchange(HttpRequest<I> request,
                                                        Argument<O> bodyType,
                                                        Argument<E> errorType)

Description copied from interface: HttpClient

Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.

This method will send a Content-Length header and except a content length header the response and is designed for simple non-streaming exchanges of data

By default the exchange Content-Type is application/json, unless otherwise specified in the passed HttpRequest

Specified by:

exchange in interface HttpClient

Type Parameters:

I - The request body type

O - The response body type

E - The error type

Parameters:

request - The HttpRequest to execute

bodyType - The body type

errorType - The error type

Returns:

A Publisher that emits the full HttpResponse object

retrieve

default <I,O,E> io.reactivex.Flowable<O> retrieve(HttpRequest<I> request,
                                                  Argument<O> bodyType,
                                                  Argument<E> errorType)

Description copied from interface: HttpClient

Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.

Specified by:

retrieve in interface HttpClient

Type Parameters:

I - The request body type

O - The response body type

E - The error type

Parameters:

request - The HttpRequest to execute

bodyType - The body type

errorType - The error type

Returns:

A Publisher that emits a result of the given type

exchange

default <I> io.reactivex.Flowable<HttpResponse<ByteBuffer>> exchange(HttpRequest<I> request)

Description copied from interface: HttpClient

Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher.

Specified by:

exchange in interface HttpClient

Type Parameters:

I - The request body type

Parameters:

request - The HttpRequest to execute

Returns:

A Publisher that emits the full HttpResponse object

exchange

default io.reactivex.Flowable<HttpResponse<ByteBuffer>> exchange(java.lang.String uri)

Description copied from interface: HttpClient

Perform an HTTP GET request for the given request object emitting the full HTTP response from returned Publisher.

Specified by:

exchange in interface HttpClient

Parameters:

uri - The Uri

Returns:

A Publisher that emits the full HttpResponse object

exchange

default <O> io.reactivex.Flowable<HttpResponse<O>> exchange(java.lang.String uri,
                                                            java.lang.Class<O> bodyType)

Description copied from interface: HttpClient

Perform an HTTP GET request for the given request object emitting the full HTTP response from returned Publisher.

Specified by:

exchange in interface HttpClient

Type Parameters:

O - The response body type

Parameters:

uri - The request URI

bodyType - The body type

Returns:

A Publisher that emits the full HttpResponse object

exchange

default <I,O> io.reactivex.Flowable<HttpResponse<O>> exchange(HttpRequest<I> request,
                                                              java.lang.Class<O> bodyType)

Description copied from interface: HttpClient

Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.

Specified by:

exchange in interface HttpClient

Type Parameters:

I - The request body type

O - The response body type

Parameters:

request - The HttpRequest to execute

bodyType - The body type

Returns:

A Publisher that emits the full HttpResponse object

retrieve

default <I,O> io.reactivex.Flowable<O> retrieve(HttpRequest<I> request,
                                                Argument<O> bodyType)

Description copied from interface: HttpClient

Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.

Specified by:

retrieve in interface HttpClient

Type Parameters:

I - The request body type

O - The response body type

Parameters:

request - The HttpRequest to execute

bodyType - The body type

Returns:

A Publisher that emits a result of the given type

retrieve

default <I,O> io.reactivex.Flowable<O> retrieve(HttpRequest<I> request,
                                                java.lang.Class<O> bodyType)

Description copied from interface: HttpClient

Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.

Specified by:

retrieve in interface HttpClient

Type Parameters:

I - The request body type

O - The response body type

Parameters:

request - The HttpRequest to execute

bodyType - The body type

Returns:

A Publisher that emits a result of the given type

retrieve

default <I> io.reactivex.Flowable<java.lang.String> retrieve(HttpRequest<I> request)

Description copied from interface: HttpClient

Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.

Specified by:

retrieve in interface HttpClient

Type Parameters:

I - The request body type

Parameters:

request - The HttpRequest to execute

Returns:

A Publisher that emits String result

retrieve

default io.reactivex.Flowable<java.lang.String> retrieve(java.lang.String uri)

Description copied from interface: HttpClient

Perform an HTTP GET request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.

Specified by:

retrieve in interface HttpClient

Parameters:

uri - The URI

Returns:

A Publisher that emits String result

create

static RxHttpClient create(@Nullable
                           java.net.URL url)

Create a new HttpClient. Note that this method should only be used outside of the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

create in interface HttpClient

Parameters:

url - The base URL

Returns:

The client