Top Description Inners Methods
org.springframework.web.reactive.function

public Interface BodyExtractor<T, M extends ReactiveHttpInputMessage>

Annotations
@FunctionalInterface
Type Parameters
<T>
the type of data to extract
<M>
the type of ReactiveHttpInputMessage this extractor can be applied to
Imports
java.util.List, .Map, .Optional, org.springframework.http.ReactiveHttpInputMessage, org.springframework.http.codec.HttpMessageReader, org.springframework.http.server.reactive.ServerHttpResponse
A function that can extract data from a ReactiveHttpInputMessage body.
Author
Arjen Poutsma
Since
5.0
See Also
BodyExtractors

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
BodyExtractor.Context

Defines the context used during the extraction.

Method Summary

Modifier and TypeMethod and Description
public T

Returns:

the extracted data
extract(M
the message to extract from
inputMessage, BodyExtractor.Context
the configuration to use
context)

Extract from the given input message.

Method Detail

extractback to summary
public T extract(M inputMessage, BodyExtractor.Context context)

Extract from the given input message.

Parameters
inputMessage:M

the message to extract from

context:BodyExtractor.Context

the configuration to use

Returns:T

the extracted data

org.springframework.web.reactive.function back to summary

public Interface BodyExtractor.Context

Defines the context used during the extraction.

Method Summary

Modifier and TypeMethod and Description
public Map<String, Object>
hints()

Return the map of hints to use to customize body extraction.

public List<HttpMessageReader<?>>

Returns:

the list of message readers
messageReaders()

Return the HttpMessageReaders to be used for body extraction.

public Optional<ServerHttpResponse>
serverResponse()

Optionally return the ServerHttpResponse, if present.

Method Detail

hintsback to summary
public Map<String, Object> hints()

Return the map of hints to use to customize body extraction.

messageReadersback to summary
public List<HttpMessageReader<?>> messageReaders()

Return the HttpMessageReaders to be used for body extraction.

Returns:List<HttpMessageReader<?>>

the list of message readers

serverResponseback to summary
public Optional<ServerHttpResponse> serverResponse()

Optionally return the ServerHttpResponse, if present.