Spring Framework 6.1.4 · org.springframework.web.reactive.function.BodyInserters

Modifier and Type	Class and Description
private static class	BodyInserters.DefaultFormInserter
private static class	BodyInserters.DefaultMultipartInserter
public static interface	BodyInserters.FormInserter< the value type T> Extension of `BodyInserter` that allows for adding form data or multipart form data.
public static interface	BodyInserters.MultipartInserter Extension of `FormInserter` that allows for adding asynchronous parts.

Modifier and Type	Field and Description
private static final BodyInserter<Void, ReactiveHttpOutputMessage>	EMPTY_INSERTER
private static final ResolvableType	FORM_DATA_TYPE
private static final ResolvableType	MULTIPART_DATA_TYPE
private static final ReactiveAdapterRegistry	registry
private static final ResolvableType	RESOURCE_TYPE
private static final ResolvableType	SSE_TYPE

Access	Constructor and Description
public	BodyInserters()

Method Summary

Modifier and Type	Method and Description
private static <T> HttpMessageWriter<T>	cast(HttpMessageWriter<?> messageWriter)
public static <T> BodyInserter<T, ReactiveHttpOutputMessage>	Returns: the inserter empty() Inserter that does not write.
private static <T> HttpMessageWriter<T>	findWriter(BodyInserter.Context context, ResolvableType elementType, MediaType mediaType)
public static < the type of the publisher T extends Publisher<DataBuffer>> BodyInserter<T, ReactiveHttpOutputMessage>	Returns: the inserter to write directly to the body fromDataBuffers(T the data buffer publisher to write publisher) Inserter to write the given `Publisher<DataBuffer>` to the body.
public static BodyInserters.FormInserter<String>	Returns: the inserter that allows adding more form data fromFormData(MultiValueMap<String, String> the form data to write to the output message formData) Return a `FormInserter` to write the given `MultiValueMap` as URL-encoded form data.
public static BodyInserters.FormInserter<String>	Returns: the inserter that allows adding more form data fromFormData(String the key to add to the form name, String the value to add to the form value) Return a `FormInserter` to write the given key-value pair as URL-encoded form data.
public static <T, P extends Publisher<T>> BodyInserters.MultipartInserter	Returns: the inserter that allows adding more parts fromMultipartAsyncData(String the part name name, P the publisher that forms the part value publisher, Class<T> the class contained in the `publisher` elementClass) Return a `MultipartInserter` to write the given asynchronous parts, as multipart data.
public static <T, P extends Publisher<T>> BodyInserters.MultipartInserter	Returns: the inserter that allows adding more parts fromMultipartAsyncData(String the part name name, P the publisher that forms the part value publisher, ParameterizedTypeReference<T> the type contained in the `publisher` typeReference) Variant of `fromMultipartAsyncData(String, Publisher, Class)` that accepts a `ParameterizedTypeReference` for the element type, which allows specifying generic type information.
public static BodyInserters.MultipartInserter	Returns: the inserter that allows adding more parts fromMultipartData(MultiValueMap<String, ?> the form data to write to the output message multipartData) Return a `MultipartInserter` to write the given `MultiValueMap` as multipart data.
public static BodyInserters.MultipartInserter	Returns: the inserter that allows adding more parts fromMultipartData(String the part name name, Object the part value, an Object or `HttpEntity` value) Return a `MultipartInserter` to write the given parts, as multipart data.
public static < the type of the body T> BodyInserter<T, ReactiveHttpOutputMessage>	Returns: the inserter to write a single object fromObject(T the body to write to the response body) Deprecated As of Spring Framework 5.2, in favor of `fromValue(Object)` Inserter to write the given object.
public static <T extends Publisher<DataBuffer>> BodyInserter<T, ReactiveHttpOutputMessage>	Returns: an inserter that writes what is written to the output stream fromOutputStream(Consumer<OutputStream> invoked with an `OutputStream` that writes to the output message outputStreamConsumer, Executor used to invoke the `outputStreamHandler` on a separate thread executor) Inserter based on bytes written to a `OutputStream`.
public static <T extends Publisher<DataBuffer>> BodyInserter<T, ReactiveHttpOutputMessage>	Returns: an inserter that writes what is written to the output stream fromOutputStream(Consumer<OutputStream> invoked with an `OutputStream` that writes to the output message outputStreamConsumer, Executor used to invoke the `outputStreamHandler` on a separate thread executor, int minimum size of the buffer produced by the publisher chunkSize) Inserter based on bytes written to a `OutputStream`.
public static < the type of the body T> BodyInserter<T, ReactiveHttpOutputMessage>	Returns: the inserter to write a producer fromProducer(T the source of body value(s). producer, Class<?> the class of values to be produced elementClass) Inserter to write the given producer of value(s) which must be a `Publisher` or another producer adaptable to a `Publisher` via `ReactiveAdapterRegistry`.
public static < the type of the body T> BodyInserter<T, ReactiveHttpOutputMessage>	Returns: the inserter to write a producer fromProducer(T the source of body value(s). producer, ParameterizedTypeReference<?> the type of values to be produced elementTypeRef) Inserter to write the given producer of value(s) which must be a `Publisher` or another producer adaptable to a `Publisher` via `ReactiveAdapterRegistry`.
public static < the type of the elements contained in the publisher T, the `Publisher` type P extends Publisher<T>> BodyInserter<P, ReactiveHttpOutputMessage>	Returns: the inserter to write a `Publisher` fromPublisher(P the publisher to write with publisher, Class<T> the class of elements in the publisher elementClass) Inserter to write the given `Publisher`.
public static < the type of the elements contained in the publisher T, the `Publisher` type P extends Publisher<T>> BodyInserter<P, ReactiveHttpOutputMessage>	Returns: the inserter to write a `Publisher` fromPublisher(P the publisher to write with publisher, ParameterizedTypeReference<T> the type of elements contained in the publisher elementTypeRef) Inserter to write the given `Publisher`.
public static < the type of the `Resource` T extends Resource> BodyInserter<T, ReactiveHttpOutputMessage>	Returns: the inserter to write a `Publisher` fromResource(T the resource to write to the output message resource) Inserter to write the given `Resource`.
public static < the type of the data elements in the `ServerSentEvent` T, S extends Publisher<ServerSentEvent<T>>> BodyInserter<S, ServerHttpResponse>	Returns: the inserter to write a `ServerSentEvent` publisher fromServerSentEvents(S the `ServerSentEvent` publisher to write to the response body eventsPublisher) Inserter to write the given `ServerSentEvent` publisher.
public static < the type of the body T> BodyInserter<T, ReactiveHttpOutputMessage>	Returns: the inserter to write a single value fromValue(T the value to write body) Inserter to write the given value.
private static UnsupportedMediaTypeException	unsupportedError(ResolvableType bodyType, BodyInserter.Context context, MediaType mediaType)
private static <T> Mono<Void>	write(Publisher<? extends T> input, ResolvableType type, MediaType mediaType, ReactiveHttpOutputMessage message, BodyInserter.Context context, HttpMessageWriter<T> writer)
private static <M extends ReactiveHttpOutputMessage> Mono<Void>	writeWithMessageWriters(M outputMessage, BodyInserter.Context context, Object body, ResolvableType bodyType, ReactiveAdapter adapter)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public abstract Class BodyInserters

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary