org.springframework.web.reactive.function

Class BodyInserters

java.lang.Object

org.springframework.web.reactive.function.BodyInserters

public abstract class BodyInserters
extends Object

Implementations of BodyInserter that write various bodies, such a reactive streams, server-sent events, resources, etc.

Since:

5.0

Author:

Arjen Poutsma

Constructor Summary

Constructors

Constructor and Description
BodyInserters()

Method Summary

Modifier and Type	Method and Description
static <T> BodyInserter<T>	fromObject(T body) Return a BodyInserter that writes the given single object.
static <S extends org.reactivestreams.Publisher<T>,T> BodyInserter<S>	fromPublisher(S publisher, Class<T> elementClass) Return a BodyInserter that writes the given Publisher.
static <S extends org.reactivestreams.Publisher<T>,T> BodyInserter<S>	fromPublisher(S publisher, org.springframework.core.ResolvableType elementType) Return a BodyInserter that writes the given Publisher.
static <T extends org.springframework.core.io.Resource> BodyInserter<T>	fromResource(T resource) Return a BodyInserter that writes the given Resource.
static <T,S extends org.reactivestreams.Publisher<org.springframework.http.codec.ServerSentEvent<T>>> BodyInserter<S>	fromServerSentEvents(S eventsPublisher) Return a BodyInserter that writes the given ServerSentEvent publisher.
static <T,S extends org.reactivestreams.Publisher<T>> BodyInserter<S>	fromServerSentEvents(S eventsPublisher, Class<T> eventClass) Return a BodyInserter that writes the given Publisher publisher as Server-Sent Events.
static <T,S extends org.reactivestreams.Publisher<T>> BodyInserter<S>	fromServerSentEvents(S eventsPublisher, org.springframework.core.ResolvableType eventType) Return a BodyInserter that writes the given Publisher publisher as Server-Sent Events.

Methods inherited from class java.lang.Object

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

Constructor Detail

BodyInserters

public BodyInserters()

Method Detail

fromObject

public static <T> BodyInserter<T> fromObject(T body)

Return a BodyInserter that writes the given single object.

Parameters:

body - the body of the response

Returns:

a BodyInserter that writes a single object

fromPublisher

public static <S extends org.reactivestreams.Publisher<T>,T> BodyInserter<S> fromPublisher(S publisher,
                                                                                           Class<T> elementClass)

Return a BodyInserter that writes the given Publisher.

Type Parameters:

T - the type of the elements contained in the publisher

S - the type of the Publisher.

Parameters:

publisher - the publisher to stream to the response body

elementClass - the class of elements contained in the publisher

Returns:

a BodyInserter that writes a Publisher

fromPublisher

public static <S extends org.reactivestreams.Publisher<T>,T> BodyInserter<S> fromPublisher(S publisher,
                                                                                           org.springframework.core.ResolvableType elementType)

Return a BodyInserter that writes the given Publisher.

Type Parameters:

T - the type of the elements contained in the publisher

S - the type of the Publisher.

Parameters:

publisher - the publisher to stream to the response body

elementType - the type of elements contained in the publisher

Returns:

a BodyInserter that writes a Publisher

fromResource

public static <T extends org.springframework.core.io.Resource> BodyInserter<T> fromResource(T resource)

Return a BodyInserter that writes the given Resource. If the resource can be resolved to a file, it will be copied using zero-copy

Type Parameters:

T - the type of the Resource

Parameters:

resource - the resource to write to the response

Returns:

a BodyInserter that writes a Publisher

fromServerSentEvents

public static <T,S extends org.reactivestreams.Publisher<org.springframework.http.codec.ServerSentEvent<T>>> BodyInserter<S> fromServerSentEvents(S eventsPublisher)

Return a BodyInserter that writes the given ServerSentEvent publisher.

Type Parameters:

T - the type of the elements contained in the ServerSentEvent

Parameters:

eventsPublisher - the ServerSentEvent publisher to write to the response body

Returns:

a BodyInserter that writes a ServerSentEvent publisher

See Also:

Server-Sent Events W3C recommendation

fromServerSentEvents

public static <T,S extends org.reactivestreams.Publisher<T>> BodyInserter<S> fromServerSentEvents(S eventsPublisher,
                                                                                                  Class<T> eventClass)

Return a BodyInserter that writes the given Publisher publisher as Server-Sent Events.

Type Parameters:

T - the type of the elements contained in the publisher

Parameters:

eventsPublisher - the publisher to write to the response body as Server-Sent Events

eventClass - the class of event contained in the publisher

Returns:

a BodyInserter that writes the given Publisher publisher as Server-Sent Events

See Also:

Server-Sent Events W3C recommendation

fromServerSentEvents

public static <T,S extends org.reactivestreams.Publisher<T>> BodyInserter<S> fromServerSentEvents(S eventsPublisher,
                                                                                                  org.springframework.core.ResolvableType eventType)

Return a BodyInserter that writes the given Publisher publisher as Server-Sent Events.

Type Parameters:

T - the type of the elements contained in the publisher

Parameters:

eventsPublisher - the publisher to write to the response body as Server-Sent Events

eventType - the type of event contained in the publisher

Returns:

a BodyInserter that writes the given Publisher publisher as Server-Sent Events

See Also:

Server-Sent Events W3C recommendation