io.micronaut.http.client

Interface StreamingHttpClient

All Superinterfaces:

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

All Known Implementing Classes:

DefaultHttpClient

public interface StreamingHttpClient
extends HttpClient

Extended version of the HttpClient that supports streaming responses.

Since:

1.0

Author:

Graeme Rocher

Field Summary

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

DEFAULT_ERROR_TYPE

Method Summary

Modifier and Type	Method and Description
static StreamingHttpClient	create(java.net.URL url) Create a new StreamingHttpClient.
static StreamingHttpClient	create(java.net.URL url, HttpClientConfiguration configuration) Create a new StreamingHttpClient with the specified configuration.
<I> org.reactivestreams.Publisher<ByteBuffer<?>>	dataStream(HttpRequest<I> request) Request a stream of data where each emitted item is a ByteBuffer instance.
<I> org.reactivestreams.Publisher<HttpResponse<ByteBuffer<?>>>	exchangeStream(HttpRequest<I> request) Requests a stream data where each emitted item is a ByteBuffer wrapped in the HttpResponse object (which remains the same for each emitted item).
<I> org.reactivestreams.Publisher<java.util.Map<java.lang.String,java.lang.Object>>	jsonStream(HttpRequest<I> request) Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
<I,O> org.reactivestreams.Publisher<O>	jsonStream(HttpRequest<I> request, Argument<O> type) Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
default <I,O> org.reactivestreams.Publisher<O>	jsonStream(HttpRequest<I> request, java.lang.Class<O> type) Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

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

exchange, exchange, exchange, exchange, exchange, exchange, refresh, retrieve, retrieve, retrieve, retrieve, retrieve, toBlocking

Methods inherited from interface io.micronaut.context.LifeCycle

close, isRunning, start, stop

Method Detail

dataStream

<I> org.reactivestreams.Publisher<ByteBuffer<?>> dataStream(HttpRequest<I> request)

Request a stream of data where each emitted item is a ByteBuffer instance.

Type Parameters:

I - The request body type

Parameters:

request - The request

Returns:

A Publisher that emits a stream of ByteBuffer instances

exchangeStream

<I> org.reactivestreams.Publisher<HttpResponse<ByteBuffer<?>>> exchangeStream(HttpRequest<I> request)

Requests a stream data where each emitted item is a ByteBuffer wrapped in the HttpResponse object (which remains the same for each emitted item).

Type Parameters:

I - The request body type

Parameters:

request - The HttpRequest

Returns:

A Publisher that emits a stream of ByteBuffer instances wrapped by a HttpResponse

jsonStream

<I> org.reactivestreams.Publisher<java.util.Map<java.lang.String,java.lang.Object>> jsonStream(HttpRequest<I> request)

Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription

Type Parameters:

I - The request body type

Parameters:

request - The HttpRequest to execute

Returns:

A Publisher that emits the full HttpResponse object

jsonStream

<I,O> org.reactivestreams.Publisher<O> jsonStream(HttpRequest<I> request,
                                                  Argument<O> type)

Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription. Incoming data is buffered.

Type Parameters:

I - The request body type

O - The response type

Parameters:

request - The HttpRequest to execute

type - The type of object to convert the JSON into

Returns:

A Publisher that emits the full HttpResponse object

jsonStream

default <I,O> org.reactivestreams.Publisher<O> jsonStream(HttpRequest<I> request,
                                                          java.lang.Class<O> type)

Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription

Type Parameters:

I - The request body type

O - The response type

Parameters:

request - The HttpRequest to execute

type - The type of object to convert the JSON into

Returns:

A Publisher that emits the full HttpResponse object

create

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

Create a new StreamingHttpClient. Note that this method should only be used outside of the context of a Micronaut application. The returned StreamingHttpClient 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 HttpClient

Parameters:

url - The base URL

Returns:

The client

create

static StreamingHttpClient create(@Nullable
                                  java.net.URL url,
                                  HttpClientConfiguration configuration)

Create a new StreamingHttpClient 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 HttpClient

Parameters:

url - The base URL

configuration - the client configuration

Returns:

The client

Since:

2.2.0