Class BodyExtractors
- java.lang.Object
- org.springframework.web.reactive.function.BodyExtractors
public abstract class BodyExtractors extends Object
Static factory methods forBodyExtractor
implementations.- Since:
- 5.0
- Author:
- Arjen Poutsma, Sebastien Deleuze, Rossen Stoyanchev, Brian Clozel
Constructor Summary
Constructors Constructor Description BodyExtractors()
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static BodyExtractor<reactor.core.publisher.Flux<DataBuffer>,ReactiveHttpInputMessage>
toDataBuffers()
Extractor that returns the rawDataBuffers
.static <T> BodyExtractor<reactor.core.publisher.Flux<T>,ReactiveHttpInputMessage>
toFlux(Class<? extends T> elementClass)
Extractor to decode the input content intoFlux<T>
.static <T> BodyExtractor<reactor.core.publisher.Flux<T>,ReactiveHttpInputMessage>
toFlux(ParameterizedTypeReference<T> typeRef)
Variant oftoFlux(Class)
for type information with generics.static BodyExtractor<reactor.core.publisher.Mono<MultiValueMap<String,String>>,ReactiveHttpInputMessage>
toFormData()
Extractor to read form data intoMultiValueMap<String, String>
.static <T> BodyExtractor<reactor.core.publisher.Mono<T>,ReactiveHttpInputMessage>
toMono(Class<? extends T> elementClass)
Extractor to decode the input content intoMono<T>
.static <T> BodyExtractor<reactor.core.publisher.Mono<T>,ReactiveHttpInputMessage>
toMono(ParameterizedTypeReference<T> elementTypeRef)
Variant oftoMono(Class)
for type information with generics.static BodyExtractor<reactor.core.publisher.Mono<MultiValueMap<String,Part>>,ServerHttpRequest>
toMultipartData()
Extractor to read multipart data into aMultiValueMap<String, Part>
.static BodyExtractor<reactor.core.publisher.Flux<Part>,ServerHttpRequest>
toParts()
Extractor to read multipart data intoFlux<Part>
.
Constructor Detail
BodyExtractors
public BodyExtractors()
Method Detail
toMono
public static <T> BodyExtractor<reactor.core.publisher.Mono<T>,ReactiveHttpInputMessage> toMono(Class<? extends T> elementClass)
Extractor to decode the input content intoMono<T>
.- Type Parameters:
T
- the element type to decode to- Parameters:
elementClass
- the class of the element type to decode to- Returns:
BodyExtractor
forMono<T>
toMono
public static <T> BodyExtractor<reactor.core.publisher.Mono<T>,ReactiveHttpInputMessage> toMono(ParameterizedTypeReference<T> elementTypeRef)
Variant oftoMono(Class)
for type information with generics.- Type Parameters:
T
- the element type to decode to- Parameters:
elementTypeRef
- the type reference for the type to decode to- Returns:
BodyExtractor
forMono<T>
toFlux
public static <T> BodyExtractor<reactor.core.publisher.Flux<T>,ReactiveHttpInputMessage> toFlux(Class<? extends T> elementClass)
Extractor to decode the input content intoFlux<T>
.- Type Parameters:
T
- the element type to decode to- Parameters:
elementClass
- the class of the element type to decode to- Returns:
BodyExtractor
forFlux<T>
toFlux
public static <T> BodyExtractor<reactor.core.publisher.Flux<T>,ReactiveHttpInputMessage> toFlux(ParameterizedTypeReference<T> typeRef)
Variant oftoFlux(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
forFlux<T>
toFormData
public static BodyExtractor<reactor.core.publisher.Mono<MultiValueMap<String,String>>,ReactiveHttpInputMessage> toFormData()
Extractor to read form data intoMultiValueMap<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<reactor.core.publisher.Mono<MultiValueMap<String,Part>>,ServerHttpRequest> toMultipartData()
Extractor to read multipart data into aMultiValueMap<String, Part>
.- Returns:
BodyExtractor
for multipart data
toParts
public static BodyExtractor<reactor.core.publisher.Flux<Part>,ServerHttpRequest> toParts()
Extractor to read multipart data intoFlux<Part>
.- Returns:
BodyExtractor
for multipart request parts
toDataBuffers
public static BodyExtractor<reactor.core.publisher.Flux<DataBuffer>,ReactiveHttpInputMessage> toDataBuffers()
Extractor that returns the rawDataBuffers
.Note: the data buffers should be
released
after being used.- Returns:
BodyExtractor
for data buffers