org.springframework.web.reactive.function.server

Interface ServerRequest

All Known Implementing Classes:

DefaultServerRequest, RequestPredicates.SubPathServerRequestWrapper, ServerRequestWrapper

public interface ServerRequest

Represents a server-side HTTP request, as handled by a HandlerFunction. Access to headers and body is offered by ServerRequest.Headers and body(BodyExtractor) respectively.

Since:

5.0

Author:

Arjen Poutsma, Sebastien Deleuze

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServerRequest.Headers Represents the headers of the HTTP request.

Method Summary

Modifier and Type	Method and Description
<T> java.util.Optional<T>	attribute(java.lang.String name) Return the request attribute value if present.
java.util.Map<java.lang.String,java.lang.Object>	attributes() Return a mutable map of request attributes.
<T> T	body(BodyExtractor<T,? super ServerHttpRequest> extractor) Extract the body with the given BodyExtractor.
<T> T	body(BodyExtractor<T,? super ServerHttpRequest> extractor, java.util.Map<java.lang.String,java.lang.Object> hints) Extract the body with the given BodyExtractor and hints.
<T> <any>	bodyToFlux(java.lang.Class<? extends T> elementClass) Extract the body to a Flux.
<T> <any>	bodyToMono(java.lang.Class<? extends T> elementClass) Extract the body to a Mono.
ServerRequest.Headers	headers() Return the headers of this request.
HttpMethod	method() Return the HTTP method.
default java.lang.String	path() Return the request path.
default java.lang.String	pathVariable(java.lang.String name) Return the path variable with the given name, if present.
java.util.Map<java.lang.String,java.lang.String>	pathVariables() Return all path variables.
default java.util.Optional<java.lang.String>	queryParam(java.lang.String name) Return the first query parameter with the given name, if present.
java.util.List<java.lang.String>	queryParams(java.lang.String name) Return all query parameter with the given name.
<any>	session() Return the web session for the current request.
java.net.URI	uri() Return the request URI.

Method Detail

method

HttpMethod method()

Return the HTTP method.

uri

java.net.URI uri()

Return the request URI.

path

default java.lang.String path()

Return the request path.

headers

ServerRequest.Headers headers()

Return the headers of this request.

body

<T> T body(BodyExtractor<T,? super ServerHttpRequest> extractor)

Extract the body with the given BodyExtractor.

Type Parameters:

T - the type of the body returned

Parameters:

extractor - the BodyExtractor that reads from the request

Returns:

the extracted body

See Also:

body(BodyExtractor, Map)

body

<T> T body(BodyExtractor<T,? super ServerHttpRequest> extractor,
           java.util.Map<java.lang.String,java.lang.Object> hints)

Extract the body with the given BodyExtractor and hints.

Type Parameters:

T - the type of the body returned

Parameters:

extractor - the BodyExtractor that reads from the request

hints - the map of hints like AbstractJackson2Codec.JSON_VIEW_HINT to use to customize body extraction

Returns:

the extracted body

bodyToMono

<T> <any> bodyToMono(java.lang.Class<? extends T> elementClass)

Extract the body to a Mono.

Type Parameters:

T - the element type

Parameters:

elementClass - the class of element in the Mono

Returns:

the body as a mono

bodyToFlux

<T> <any> bodyToFlux(java.lang.Class<? extends T> elementClass)

Extract the body to a Flux.

Type Parameters:

T - the element type

Parameters:

elementClass - the class of element in the Flux

Returns:

the body as a flux

attribute

<T> java.util.Optional<T> attribute(java.lang.String name)

Return the request attribute value if present.

Type Parameters:

T - the attribute type

Parameters:

name - the attribute name

Returns:

the attribute value

attributes

java.util.Map<java.lang.String,java.lang.Object> attributes()

Return a mutable map of request attributes.

Returns:

the request attributes

queryParam

default java.util.Optional<java.lang.String> queryParam(java.lang.String name)

Return the first query parameter with the given name, if present.

Parameters:

name - the parameter name

Returns:

the parameter value

queryParams

java.util.List<java.lang.String> queryParams(java.lang.String name)

Return all query parameter with the given name.

Returns an empty list if no values could be found.

Parameters:

name - the parameter name

Returns:

the parameter values

pathVariable

default java.lang.String pathVariable(java.lang.String name)

Return the path variable with the given name, if present.

Parameters:

name - the variable name

Returns:

the variable value

Throws:

java.lang.IllegalArgumentException - if there is no path variable with the given name

pathVariables

java.util.Map<java.lang.String,java.lang.String> pathVariables()

Return all path variables.

Returns:

the path variables

session

<any> session()

Return the web session for the current request. Always guaranteed to return an instance either matching to the session id requested by the client, or with a new session id either because the client did not specify one or because the underlying session had expired. Use of this method does not automatically create a session.