io.micronaut.rxjava3.http.client

Interface Rx3HttpClient

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, io.micronaut.http.client.HttpClient, io.micronaut.context.LifeCycle<io.micronaut.http.client.HttpClient>

All Known Subinterfaces:

Rx3StreamingHttpClient

public interface Rx3HttpClient
extends io.micronaut.http.client.HttpClient

RxJava 3 variation of the HttpClient interface.

Since:

1.0.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 Rx3HttpClient	create(java.net.URL url) Create a new Rx3HttpClient.
static Rx3HttpClient	create(java.net.URL url, io.micronaut.http.client.HttpClientConfiguration configuration) Create a new Rx3HttpClient with the specified configuration.
default <I> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<io.micronaut.core.io.buffer.ByteBuffer>>	exchange(io.micronaut.http.HttpRequest<I> request)
default <I,O> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<O>>	exchange(io.micronaut.http.HttpRequest<I> request, io.micronaut.core.type.Argument<O> bodyType)
<I,O,E> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<O>>	exchange(io.micronaut.http.HttpRequest<I> request, io.micronaut.core.type.Argument<O> bodyType, io.micronaut.core.type.Argument<E> errorType)
default <I,O> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<O>>	exchange(io.micronaut.http.HttpRequest<I> request, java.lang.Class<O> bodyType)
default io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<io.micronaut.core.io.buffer.ByteBuffer>>	exchange(java.lang.String uri)
default <O> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<O>>	exchange(java.lang.String uri, java.lang.Class<O> bodyType)
default <I> io.reactivex.rxjava3.core.Flowable<java.lang.String>	retrieve(io.micronaut.http.HttpRequest<I> request)
default <I,O> io.reactivex.rxjava3.core.Flowable<O>	retrieve(io.micronaut.http.HttpRequest<I> request, io.micronaut.core.type.Argument<O> bodyType)
default <I,O,E> io.reactivex.rxjava3.core.Flowable<O>	retrieve(io.micronaut.http.HttpRequest<I> request, io.micronaut.core.type.Argument<O> bodyType, io.micronaut.core.type.Argument<E> errorType)
default <I,O> io.reactivex.rxjava3.core.Flowable<O>	retrieve(io.micronaut.http.HttpRequest<I> request, java.lang.Class<O> bodyType)
default io.reactivex.rxjava3.core.Flowable<java.lang.String>	retrieve(java.lang.String uri)

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

refresh, toBlocking

Methods inherited from interface io.micronaut.context.LifeCycle

close, isRunning, start, stop

Method Detail

exchange

default <I,O> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<O>> exchange(@NonNull
                                                                                             io.micronaut.http.HttpRequest<I> request,
                                                                                             @NonNull
                                                                                             io.micronaut.core.type.Argument<O> bodyType)

Specified by:

exchange in interface io.micronaut.http.client.HttpClient

exchange

<I,O,E> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<O>> exchange(@NonNull
                                                                                       io.micronaut.http.HttpRequest<I> request,
                                                                                       @NonNull
                                                                                       io.micronaut.core.type.Argument<O> bodyType,
                                                                                       @NonNull
                                                                                       io.micronaut.core.type.Argument<E> errorType)

Specified by:

exchange in interface io.micronaut.http.client.HttpClient

retrieve

default <I,O,E> io.reactivex.rxjava3.core.Flowable<O> retrieve(@NonNull
                                                               io.micronaut.http.HttpRequest<I> request,
                                                               @NonNull
                                                               io.micronaut.core.type.Argument<O> bodyType,
                                                               @NonNull
                                                               io.micronaut.core.type.Argument<E> errorType)

Specified by:

retrieve in interface io.micronaut.http.client.HttpClient

exchange

default <I> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<io.micronaut.core.io.buffer.ByteBuffer>> exchange(@NonNull
                                                                                                                                io.micronaut.http.HttpRequest<I> request)

Specified by:

exchange in interface io.micronaut.http.client.HttpClient

exchange

default io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<io.micronaut.core.io.buffer.ByteBuffer>> exchange(@NonNull
                                                                                                                            java.lang.String uri)

Specified by:

exchange in interface io.micronaut.http.client.HttpClient

exchange

default <O> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<O>> exchange(@NonNull
                                                                                           java.lang.String uri,
                                                                                           @NonNull
                                                                                           java.lang.Class<O> bodyType)

Specified by:

exchange in interface io.micronaut.http.client.HttpClient

exchange

default <I,O> io.reactivex.rxjava3.core.Flowable<io.micronaut.http.HttpResponse<O>> exchange(@NonNull
                                                                                             io.micronaut.http.HttpRequest<I> request,
                                                                                             @NonNull
                                                                                             java.lang.Class<O> bodyType)

Specified by:

exchange in interface io.micronaut.http.client.HttpClient

retrieve

default <I,O> io.reactivex.rxjava3.core.Flowable<O> retrieve(@NonNull
                                                             io.micronaut.http.HttpRequest<I> request,
                                                             @NonNull
                                                             io.micronaut.core.type.Argument<O> bodyType)

Specified by:

retrieve in interface io.micronaut.http.client.HttpClient

retrieve

default <I,O> io.reactivex.rxjava3.core.Flowable<O> retrieve(@NonNull
                                                             io.micronaut.http.HttpRequest<I> request,
                                                             @NonNull
                                                             java.lang.Class<O> bodyType)

Specified by:

retrieve in interface io.micronaut.http.client.HttpClient

retrieve

default <I> io.reactivex.rxjava3.core.Flowable<java.lang.String> retrieve(@NonNull
                                                                          io.micronaut.http.HttpRequest<I> request)

Specified by:

retrieve in interface io.micronaut.http.client.HttpClient

retrieve

default io.reactivex.rxjava3.core.Flowable<java.lang.String> retrieve(@NonNull
                                                                      java.lang.String uri)

Specified by:

retrieve in interface io.micronaut.http.client.HttpClient

create

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

Create a new Rx3HttpClient. Note that this method should only be used outside of the context of a Micronaut application. The returned Rx3HttpClient is not subject to dependency injection. The creator is responsible for closing the client to avoid leaking connections. Within a Micronaut application use Inject to inject a client instead.

Specified by:

create in interface io.micronaut.http.client.HttpClient

Parameters:

url - The base URL

Returns:

The client

Since:

2.1.0

create

static Rx3HttpClient create(@Nullable
                            java.net.URL url,
                            @NonNull
                            io.micronaut.http.client.HttpClientConfiguration configuration)

Create a new Rx3HttpClient with the specified configuration. 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 io.micronaut.http.client.HttpClient

Parameters:

url - The base URL

configuration - the client configuration

Returns:

The client

Since:

2.1.0