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,ReactiveHttpOutputMessage>	empty() Return an empty BodyInserter that writes nothing.
static <T extends org.reactivestreams.Publisher<DataBuffer>> BodyInserter<T,ReactiveHttpOutputMessage>	fromDataBuffers(T publisher) Return a BodyInserter that writes the given Publisher<DataBuffer> to the body.
static BodyInserter<MultiValueMap<String,String>,ClientHttpRequest>	fromFormData(MultiValueMap<String,String> formData) Return a BodyInserter that writes the given MultiValueMap as URL-encoded form data.
static BodyInserter<MultiValueMap<String,?>,ClientHttpRequest>	fromMultipartData(MultiValueMap<String,?> multipartData) Return a BodyInserter that writes the given MultiValueMap as Multipart data.
static <T> BodyInserter<T,ReactiveHttpOutputMessage>	fromObject(T body) Return a BodyInserter that writes the given single object.
static <T,P extends org.reactivestreams.Publisher<T>> BodyInserter<P,ReactiveHttpOutputMessage>	fromPublisher(P publisher, Class<T> elementClass) Return a BodyInserter that writes the given Publisher.
static <T,P extends org.reactivestreams.Publisher<T>> BodyInserter<P,ReactiveHttpOutputMessage>	fromPublisher(P publisher, ParameterizedTypeReference<T> typeReference) Return a BodyInserter that writes the given Publisher.
static <T extends Resource> BodyInserter<T,ReactiveHttpOutputMessage>	fromResource(T resource) Return a BodyInserter that writes the given Resource.
static <T,S extends org.reactivestreams.Publisher<ServerSentEvent<T>>> BodyInserter<S,ServerHttpResponse>	fromServerSentEvents(S eventsPublisher) Return a BodyInserter that writes the given ServerSentEvent publisher.

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

empty

public static <T> BodyInserter<T,ReactiveHttpOutputMessage> empty()

Return an empty BodyInserter that writes nothing.

Returns:

an empty BodyInserter

fromObject

public static <T> BodyInserter<T,ReactiveHttpOutputMessage> 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 <T,P extends org.reactivestreams.Publisher<T>> BodyInserter<P,ReactiveHttpOutputMessage> fromPublisher(P publisher,
                                                                                                                     Class<T> elementClass)

Return a BodyInserter that writes the given Publisher.

Type Parameters:

T - the type of the elements contained in the publisher

P - 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 <T,P extends org.reactivestreams.Publisher<T>> BodyInserter<P,ReactiveHttpOutputMessage> fromPublisher(P publisher,
                                                                                                                     ParameterizedTypeReference<T> typeReference)

Return a BodyInserter that writes the given Publisher.

Type Parameters:

T - the type of the elements contained in the publisher

P - the type of the Publisher

Parameters:

publisher - the publisher to stream to the response body

typeReference - the type of elements contained in the publisher

Returns:

a BodyInserter that writes a Publisher

fromResource

public static <T extends Resource> BodyInserter<T,ReactiveHttpOutputMessage> 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 output message

Returns:

a BodyInserter that writes a Publisher

fromServerSentEvents

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

Return a BodyInserter that writes the given ServerSentEvent publisher.

Note that a SSE BodyInserter can also be obtained by passing a stream of strings or POJOs (to be encoded as JSON) to fromPublisher(Publisher, Class), and specifying a text/event-stream Content-Type.

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

fromFormData

public static BodyInserter<MultiValueMap<String,String>,ClientHttpRequest> fromFormData(MultiValueMap<String,String> formData)

Return a BodyInserter that writes the given MultiValueMap as URL-encoded form data.

Parameters:

formData - the form data to write to the output message

Returns:

a BodyInserter that writes form data

fromMultipartData

public static BodyInserter<MultiValueMap<String,?>,ClientHttpRequest> fromMultipartData(MultiValueMap<String,?> multipartData)

Return a BodyInserter that writes the given MultiValueMap as Multipart data.

Parameters:

multipartData - the form data to write to the output message

Returns:

a BodyInserter that writes form data

fromDataBuffers

public static <T extends org.reactivestreams.Publisher<DataBuffer>> BodyInserter<T,ReactiveHttpOutputMessage> fromDataBuffers(T publisher)

Return a BodyInserter that writes the given Publisher<DataBuffer> to the body.

Type Parameters:

T - the type of the publisher

Parameters:

publisher - the data buffer publisher to write

Returns:

a BodyInserter that writes directly to the body

See Also:

ReactiveHttpOutputMessage.writeWith(Publisher)