Class BodyExtractors
java.lang.Object
org.springframework.web.reactive.function.BodyExtractors
Static factory methods for
BodyExtractor
implementations.- Since:
- 5.0
- Author:
- Arjen Poutsma, Sebastien Deleuze, Rossen Stoyanchev, Brian Clozel
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic BodyExtractor<reactor.core.publisher.Flux<org.springframework.core.io.buffer.DataBuffer>,
org.springframework.http.ReactiveHttpInputMessage> Extractor that returns the rawDataBuffers
.static <T> BodyExtractor<reactor.core.publisher.Flux<T>,
org.springframework.http.ReactiveHttpInputMessage> Extractor to decode the input content intoFlux<T>
.static <T> BodyExtractor<reactor.core.publisher.Flux<T>,
org.springframework.http.ReactiveHttpInputMessage> toFlux
(org.springframework.core.ParameterizedTypeReference<T> typeRef) Variant oftoFlux(Class)
for type information with generics.static BodyExtractor<reactor.core.publisher.Mono<org.springframework.util.MultiValueMap<String,
String>>, org.springframework.http.ReactiveHttpInputMessage> Extractor to read form data intoMultiValueMap<String, String>
.static <T> BodyExtractor<reactor.core.publisher.Mono<T>,
org.springframework.http.ReactiveHttpInputMessage> Extractor to decode the input content intoMono<T>
.static <T> BodyExtractor<reactor.core.publisher.Mono<T>,
org.springframework.http.ReactiveHttpInputMessage> toMono
(org.springframework.core.ParameterizedTypeReference<T> elementTypeRef) Variant oftoMono(Class)
for type information with generics.static BodyExtractor<reactor.core.publisher.Mono<org.springframework.util.MultiValueMap<String,
org.springframework.http.codec.multipart.Part>>, org.springframework.http.server.reactive.ServerHttpRequest> Extractor to read multipart data into aMultiValueMap<String, Part>
.static BodyExtractor<reactor.core.publisher.Flux<org.springframework.http.codec.multipart.Part>,
org.springframework.http.server.reactive.ServerHttpRequest> toParts()
Extractor to read multipart data intoFlux<Part>
.
-
Constructor Details
-
BodyExtractors
public BodyExtractors()
-
-
Method Details
-
toMono
public static <T> BodyExtractor<reactor.core.publisher.Mono<T>,org.springframework.http.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>,org.springframework.http.ReactiveHttpInputMessage> toMono(org.springframework.core.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>,org.springframework.http.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>,org.springframework.http.ReactiveHttpInputMessage> toFlux(org.springframework.core.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<org.springframework.util.MultiValueMap<String,String>>, toFormData()org.springframework.http.ReactiveHttpInputMessage> 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<org.springframework.util.MultiValueMap<String,org.springframework.http.codec.multipart.Part>>, toMultipartData()org.springframework.http.server.reactive.ServerHttpRequest> Extractor to read multipart data into aMultiValueMap<String, Part>
.Note: that resources used for part handling, like storage for the uploaded files, is not deleted automatically, but should be done via
Part.delete()
.- Returns:
BodyExtractor
for multipart data
-
toParts
public static BodyExtractor<reactor.core.publisher.Flux<org.springframework.http.codec.multipart.Part>,org.springframework.http.server.reactive.ServerHttpRequest> toParts()Extractor to read multipart data intoFlux<Part>
.Note: that resources used for part handling, like storage for the uploaded files, is not deleted automatically, but should be done via
Part.delete()
.- Returns:
BodyExtractor
for multipart request parts
-
toDataBuffers
public static BodyExtractor<reactor.core.publisher.Flux<org.springframework.core.io.buffer.DataBuffer>,org.springframework.http.ReactiveHttpInputMessage> toDataBuffers()Extractor that returns the rawDataBuffers
.Note: the data buffers should be
released
after being used.- Returns:
BodyExtractor
for data buffers
-