org.springframework.web.reactive.function

Class BodyExtractors

java.lang.Object

org.springframework.web.reactive.function.BodyExtractors

public abstract class BodyExtractors
extends java.lang.Object

Static factory methods for BodyExtractor implementations.

Since:

5.0

Author:

Arjen Poutsma, Sebastien Deleuze, Rossen Stoyanchev, Brian Clozel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	BodyExtractors.ReadCancellationException

Field Summary

Fields

Modifier and Type	Field and Description
private static ResolvableType	FORM_DATA_TYPE
private static ResolvableType	MULTIPART_DATA_TYPE
private static ResolvableType	PART_TYPE
private static ResolvableType	VOID_TYPE

Constructor Summary

Constructors

Constructor and Description
BodyExtractors()

Method Summary

Modifier and Type	Method and Description
private static <T> HttpMessageReader<T>	cast(HttpMessageReader<?> reader)
private static <any>	consumeAndCancel(ReactiveHttpInputMessage message)
private static <T> HttpMessageReader<T>	findReader(ResolvableType elementType, MediaType mediaType, BodyExtractor.Context context)
private static <T> <any>	readToFlux(ReactiveHttpInputMessage message, BodyExtractor.Context context, ResolvableType type, HttpMessageReader<T> reader)
private static <T> <any>	readToMono(ReactiveHttpInputMessage message, BodyExtractor.Context context, ResolvableType type, HttpMessageReader<T> reader)
private static <T,S extends <any>> S	readWithMessageReaders(ReactiveHttpInputMessage message, BodyExtractor.Context context, ResolvableType elementType, java.util.function.Function<HttpMessageReader<T>,S> readerFunction, java.util.function.Function<UnsupportedMediaTypeException,S> errorFunction, java.util.function.Supplier<S> emptySupplier)
private static <T> java.util.function.Supplier<<any>>	skipBodyAsFlux(ReactiveHttpInputMessage message)
private static <T> java.util.function.Supplier<<any>>	skipBodyAsMono(ReactiveHttpInputMessage message)
static BodyExtractor<<any>,ReactiveHttpInputMessage>	toDataBuffers() Extractor that returns the raw DataBuffers.
static <T> BodyExtractor<<any>,ReactiveHttpInputMessage>	toFlux(java.lang.Class<? extends T> elementClass) Extractor to decode the input content into Flux<T>.
static <T> BodyExtractor<<any>,ReactiveHttpInputMessage>	toFlux(ParameterizedTypeReference<T> typeRef) Variant of toFlux(Class) for type information with generics.
private static <T> BodyExtractor<<any>,ReactiveHttpInputMessage>	toFlux(ResolvableType elementType)
static BodyExtractor<<any>,ReactiveHttpInputMessage>	toFormData() Extractor to read form data into MultiValueMap<String, String>.
static <T> BodyExtractor<<any>,ReactiveHttpInputMessage>	toMono(java.lang.Class<? extends T> elementClass) Extractor to decode the input content into Mono<T>.
static <T> BodyExtractor<<any>,ReactiveHttpInputMessage>	toMono(ParameterizedTypeReference<T> typeRef) Variant of toMono(Class) for type information with generics.
private static <T> BodyExtractor<<any>,ReactiveHttpInputMessage>	toMono(ResolvableType elementType)
static BodyExtractor<<any>,ServerHttpRequest>	toMultipartData() Extractor to read multipart data into a MultiValueMap<String, Part>.
static BodyExtractor<<any>,ServerHttpRequest>	toParts() Extractor to read multipart data into Flux<Part>.
private static <T> <any>	unsupportedErrorHandler(ReactiveHttpInputMessage message, UnsupportedMediaTypeException ex)

Methods inherited from class java.lang.Object

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

Field Detail

FORM_DATA_TYPE

private static final ResolvableType FORM_DATA_TYPE

MULTIPART_DATA_TYPE

private static final ResolvableType MULTIPART_DATA_TYPE

PART_TYPE

private static final ResolvableType PART_TYPE

VOID_TYPE

private static final ResolvableType VOID_TYPE

Constructor Detail

BodyExtractors

public BodyExtractors()

Method Detail

toMono

public static <T> BodyExtractor<<any>,ReactiveHttpInputMessage> toMono(java.lang.Class<? extends T> elementClass)

Extractor to decode the input content into Mono<T>.

Type Parameters:

T - the element type to decode to

Parameters:

elementClass - the class of the element type to decode to

Returns:

BodyExtractor for Mono<T>

toMono

public static <T> BodyExtractor<<any>,ReactiveHttpInputMessage> toMono(ParameterizedTypeReference<T> typeRef)

Variant of toMono(Class) for type information with generics.

Type Parameters:

T - the element type to decode to

Parameters:

typeRef - the type reference for the type to decode to

Returns:

BodyExtractor for Mono<T>

toMono

private static <T> BodyExtractor<<any>,ReactiveHttpInputMessage> toMono(ResolvableType elementType)

toFlux

public static <T> BodyExtractor<<any>,ReactiveHttpInputMessage> toFlux(java.lang.Class<? extends T> elementClass)

Extractor to decode the input content into Flux<T>.

Type Parameters:

T - the element type to decode to

Parameters:

elementClass - the class of the element type to decode to

Returns:

BodyExtractor for Flux<T>

toFlux

public static <T> BodyExtractor<<any>,ReactiveHttpInputMessage> toFlux(ParameterizedTypeReference<T> typeRef)

Variant of toFlux(Class) for type information with generics.

Type Parameters:

T - the element type to decode to

Parameters:

typeRef - the type reference for the type to decode to

Returns:

BodyExtractor for Flux<T>

toFlux

private static <T> BodyExtractor<<any>,ReactiveHttpInputMessage> toFlux(ResolvableType elementType)

toFormData

public static BodyExtractor<<any>,ReactiveHttpInputMessage> toFormData()

Extractor to read form data into MultiValueMap<String, String>.

As of 5.1 this method can also be used on the client side to read form data from a server response (e.g. OAuth).

Returns:

BodyExtractor for form data

toMultipartData

public static BodyExtractor<<any>,ServerHttpRequest> toMultipartData()

Extractor to read multipart data into a MultiValueMap<String, Part>.

Returns:

BodyExtractor for multipart data

toParts

public static BodyExtractor<<any>,ServerHttpRequest> toParts()

Extractor to read multipart data into Flux<Part>.

Returns:

BodyExtractor for multipart request parts

toDataBuffers

public static BodyExtractor<<any>,ReactiveHttpInputMessage> toDataBuffers()

Extractor that returns the raw DataBuffers.

Note: the data buffers should be released after being used.

Returns:

BodyExtractor for data buffers

readWithMessageReaders

private static <T,S extends <any>> S readWithMessageReaders(ReactiveHttpInputMessage message,
                                                            BodyExtractor.Context context,
                                                            ResolvableType elementType,
                                                            java.util.function.Function<HttpMessageReader<T>,S> readerFunction,
                                                            java.util.function.Function<UnsupportedMediaTypeException,S> errorFunction,
                                                            java.util.function.Supplier<S> emptySupplier)

readToMono

private static <T> <any> readToMono(ReactiveHttpInputMessage message,
                                    BodyExtractor.Context context,
                                    ResolvableType type,
                                    HttpMessageReader<T> reader)

readToFlux

private static <T> <any> readToFlux(ReactiveHttpInputMessage message,
                                    BodyExtractor.Context context,
                                    ResolvableType type,
                                    HttpMessageReader<T> reader)

unsupportedErrorHandler

private static <T> <any> unsupportedErrorHandler(ReactiveHttpInputMessage message,
                                                 UnsupportedMediaTypeException ex)

findReader

private static <T> HttpMessageReader<T> findReader(ResolvableType elementType,
                                                   MediaType mediaType,
                                                   BodyExtractor.Context context)

cast

private static <T> HttpMessageReader<T> cast(HttpMessageReader<?> reader)

skipBodyAsFlux

private static <T> java.util.function.Supplier<<any>> skipBodyAsFlux(ReactiveHttpInputMessage message)

skipBodyAsMono

private static <T> java.util.function.Supplier<<any>> skipBodyAsMono(ReactiveHttpInputMessage message)

consumeAndCancel

private static <any> consumeAndCancel(ReactiveHttpInputMessage message)