org.springframework.web.reactive.function

Interface Request

All Known Implementing Classes:

RequestWrapper

public interface Request

Represents an HTTP request, as handled by a HandlerFunction. Access to headers and body is offered by Request.Headers and body(BodyExtractor) respectively.

Since:

5.0

Author:

Arjen Poutsma

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
<T> Optional<T>	attribute(String name) Return the request attribute value if present.
<T> T	body(BodyExtractor<T> extractor) Extract the body with the given BodyExtractor.
Request.Headers	headers() Return the headers of this request.
org.springframework.http.HttpMethod	method() Return the HTTP method.
default String	path() Return the request path.
default Optional<String>	pathVariable(String name) Return the path variable with the given name, if present.
Map<String,String>	pathVariables() Return all path variables.
default Optional<String>	queryParam(String name) Return the first query parameter with the given name, if present.
List<String>	queryParams(String name) Return all query parameter with the given name.
URI	uri() Return the request URI.

Method Detail

method

org.springframework.http.HttpMethod method()

Return the HTTP method.

uri

URI uri()

Return the request URI.

path

default String path()

Return the request path.

headers

Request.Headers headers()

Return the headers of this request.

body

<T> T body(BodyExtractor<T> 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

attribute

<T> Optional<T> attribute(String name)

Return the request attribute value if present.

Type Parameters:

T - the attribute type

Parameters:

name - the attribute name

Returns:

the attribute value

queryParam

default Optional<String> queryParam(String name)

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

Parameters:

name - the parameter name

Returns:

the parameter value

queryParams

List<String> queryParams(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 Optional<String> pathVariable(String name)

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

Parameters:

name - the variable name

Returns:

the variable value

pathVariables

Map<String,String> pathVariables()

Return all path variables.

Returns:

the path variables