org.springframework.web.reactive.function

Class BodyExtractors

java.lang.Object

org.springframework.web.reactive.function.BodyExtractors

public abstract class BodyExtractors
extends Object

Implementations of BodyExtractor that read various bodies, such a reactive streams.

Since:

5.0

Author:

Arjen Poutsma, Sebastien Deleuze

Constructor Summary

Constructors

Constructor and Description
BodyExtractors()

Method Summary

Modifier and Type	Method and Description
static BodyExtractor<reactor.core.publisher.Flux<DataBuffer>,ReactiveHttpInputMessage>	toDataBuffers() Return a BodyExtractor that returns the body of the message as a Flux of DataBuffers.
static <T> BodyExtractor<reactor.core.publisher.Flux<T>,ReactiveHttpInputMessage>	toFlux(Class<? extends T> elementClass) Return a BodyExtractor that reads into a Reactor Flux.
static <T> BodyExtractor<reactor.core.publisher.Flux<T>,ReactiveHttpInputMessage>	toFlux(ParameterizedTypeReference<T> typeReference) Return a BodyExtractor that reads into a Reactor Flux.
static BodyExtractor<reactor.core.publisher.Mono<MultiValueMap<String,String>>,ServerHttpRequest>	toFormData() Return a BodyExtractor that reads form data into a MultiValueMap.
static <T> BodyExtractor<reactor.core.publisher.Mono<T>,ReactiveHttpInputMessage>	toMono(Class<? extends T> elementClass) Return a BodyExtractor that reads into a Reactor Mono.
static <T> BodyExtractor<reactor.core.publisher.Mono<T>,ReactiveHttpInputMessage>	toMono(ParameterizedTypeReference<T> typeReference) Return a BodyExtractor that reads into a Reactor Mono.
static BodyExtractor<reactor.core.publisher.Mono<MultiValueMap<String,Part>>,ServerHttpRequest>	toMultipartData() Return a BodyExtractor that reads multipart (i.e.
static BodyExtractor<reactor.core.publisher.Flux<Part>,ServerHttpRequest>	toParts() Return a BodyExtractor that reads multipart (i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

BodyExtractors

public BodyExtractors()

Method Detail

toMono

public static <T> BodyExtractor<reactor.core.publisher.Mono<T>,ReactiveHttpInputMessage> toMono(Class<? extends T> elementClass)

Return a BodyExtractor that reads into a Reactor Mono.

Type Parameters:

T - the element type

Parameters:

elementClass - the class of element in the Mono

Returns:

a BodyExtractor that reads a mono

toMono

public static <T> BodyExtractor<reactor.core.publisher.Mono<T>,ReactiveHttpInputMessage> toMono(ParameterizedTypeReference<T> typeReference)

Return a BodyExtractor that reads into a Reactor Mono. The given ParameterizedTypeReference is used to pass generic type information, for instance when using the WebClient:

 Mono<Map<String, String>> body = this.webClient
  .get()
  .uri("https://example.com")
  .exchange()
  .flatMap(r -> r.body(toMono(new ParameterizedTypeReference<Map<String,String>>() {})));
 

Type Parameters:

T - the element type

Parameters:

typeReference - a reference to the type of element in the Mono

Returns:

a BodyExtractor that reads a mono

toFlux

public static <T> BodyExtractor<reactor.core.publisher.Flux<T>,ReactiveHttpInputMessage> toFlux(Class<? extends T> elementClass)

Return a BodyExtractor that reads into a Reactor Flux.

Type Parameters:

T - the element type

Parameters:

elementClass - the class of element in the Flux

Returns:

a BodyExtractor that reads a flux

toFlux

public static <T> BodyExtractor<reactor.core.publisher.Flux<T>,ReactiveHttpInputMessage> toFlux(ParameterizedTypeReference<T> typeReference)

Return a BodyExtractor that reads into a Reactor Flux.

The given ParameterizedTypeReference is used to pass generic type information, for instance when using the WebClient:

 Flux<ServerSentEvent<String>> body = this.webClient
  .get()
  .uri("https://example.com")
  .exchange()
  .flatMap(r -> r.body(toFlux(new ParameterizedTypeReference<ServerSentEvent<String>>() {})));
 

Type Parameters:

T - the element type

Parameters:

typeReference - a reference to the type of element in the Flux

Returns:

a BodyExtractor that reads a flux

toFormData

public static BodyExtractor<reactor.core.publisher.Mono<MultiValueMap<String,String>>,ServerHttpRequest> toFormData()

Return a BodyExtractor that reads form data into a MultiValueMap.

Returns:

a BodyExtractor that reads form data

toMultipartData

public static BodyExtractor<reactor.core.publisher.Mono<MultiValueMap<String,Part>>,ServerHttpRequest> toMultipartData()

Return a BodyExtractor that reads multipart (i.e. file upload) form data into a MultiValueMap.

Returns:

a BodyExtractor that reads multipart data

toParts

public static BodyExtractor<reactor.core.publisher.Flux<Part>,ServerHttpRequest> toParts()

Return a BodyExtractor that reads multipart (i.e. file upload) form data into a MultiValueMap.

Returns:

a BodyExtractor that reads multipart data

toDataBuffers

public static BodyExtractor<reactor.core.publisher.Flux<DataBuffer>,ReactiveHttpInputMessage> toDataBuffers()

Return a BodyExtractor that returns the body of the message as a Flux of DataBuffers.

Note that the returned buffers should be released after usage by calling DataBufferUtils.release(DataBuffer).

Returns:

a BodyExtractor that returns the body

See Also:

ReactiveHttpInputMessage.getBody()