org.springframework.web.reactive.function

Class BodyInserters

java.lang.Object

org.springframework.web.reactive.function.BodyInserters

public abstract class BodyInserters
extends java.lang.Object

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

Since:

5.0

Author:

Arjen Poutsma

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BodyInserters.FormInserter<T> Sub-interface of BodyInserter that allows for additional (multipart) form data to be added.
static interface	BodyInserters.MultipartInserter Extension of BodyInserters.FormInserter that has methods for adding asynchronous part data.

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 BodyInserters.FormInserter<java.lang.String>	fromFormData(MultiValueMap<java.lang.String,java.lang.String> formData) Return a BodyInserters.FormInserter that writes the given MultiValueMap as URL-encoded form data.
static BodyInserters.FormInserter<java.lang.String>	fromFormData(java.lang.String key, java.lang.String value) Return a BodyInserters.FormInserter that writes the given key-value pair as URL-encoded form data.
static <T,P extends org.reactivestreams.Publisher<T>> BodyInserters.MultipartInserter	fromMultipartAsyncData(java.lang.String key, P publisher, java.lang.Class<T> elementClass) A variant of fromMultipartData(MultiValueMap) for adding asynchronous data as a part in-line vs building a MultiValueMap and passing it in.
static <T,P extends org.reactivestreams.Publisher<T>> BodyInserters.MultipartInserter	fromMultipartAsyncData(java.lang.String key, P publisher, ParameterizedTypeReference<T> typeReference) A variant of fromMultipartData(MultiValueMap) for adding asynchronous data as a part in-line vs building a MultiValueMap and passing it in.
static BodyInserters.MultipartInserter	fromMultipartData(MultiValueMap<java.lang.String,?> multipartData) Return a FormInserter that writes the given MultiValueMap as multipart data.
static BodyInserters.MultipartInserter	fromMultipartData(java.lang.String key, java.lang.Object value) A variant of fromMultipartData(MultiValueMap) for adding parts as name-value pairs in-line vs building a MultiValueMap and passing it in.
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, java.lang.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.

Note also that WebClient and ServerResponse each offer a syncBody(Object) shortcut for providing an Object as the body.

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,
                                                                                                                     java.lang.Class<T> elementClass)

Return a BodyInserter that writes the given Publisher.

Note also that WebClient and ServerResponse each offer body shortcut methods for providing a Publisher as the body.

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.

Note also that WebClient and ServerResponse each offer body shortcut methods for providing a Publisher as the body.

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 BodyInserters.FormInserter<java.lang.String> fromFormData(MultiValueMap<java.lang.String,java.lang.String> formData)

Return a BodyInserters.FormInserter that writes the given MultiValueMap as URL-encoded form data. The returned inserter allows for additional entries to be added via BodyInserters.FormInserter.with(String, Object).

Note that you can also use the syncBody(Object) method in the request builders of both the WebClient and WebTestClient. In that case the setting of the content type is also not required, just be sure the map contains String values only or otherwise it would be interpreted as a multipart request.

Parameters:

formData - the form data to write to the output message

Returns:

a FormInserter that writes form data

fromFormData

public static BodyInserters.FormInserter<java.lang.String> fromFormData(java.lang.String key,
                                                                        java.lang.String value)

Return a BodyInserters.FormInserter that writes the given key-value pair as URL-encoded form data. The returned inserter allows for additional entries to be added via BodyInserters.FormInserter.with(String, Object).

Parameters:

key - the key to add to the form

value - the value to add to the form

Returns:

a FormInserter that writes form data

fromMultipartData

public static BodyInserters.MultipartInserter fromMultipartData(MultiValueMap<java.lang.String,?> multipartData)

Return a FormInserter that writes the given MultiValueMap as multipart data. The values in the MultiValueMap can be any Object representing the body of the part, or an HttpEntity representing a part with body and headers. The MultiValueMap can be built conveniently using MultipartBodyBuilder. Also the returned inserter allows for additional entries to be added via BodyInserters.FormInserter.with(String, Object).

Note that you can also use the syncBody(Object) method in the request builders of both the WebClient and WebTestClient. In that case the setting of the content type is also not required, just be sure the map contains at least one non-String value or otherwise, without a content-type header as a hint, it would be interpreted as a plain form data request.

Parameters:

multipartData - the form data to write to the output message

Returns:

a BodyInserter that writes multipart data

See Also:

MultipartBodyBuilder

fromMultipartData

public static BodyInserters.MultipartInserter fromMultipartData(java.lang.String key,
                                                                java.lang.Object value)

A variant of fromMultipartData(MultiValueMap) for adding parts as name-value pairs in-line vs building a MultiValueMap and passing it in.

Parameters:

key - the part name

value - the part value, an Object or HttpEntity

Returns:

a FormInserter that can writes the provided multipart data and also allows adding more parts

fromMultipartAsyncData

public static <T,P extends org.reactivestreams.Publisher<T>> BodyInserters.MultipartInserter fromMultipartAsyncData(java.lang.String key,
                                                                                                                    P publisher,
                                                                                                                    java.lang.Class<T> elementClass)

A variant of fromMultipartData(MultiValueMap) for adding asynchronous data as a part in-line vs building a MultiValueMap and passing it in.

Parameters:

key - the part name

publisher - the publisher that forms the part value

elementClass - the class contained in the publisher

Returns:

a FormInserter that can writes the provided multipart data and also allows adding more parts

fromMultipartAsyncData

public static <T,P extends org.reactivestreams.Publisher<T>> BodyInserters.MultipartInserter fromMultipartAsyncData(java.lang.String key,
                                                                                                                    P publisher,
                                                                                                                    ParameterizedTypeReference<T> typeReference)

A variant of fromMultipartData(MultiValueMap) for adding asynchronous data as a part in-line vs building a MultiValueMap and passing it in.

Parameters:

key - the part name

publisher - the publisher that forms the part value

typeReference - the type contained in the publisher

Returns:

a FormInserter that can writes the provided multipart data and also allows adding more parts

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)