org.zalando.riptide.stream

Class Streams

java.lang.Object

org.zalando.riptide.stream.Streams

@API(status=STABLE)
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(ObjectMapper) and declare a route for your stream that is calling a the stream consumer as follows:

 try (Http http = Http.builder().baseUrl("https://api.github.com").converter(streamConverter()).build()) {
     http.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
static org.springframework.http.MediaType	APPLICATION_STREAM_JSON
static org.springframework.http.MediaType	APPLICATION_X_JSON_STREAM

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 <T> org.zalando.riptide.stream.StreamConverter<T>	streamConverter() Create default stream converter.
static <T> org.zalando.riptide.stream.StreamConverter<T>	streamConverter(com.fasterxml.jackson.databind.ObjectMapper mapper) Create stream converter with custom object mapper.
static <T> org.zalando.riptide.stream.StreamConverter<T>	streamConverter(com.fasterxml.jackson.databind.ObjectMapper mapper, List<org.springframework.http.MediaType> supportedMediaTypes) Create stream converter with custom object mapper, and custom list of supported 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_JSON_SEQ

public static final org.springframework.http.MediaType APPLICATION_JSON_SEQ

APPLICATION_STREAM_JSON

public static final org.springframework.http.MediaType APPLICATION_STREAM_JSON

APPLICATION_X_JSON_STREAM

public static final org.springframework.http.MediaType APPLICATION_X_JSON_STREAM

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),...)
 

Type Parameters:

T - generic stream element type

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 org.zalando.riptide.Route route} as follows:

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

Type Parameters:

T - generic stream element type

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. Commonly used to wrap a single entity consumer function in a stream consumer function as follows:

     on(...).call(streamOf(...), forEach(System.out::println))
 

Type Parameters:

I - generic stream element type

X - generic exception type

Parameters:

consumer - element consumer function.

Returns:

stream consumer function.

streamConverter

public static <T> org.zalando.riptide.stream.StreamConverter<T> streamConverter()

Create default stream converter.

Type Parameters:

T - generic stream element type

Returns:

default stream converter.

streamConverter

public static <T> org.zalando.riptide.stream.StreamConverter<T> streamConverter(com.fasterxml.jackson.databind.ObjectMapper mapper)

Create stream converter with custom object mapper.

Type Parameters:

T - generic stream element type

Parameters:

mapper - custom object mapper.

Returns:

stream converter with customer object mapper.

streamConverter

public static <T> org.zalando.riptide.stream.StreamConverter<T> streamConverter(com.fasterxml.jackson.databind.ObjectMapper mapper,
                                                                                List<org.springframework.http.MediaType> supportedMediaTypes)

Create stream converter with custom object mapper, and custom list of supported media types.

Type Parameters:

T - generic stream element type

Parameters:

mapper - custom object mapper.

supportedMediaTypes - custom list of media types.

Returns:

stream converter with customer object mapper.