org.zalando.riptide.stream

Class Streams

java.lang.Object

org.zalando.riptide.stream.Streams

public final class Streams
extends Object

Main entry point for Riptide Streams extension to capture arbitrary infinite object streams. It allows to receive infinite streams using application/x-json-stream and application/json-seq format, as well as simple finite streams from lists and arrays. The feature must be enabled by registering the StreamConverter with Riptide (using streamConverter()) and declare a route for your stream that is calling a the stream consumer as follows:

 try (Rest rest = Rest.builder().baseUrl("https://api.github.com").converter(streamConverter()).build()) {
     rest.get("/repos/{org}/{repo}/contributors", "zalando", "riptide")
             .accept(MediaType.APPLICATION_JSON)
             .dispatch(series(),
                     on(SUCCESSFUL).call(streamOf(User.class),
                             forEach(user -> println(user.login + " (" + user.contributions + ")"))))
             .get();
 }
 

Note: The stream converter is an replacement to the default spring JSON converter that does not support streaming, and thus should be not registered together with it.

Field Summary

Fields

Modifier and Type	Field and Description
static org.springframework.http.MediaType	APPLICATION_JSON_SEQ Default singleton media type for application/json-seq.
static org.springframework.http.MediaType	APPLICATION_X_JSON_STREAM Default singleton media type for application/x-json-stream.

Constructor Summary

Constructors

Constructor and Description
Streams()

Method Summary

Modifier and Type	Method and Description
static <I,X extends Throwable> org.zalando.fauxpas.ThrowingConsumer<Stream<I>,X>	forEach(org.zalando.fauxpas.ThrowingConsumer<I,X> consumer) Creates stream consumer for given element consumer.
static org.springframework.http.converter.HttpMessageConverter<?>	streamConverter() Create default stream converter.
static org.springframework.http.converter.HttpMessageConverter<?>	streamConverter(com.fasterxml.jackson.databind.ObjectMapper mapper) Create stream converter with custom {@link ObjectMapper object mapper).
static org.springframework.http.converter.HttpMessageConverter<?>	streamConverter(com.fasterxml.jackson.databind.ObjectMapper mapper, List<org.springframework.http.MediaType> medias) Create stream converter with custom ObjectMapper object mapper), and custom list of {@link MediaType media types}.
static <T> com.google.common.reflect.TypeToken<Stream<T>>	streamOf(Class<T> type) Creates specialized stream type token for the given element class type.
static <T> com.google.common.reflect.TypeToken<Stream<T>>	streamOf(com.google.common.reflect.TypeToken<T> type) Creates specialized stream type token for the given element type token.

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_X_JSON_STREAM

public static final org.springframework.http.MediaType APPLICATION_X_JSON_STREAM

Default singleton media type for application/x-json-stream.

APPLICATION_JSON_SEQ

public static final org.springframework.http.MediaType APPLICATION_JSON_SEQ

Default singleton media type for application/json-seq.

Constructor Detail

Streams

public Streams()

Method Detail

streamOf

public static <T> com.google.common.reflect.TypeToken<Stream<T>> streamOf(Class<T> type)

Creates specialized stream type token for the given element class type. Used to declare the expected stream response type token in Riptide route as follows:

     on(...).call(streamOf(Result.class),...)
 

Parameters:

type - element class type.

Returns:

stream token type.

streamOf

public static <T> com.google.common.reflect.TypeToken<Stream<T>> streamOf(com.google.common.reflect.TypeToken<T> type)

Creates specialized stream type token for the given element type token. Used to declare the expected stream response type token in Riptide route as follows:

     on(...).call(streamOf(resultTypeToken),...)
 

Parameters:

type - element token type.

Returns:

stream token type.

forEach

public static <I,X extends Throwable> org.zalando.fauxpas.ThrowingConsumer<Stream<I>,X> forEach(org.zalando.fauxpas.ThrowingConsumer<I,X> consumer)

Creates stream consumer for given element consumer. Used to standardly wrap a single entity consumer function in a stream consumer function as follows:

     on(...).call(streamOf(...), forEach(element -> { println(element); }))
 

Parameters:

consumer - element consumer function.

Returns:

stream consumer function.

streamConverter

public static org.springframework.http.converter.HttpMessageConverter<?> streamConverter()

Create default stream converter.

Returns:

default stream converter.

streamConverter

public static org.springframework.http.converter.HttpMessageConverter<?> streamConverter(com.fasterxml.jackson.databind.ObjectMapper mapper)

Create stream converter with custom {@link ObjectMapper object mapper).

Parameters:

mapper - custom object mapper.

Returns:

stream converter with customer object mapper.

streamConverter

public static org.springframework.http.converter.HttpMessageConverter<?> streamConverter(com.fasterxml.jackson.databind.ObjectMapper mapper,
                                                                                         List<org.springframework.http.MediaType> medias)

Create stream converter with custom ObjectMapper object mapper), and custom list of {@link MediaType media types}.

Parameters:

mapper - custom object mapper.

medias - custom list of media types.

Returns:

stream converter with customer object mapper.