Class MockserverRequest

java.lang.Object

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

All Implemented Interfaces:

serverRequest

public final class MockserverRequest
extends Object
implements serverRequest

Mock implementation of serverRequest.

since:

5.0

Author:

Arjen Poutsma

Nested Class summary

Nested Classes

Modifier and Type	Class	Description
static interface 	MockserverRequest.Builder	Builder for MockserverRequest.

Nested classes/interfaces inherited from interface serverRequest

serverRequest.Headers

Method summary

Modifier and Type	Method	Description
@Nullable ApiVersionstrategy	apiVersionstrategy()	Return the configured ApiVersionstrategy, or null.
Map<string,Object>	attributes()	Get a mutable map of request attributes.
<T>&nbsp;reactor.core.publisher.Mono<T>	bind(Class<T>&nbsp;bindType)	Bind to this request and return an instance of the given type.
<T>&nbsp;reactor.core.publisher.Mono<T>	bind(Class<T>&nbsp;bindType, Consumer<WebDataBinder>&nbsp;dataBinderCustomizer)	Bind to this request and return an instance of the given type.
<s>&nbsp;s	body(BodyExtractor<s, ? super serverHttpRequest>&nbsp;extractor)	Extract the body with the given BodyExtractor.
<s>&nbsp;s	body(BodyExtractor<s, ? super serverHttpRequest>&nbsp;extractor, Map<string,Object>&nbsp;hints)	Extract the body with the given BodyExtractor and hints.
<s>&nbsp;reactor.core.publisher.Flux<s>	bodyToFlux(Class<? extends s>&nbsp;elementClass)	Extract the body to a Flux.
<s>&nbsp;reactor.core.publisher.Flux<s>	bodyToFlux(ParameterizedTypeReference<s>&nbsp;typeReference)	Extract the body to a Flux.
<s>&nbsp;reactor.core.publisher.Mono<s>	bodyToMono(Class<? extends s>&nbsp;elementClass)	Extract the body to a Mono.
<s>&nbsp;reactor.core.publisher.Mono<s>	bodyToMono(ParameterizedTypeReference<s>&nbsp;typeReference)	Extract the body to a Mono.
static MockserverRequest.Builder	builder()	&nbsp;
MultiValueMap<string, HttpCookie>	cookies()	Get the cookies of this request.
serverWebExchange	exchange()	Get the web exchange that this request is based on.
reactor.core.publisher.Mono<MultiValueMap<string,string>>	formData()	Get 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()	Get the headers of this request.
Optional<InetsocketAddress>	localAddress()	Get the local address to which this request is connected, if available.
List<HttpMessageReader<?>>	messageReaders()	Get the readers used to convert the body of this request.
HttpMethod	method()	Get the HTTP method.
reactor.core.publisher.Mono<MultiValueMap<string,Part>>	multipartData()	Get the parts of a multipart request if the Content-Type is "multipart/form-data" or an empty map otherwise.
Map<string,string>	pathVariables()	Get all path variables for this request.
reactor.core.publisher.Mono<? extends Principal>	principal()	Get the authenticated user for the request, if any.
MultiValueMap<string,string>	queryParams()	Get all query parameters for this request.
Optional<InetsocketAddress>	remoteAddress()	Get the remote address to which this request is connected, if available.
RequestPath	requestPath()	Get the request path as a PathContainer.
reactor.core.publisher.Mono<Websession>	session()	Get the web session for this request.
URI	uri()	Get the request URI.
UriBuilder	uriBuilder()	Get a UriBuilderComponents from the URI associated with this serverRequest.

Methods inherited from class Object

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

Methods inherited from interface serverRequest

attribute, checkNotModified, checkNotModified, checkNotModified, path, pathVariable, queryParam

Method Details

method

public HttpMethod method()

Description copied from interface: serverRequest

Get the HTTP method.

specified by:

method in interface serverRequest

uri

public URI uri()

Description copied from interface: serverRequest

Get the request URI.

specified by:

uri in interface serverRequest

uriBuilder

public UriBuilder uriBuilder()

Description copied from interface: serverRequest

Get 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

requestPath

public RequestPath requestPath()

Description copied from interface: serverRequest

Get the request path as a PathContainer.

specified by:

requestPath in interface serverRequest

headers

public serverRequest.Headers headers()

Description copied from interface: serverRequest

Get the headers of this request.

specified by:

headers in interface serverRequest

cookies

public&nbsp;MultiValueMap<string, HttpCookie>&nbsp;cookies()

Description copied from interface: serverRequest

Get the cookies of this request.

specified by:

cookies in interface serverRequest

remoteAddress

public&nbsp;Optional<InetsocketAddress>&nbsp;remoteAddress()

Description copied from interface: serverRequest

Get the remote address to which this request is connected, if available.

specified by:

remoteAddress in interface serverRequest

localAddress

public&nbsp;Optional<InetsocketAddress>&nbsp;localAddress()

Description copied from interface: serverRequest

Get the local address to which this request is connected, if available.

specified by:

localAddress in interface serverRequest

messageReaders

public&nbsp;List<HttpMessageReader<?>>&nbsp;messageReaders()

Description copied from interface: serverRequest

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

specified by:

messageReaders in interface serverRequest

apiVersionstrategy

public @Nullable ApiVersionstrategy apiVersionstrategy()

Description copied from interface: serverRequest

Return the configured ApiVersionstrategy, or null.

specified by:

apiVersionstrategy in interface serverRequest

body

public&nbsp;<s>&nbsp;s&nbsp;body(BodyExtractor<s, ? super serverHttpRequest>&nbsp;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&nbsp;<s>&nbsp;s&nbsp;body(BodyExtractor<s, ? super serverHttpRequest>&nbsp;extractor,
 Map<string,Object>&nbsp;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 JacksonCodecsupport.JsON_VIEW_HINT to use to customize body extraction

Returns:

the extracted body

bodyToMono

public&nbsp;<s>&nbsp;reactor.core.publisher.Mono<s>&nbsp;bodyToMono(Class<? extends s>&nbsp;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&nbsp;<s>&nbsp;reactor.core.publisher.Mono<s>&nbsp;bodyToMono(ParameterizedTypeReference<s>&nbsp;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&nbsp;<s>&nbsp;reactor.core.publisher.Flux<s>&nbsp;bodyToFlux(Class<? extends s>&nbsp;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&nbsp;<s>&nbsp;reactor.core.publisher.Flux<s>&nbsp;bodyToFlux(ParameterizedTypeReference<s>&nbsp;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

bind

public&nbsp;<T>&nbsp;reactor.core.publisher.Mono<T>&nbsp;bind(Class<T>&nbsp;bindType)

Description copied from interface: serverRequest

Bind to this request and return an instance of the given type.

specified by:

bind in interface serverRequest

Type Parameters:

T - the type to bind to

Parameters:

bindType - the type of class to bind this request to

Returns:

a mono containing either a constructed and bound instance of bindType, or a BindException in case of binding errors

bind

public&nbsp;<T>&nbsp;reactor.core.publisher.Mono<T>&nbsp;bind(Class<T>&nbsp;bindType,
 Consumer<WebDataBinder>&nbsp;dataBinderCustomizer)

Description copied from interface: serverRequest

Bind to this request and return an instance of the given type.

specified by:

bind in interface serverRequest

Type Parameters:

T - the type to bind to

Parameters:

bindType - the type of class to bind this request to

dataBinderCustomizer - used to customize the data binder, for example, set (dis)allowed fields

Returns:

a mono containing either a constructed and bound instance of bindType, or a BindException in case of binding errors

attributes

public&nbsp;Map<string,Object>&nbsp;attributes()

Description copied from interface: serverRequest

Get a mutable map of request attributes.

specified by:

attributes in interface serverRequest

Returns:

the request attributes

queryParams

public&nbsp;MultiValueMap<string,string>&nbsp;queryParams()

Description copied from interface: serverRequest

Get all query parameters for this request.

specified by:

queryParams in interface serverRequest

pathVariables

public&nbsp;Map<string,string>&nbsp;pathVariables()

Description copied from interface: serverRequest

Get all path variables for this request.

specified by:

pathVariables in interface serverRequest

session

public&nbsp;reactor.core.publisher.Mono<Websession>&nbsp;session()

Description copied from interface: serverRequest

Get the web session for this request.

Always guaranteed to return an instance either matching 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&nbsp;reactor.core.publisher.Mono<? extends Principal>&nbsp;principal()

Description copied from interface: serverRequest

Get the authenticated user for the request, if any.

specified by:

principal in interface serverRequest

formData

public&nbsp;reactor.core.publisher.Mono<MultiValueMap<string,string>>&nbsp;formData()

Description copied from interface: serverRequest

Get 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&nbsp;reactor.core.publisher.Mono<MultiValueMap<string,Part>>&nbsp;multipartData()

Description copied from interface: serverRequest

Get 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

Get 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()