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 ofServerRequest
.- Since:
- 5.0
- Author:
- Arjen Poutsma
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
MockServerRequest.Builder
Builder forMockServerRequest
.Nested classes/interfaces inherited from interface org.springframework.web.reactive.function.server.ServerRequest
ServerRequest.Headers
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,Object>
attributes()
Get a mutable map of request attributes.<S> S
body(BodyExtractor<S,? super ServerHttpRequest> extractor)
Extract the body with the givenBodyExtractor
.<S> S
body(BodyExtractor<S,? super ServerHttpRequest> extractor, Map<String,Object> hints)
Extract the body with the givenBodyExtractor
and hints.<S> reactor.core.publisher.Flux<S>
bodyToFlux(Class<? extends S> elementClass)
Extract the body to aFlux
.<S> reactor.core.publisher.Flux<S>
bodyToFlux(ParameterizedTypeReference<S> typeReference)
Extract the body to aFlux
.<S> reactor.core.publisher.Mono<S>
bodyToMono(Class<? extends S> elementClass)
Extract the body to aMono
.<S> reactor.core.publisher.Mono<S>
bodyToMono(ParameterizedTypeReference<S> typeReference)
Extract the body to aMono
.static MockServerRequest.Builder
builder()
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.String
methodName()
Get the name of 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.PathContainer
pathContainer()
Get the request path as aPathContainer
.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.reactor.core.publisher.Mono<WebSession>
session()
Get the web session for this request.URI
uri()
Get the request URI.UriBuilder
uriBuilder()
Get aUriBuilderComponents
from the URI associated with thisServerRequest
.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, checkNotModified, checkNotModified, checkNotModified, path, pathVariable, queryParam
Method Detail
method
public HttpMethod method()
Description copied from interface:ServerRequest
Get the HTTP method.- Specified by:
method
in interfaceServerRequest
- 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 String methodName()
Description copied from interface:ServerRequest
Get the name of the HTTP method.- Specified by:
methodName
in interfaceServerRequest
- Returns:
- the HTTP method as a String
uri
public URI uri()
Description copied from interface:ServerRequest
Get the request URI.- Specified by:
uri
in interfaceServerRequest
uriBuilder
public UriBuilder uriBuilder()
Description copied from interface:ServerRequest
Get aUriBuilderComponents
from the URI associated with thisServerRequest
.Note: as of 5.1 this method ignores
"Forwarded"
and"X-Forwarded-*"
headers that specify the client-originated address. Consider using theForwardedHeaderFilter
to extract and use, or to discard such headers.- Specified by:
uriBuilder
in interfaceServerRequest
- Returns:
- a URI builder
pathContainer
public PathContainer pathContainer()
Description copied from interface:ServerRequest
Get the request path as aPathContainer
.- Specified by:
pathContainer
in interfaceServerRequest
headers
public ServerRequest.Headers headers()
Description copied from interface:ServerRequest
Get the headers of this request.- Specified by:
headers
in interfaceServerRequest
cookies
public MultiValueMap<String,HttpCookie> cookies()
Description copied from interface:ServerRequest
Get the cookies of this request.- Specified by:
cookies
in interfaceServerRequest
remoteAddress
public Optional<InetSocketAddress> remoteAddress()
Description copied from interface:ServerRequest
Get the remote address to which this request is connected, if available.- Specified by:
remoteAddress
in interfaceServerRequest
localAddress
public Optional<InetSocketAddress> localAddress()
Description copied from interface:ServerRequest
Get the local address to which this request is connected, if available.- Specified by:
localAddress
in interfaceServerRequest
messageReaders
public List<HttpMessageReader<?>> messageReaders()
Description copied from interface:ServerRequest
Get the readers used to convert the body of this request.- Specified by:
messageReaders
in interfaceServerRequest
body
public <S> S body(BodyExtractor<S,? super ServerHttpRequest> extractor)
Description copied from interface:ServerRequest
Extract the body with the givenBodyExtractor
.- Specified by:
body
in interfaceServerRequest
- Type Parameters:
S
- the type of the body returned- Parameters:
extractor
- theBodyExtractor
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, Map<String,Object> hints)
Description copied from interface:ServerRequest
Extract the body with the givenBodyExtractor
and hints.- Specified by:
body
in interfaceServerRequest
- Type Parameters:
S
- the type of the body returned- Parameters:
extractor
- theBodyExtractor
that reads from the requesthints
- the map of hints likeJackson2CodecSupport.JSON_VIEW_HINT
to use to customize body extraction- Returns:
- the extracted body
bodyToMono
public <S> reactor.core.publisher.Mono<S> bodyToMono(Class<? extends S> elementClass)
Description copied from interface:ServerRequest
Extract the body to aMono
.- Specified by:
bodyToMono
in interfaceServerRequest
- Type Parameters:
S
- the element type- Parameters:
elementClass
- the class of element in theMono
- Returns:
- the body as a mono
bodyToMono
public <S> reactor.core.publisher.Mono<S> bodyToMono(ParameterizedTypeReference<S> typeReference)
Description copied from interface:ServerRequest
Extract the body to aMono
.- Specified by:
bodyToMono
in interfaceServerRequest
- 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> reactor.core.publisher.Flux<S> bodyToFlux(Class<? extends S> elementClass)
Description copied from interface:ServerRequest
Extract the body to aFlux
.- Specified by:
bodyToFlux
in interfaceServerRequest
- Type Parameters:
S
- the element type- Parameters:
elementClass
- the class of element in theFlux
- Returns:
- the body as a flux
bodyToFlux
public <S> reactor.core.publisher.Flux<S> bodyToFlux(ParameterizedTypeReference<S> typeReference)
Description copied from interface:ServerRequest
Extract the body to aFlux
.- Specified by:
bodyToFlux
in interfaceServerRequest
- 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 Map<String,Object> attributes()
Description copied from interface:ServerRequest
Get a mutable map of request attributes.- Specified by:
attributes
in interfaceServerRequest
- Returns:
- the request attributes
queryParams
public MultiValueMap<String,String> queryParams()
Description copied from interface:ServerRequest
Get all query parameters for this request.- Specified by:
queryParams
in interfaceServerRequest
pathVariables
public Map<String,String> pathVariables()
Description copied from interface:ServerRequest
Get all path variables for this request.- Specified by:
pathVariables
in interfaceServerRequest
session
public reactor.core.publisher.Mono<WebSession> 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 interfaceServerRequest
principal
public reactor.core.publisher.Mono<? extends Principal> principal()
Description copied from interface:ServerRequest
Get the authenticated user for the request, if any.- Specified by:
principal
in interfaceServerRequest
formData
public reactor.core.publisher.Mono<MultiValueMap<String,String>> 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 interfaceServerRequest
multipartData
public reactor.core.publisher.Mono<MultiValueMap<String,Part>> 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 interfaceServerRequest
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
andServerResponse
) can lead to irregular results.- Specified by:
exchange
in interfaceServerRequest
builder
public static MockServerRequest.Builder builder()