org.springframework.mock.web.reactive.function.server

Class MockServerRequest

java.lang.Object

org.springframework.mock.web.reactive.function.server.MockServerRequest

All Implemented Interfaces:

ServerRequest

public final class MockServerRequest
extends java.lang.Object
implements ServerRequest

Mock implementation of ServerRequest.

Since:

5.0

Author:

Arjen Poutsma

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MockServerRequest.Builder Builder for MockServerRequest.
private static class	MockServerRequest.BuilderImpl
private static class	MockServerRequest.MockHeaders

Nested classes/interfaces inherited from interface org.springframework.web.reactive.function.server.ServerRequest

ServerRequest.Headers

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Object>	attributes
private java.lang.Object	body
private MultiValueMap<java.lang.String,HttpCookie>	cookies
private ServerWebExchange	exchange
private MockServerRequest.MockHeaders	headers
private java.util.List<HttpMessageReader<?>>	messageReaders
private HttpMethod	method
private RequestPath	pathContainer
private java.util.Map<java.lang.String,java.lang.String>	pathVariables
private java.security.Principal	principal
private MultiValueMap<java.lang.String,java.lang.String>	queryParams
private java.net.InetSocketAddress	remoteAddress
private WebSession	session
private java.net.URI	uri

Constructor Summary

Constructors

Modifier

Constructor and Description

private

MockServerRequest(HttpMethod method, java.net.URI uri, java.lang.String contextPath, MockServerRequest.MockHeaders headers, MultiValueMap<java.lang.String,HttpCookie> cookies, java.lang.Object body, java.util.Map<java.lang.String,java.lang.Object> attributes, MultiValueMap<java.lang.String,java.lang.String> queryParams, java.util.Map<java.lang.String,java.lang.String> pathVariables, WebSession session, java.security.Principal principal, java.net.InetSocketAddress remoteAddress, java.util.List<HttpMessageReader<?>> messageReaders, ServerWebExchange exchange)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	attributes() Return a mutable map of request attributes.
<S> S	body(BodyExtractor<S,? super ServerHttpRequest> extractor) Extract the body with the given BodyExtractor.
<S> S	body(BodyExtractor<S,? super ServerHttpRequest> extractor, java.util.Map<java.lang.String,java.lang.Object> hints) Extract the body with the given BodyExtractor and hints.
<S> <any>	bodyToFlux(java.lang.Class<? extends S> elementClass) Extract the body to a Flux.
<S> <any>	bodyToFlux(ParameterizedTypeReference<S> typeReference) Extract the body to a Flux.
<S> <any>	bodyToMono(java.lang.Class<? extends S> elementClass) Extract the body to a Mono.
<S> <any>	bodyToMono(ParameterizedTypeReference<S> typeReference) Extract the body to a Mono.
static MockServerRequest.Builder	builder()
MultiValueMap<java.lang.String,HttpCookie>	cookies() Return the cookies of this request.
ServerWebExchange	exchange() Return the web exchange that this request is based on.
<any>	formData() Return the form data from the body of the request if the Content-Type is "application/x-www-form-urlencoded" or an empty map otherwise.
ServerRequest.Headers	headers() Return the headers of this request.
java.util.List<HttpMessageReader<?>>	messageReaders() Return the readers used to convert the body of this request.
HttpMethod	method() Return the HTTP method.
java.lang.String	methodName() Return the name of the HTTP method.
<any>	multipartData() Return the parts of a multipart request if the Content-Type is "multipart/form-data" or an empty map otherwise.
PathContainer	pathContainer() Return the request path as PathContainer.
java.util.Map<java.lang.String,java.lang.String>	pathVariables() Return all path variables for this request.
<any>	principal() Return the authenticated user for the request, if any.
MultiValueMap<java.lang.String,java.lang.String>	queryParams() Return all query parameters for this request.
java.util.Optional<java.net.InetSocketAddress>	remoteAddress() Return the remote address where this request is connected to, if available.
<any>	session() Return the web session for this request.
java.net.URI	uri() Return the request URI.
UriBuilder	uriBuilder() Return a UriBuilderComponents from the URI associated with this ServerRequest.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.reactive.function.server.ServerRequest

attribute, create, from, path, pathVariable, queryParam

Field Detail

method

private final HttpMethod method

uri

private final java.net.URI uri

pathContainer

private final RequestPath pathContainer

headers

private final MockServerRequest.MockHeaders headers

cookies

private final MultiValueMap<java.lang.String,HttpCookie> cookies

body

@Nullable
private final java.lang.Object body

attributes

private final java.util.Map<java.lang.String,java.lang.Object> attributes

queryParams

private final MultiValueMap<java.lang.String,java.lang.String> queryParams

pathVariables

private final java.util.Map<java.lang.String,java.lang.String> pathVariables

session

@Nullable
private final WebSession session

principal

@Nullable
private java.security.Principal principal

remoteAddress

@Nullable
private final java.net.InetSocketAddress remoteAddress

messageReaders

private final java.util.List<HttpMessageReader<?>> messageReaders

exchange

@Nullable
private final ServerWebExchange exchange

Constructor Detail

MockServerRequest

private MockServerRequest(HttpMethod method,
                          java.net.URI uri,
                          java.lang.String contextPath,
                          MockServerRequest.MockHeaders headers,
                          MultiValueMap<java.lang.String,HttpCookie> cookies,
                          @Nullable
                          java.lang.Object body,
                          java.util.Map<java.lang.String,java.lang.Object> attributes,
                          MultiValueMap<java.lang.String,java.lang.String> queryParams,
                          java.util.Map<java.lang.String,java.lang.String> pathVariables,
                          @Nullable
                          WebSession session,
                          @Nullable
                          java.security.Principal principal,
                          @Nullable
                          java.net.InetSocketAddress remoteAddress,
                          java.util.List<HttpMessageReader<?>> messageReaders,
                          @Nullable
                          ServerWebExchange exchange)

Method Detail

method

public HttpMethod method()

Description copied from interface: ServerRequest

Return the HTTP method.

Specified by:

method in interface ServerRequest

Returns:

the HTTP method as an HttpMethod enum value, or null if not resolvable (e.g. in case of a non-standard HTTP method)

methodName

public java.lang.String methodName()

Description copied from interface: ServerRequest

Return the name of the HTTP method.

Specified by:

methodName in interface ServerRequest

Returns:

the HTTP method as a String

uri

public java.net.URI uri()

Description copied from interface: ServerRequest

Return the request URI.

Specified by:

uri in interface ServerRequest

uriBuilder

public UriBuilder uriBuilder()

Description copied from interface: ServerRequest

Return a UriBuilderComponents from the URI associated with this ServerRequest.

Note: as of 5.1 this method ignores "Forwarded" and "X-Forwarded-*" headers that specify the client-originated address. Consider using the ForwardedHeaderFilter to extract and use, or to discard such headers.

Specified by:

uriBuilder in interface ServerRequest

Returns:

a URI builder

pathContainer

public PathContainer pathContainer()

Description copied from interface: ServerRequest

Return the request path as PathContainer.

Specified by:

pathContainer in interface ServerRequest

headers

public ServerRequest.Headers headers()

Description copied from interface: ServerRequest

Return the headers of this request.

Specified by:

headers in interface ServerRequest

cookies

public MultiValueMap<java.lang.String,HttpCookie> cookies()

Description copied from interface: ServerRequest

Return the cookies of this request.

Specified by:

cookies in interface ServerRequest

remoteAddress

public java.util.Optional<java.net.InetSocketAddress> remoteAddress()

Description copied from interface: ServerRequest

Return the remote address where this request is connected to, if available.

Specified by:

remoteAddress in interface ServerRequest

messageReaders

public java.util.List<HttpMessageReader<?>> messageReaders()

Description copied from interface: ServerRequest

Return the readers used to convert the body of this request.

Specified by:

messageReaders in interface ServerRequest

body

public <S> S body(BodyExtractor<S,? super ServerHttpRequest> extractor)

Description copied from interface: ServerRequest

Extract the body with the given BodyExtractor.

Specified by:

body in interface ServerRequest

Type Parameters:

S - the type of the body returned

Parameters:

extractor - the BodyExtractor that reads from the request

Returns:

the extracted body

See Also:

ServerRequest.body(BodyExtractor, Map)

body

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

Description copied from interface: ServerRequest

Extract the body with the given BodyExtractor and hints.

Specified by:

body in interface ServerRequest

Type Parameters:

S - the type of the body returned

Parameters:

extractor - the BodyExtractor that reads from the request

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

Returns:

the extracted body

bodyToMono

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

Description copied from interface: ServerRequest

Extract the body to a Mono.

Specified by:

bodyToMono in interface ServerRequest

Type Parameters:

S - the element type

Parameters:

elementClass - the class of element in the Mono

Returns:

the body as a mono

bodyToMono

public <S> <any> bodyToMono(ParameterizedTypeReference<S> typeReference)

Description copied from interface: ServerRequest

Extract the body to a Mono.

Specified by:

bodyToMono in interface ServerRequest

Type Parameters:

S - the element type

Parameters:

typeReference - a type reference describing the expected response request type

Returns:

a mono containing the body of the given type T

bodyToFlux

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

Description copied from interface: ServerRequest

Extract the body to a Flux.

Specified by:

bodyToFlux in interface ServerRequest

Type Parameters:

S - the element type

Parameters:

elementClass - the class of element in the Flux

Returns:

the body as a flux

bodyToFlux

public <S> <any> bodyToFlux(ParameterizedTypeReference<S> typeReference)

Description copied from interface: ServerRequest

Extract the body to a Flux.

Specified by:

bodyToFlux in interface ServerRequest

Type Parameters:

S - the element type

Parameters:

typeReference - a type reference describing the expected request body type

Returns:

a flux containing the body of the given type T

attributes

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

Description copied from interface: ServerRequest

Return a mutable map of request attributes.

Specified by:

attributes in interface ServerRequest

Returns:

the request attributes

queryParams

public MultiValueMap<java.lang.String,java.lang.String> queryParams()

Description copied from interface: ServerRequest

Return all query parameters for this request.

Specified by:

queryParams in interface ServerRequest

pathVariables

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

Description copied from interface: ServerRequest

Return all path variables for this request.

Specified by:

pathVariables in interface ServerRequest

session

public <any> session()

Description copied from interface: ServerRequest

Return the web session for this 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.

Specified by:

session in interface ServerRequest

principal

public <any> principal()

Description copied from interface: ServerRequest

Return the authenticated user for the request, if any.

Specified by:

principal in interface ServerRequest

formData

public <any> formData()

Description copied from interface: ServerRequest

Return the form data from the body of the request if the Content-Type is "application/x-www-form-urlencoded" or an empty map otherwise.

Note: calling this method causes the request body to be read and parsed in full and the resulting MultiValueMap is cached so that this method is safe to call more than once.

Specified by:

formData in interface ServerRequest

multipartData

public <any> multipartData()

Description copied from interface: ServerRequest

Return the parts of a multipart request if the Content-Type is "multipart/form-data" or an empty map otherwise.

Note: calling this method causes the request body to be read and parsed in full and the resulting MultiValueMap is cached so that this method is safe to call more than once.

Specified by:

multipartData in interface ServerRequest

exchange

public ServerWebExchange exchange()

Description copied from interface: ServerRequest

Return the web exchange that this request is based on.

Note: Manipulating the exchange directly (instead of using the methods provided on ServerRequest and ServerResponse) can lead to irregular results.

Specified by:

exchange in interface ServerRequest

builder

public static MockServerRequest.Builder builder()