public class MockServerRequest extends java.lang.Object implements ServerRequest
ServerRequest.| Modifier and Type | Class and Description |
|---|---|
static interface |
MockServerRequest.Builder
Builder for
MockServerRequest. |
ServerRequest.Headers| 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> reactor.core.publisher.Flux<S> |
bodyToFlux(java.lang.Class<? extends S> elementClass)
Extract the body to a
Flux. |
<S> reactor.core.publisher.Flux<S> |
bodyToFlux(ParameterizedTypeReference<S> typeReference)
Extract the body to a
Flux. |
<S> reactor.core.publisher.Mono<S> |
bodyToMono(java.lang.Class<? extends S> elementClass)
Extract the body to a
Mono. |
<S> reactor.core.publisher.Mono<S> |
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.
|
reactor.core.publisher.Mono<MultiValueMap<java.lang.String,java.lang.String>> |
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.
|
HttpMethod |
method()
Return the HTTP method.
|
java.lang.String |
methodName()
Return the name of the HTTP method.
|
reactor.core.publisher.Mono<MultiValueMap<java.lang.String,Part>> |
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.
|
reactor.core.publisher.Mono<? extends java.security.Principal> |
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.
|
reactor.core.publisher.Mono<WebSession> |
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, while also overlaying with values from the headers
"Forwarded" (RFC 7239),
or "X-Forwarded-Host", "X-Forwarded-Port", and "X-Forwarded-Proto" if
"Forwarded" is not found. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitattribute, create, path, pathVariable, queryParampublic HttpMethod method()
ServerRequestmethod in interface ServerRequestnull
if not resolvable (e.g. in case of a non-standard HTTP method)public java.lang.String methodName()
ServerRequestmethodName in interface ServerRequestpublic java.net.URI uri()
ServerRequesturi in interface ServerRequestpublic UriBuilder uriBuilder()
ServerRequestUriBuilderComponents from the URI associated with this
ServerRequest, while also overlaying with values from the headers
"Forwarded" (RFC 7239),
or "X-Forwarded-Host", "X-Forwarded-Port", and "X-Forwarded-Proto" if
"Forwarded" is not found.uriBuilder in interface ServerRequestpublic PathContainer pathContainer()
ServerRequestPathContainer.pathContainer in interface ServerRequestpublic ServerRequest.Headers headers()
ServerRequestheaders in interface ServerRequestpublic MultiValueMap<java.lang.String,HttpCookie> cookies()
ServerRequestcookies in interface ServerRequestpublic <S> S body(BodyExtractor<S,? super ServerHttpRequest> extractor)
ServerRequestBodyExtractor.body in interface ServerRequestS - the type of the body returnedextractor - the BodyExtractor that reads from the requestServerRequest.body(BodyExtractor, Map)public <S> S body(BodyExtractor<S,? super ServerHttpRequest> extractor, java.util.Map<java.lang.String,java.lang.Object> hints)
ServerRequestBodyExtractor and hints.body in interface ServerRequestS - the type of the body returnedextractor - the BodyExtractor that reads from the requesthints - the map of hints like Jackson2CodecSupport.JSON_VIEW_HINT
to use to customize body extractionpublic <S> reactor.core.publisher.Mono<S> bodyToMono(java.lang.Class<? extends S> elementClass)
ServerRequestMono.bodyToMono in interface ServerRequestS - the element typeelementClass - the class of element in the Monopublic <S> reactor.core.publisher.Mono<S> bodyToMono(ParameterizedTypeReference<S> typeReference)
ServerRequestMono.bodyToMono in interface ServerRequestS - the element typetypeReference - a type reference describing the expected response request typeTpublic <S> reactor.core.publisher.Flux<S> bodyToFlux(java.lang.Class<? extends S> elementClass)
ServerRequestFlux.bodyToFlux in interface ServerRequestS - the element typeelementClass - the class of element in the Fluxpublic <S> reactor.core.publisher.Flux<S> bodyToFlux(ParameterizedTypeReference<S> typeReference)
ServerRequestFlux.bodyToFlux in interface ServerRequestS - the element typetypeReference - a type reference describing the expected request body typeTpublic java.util.Map<java.lang.String,java.lang.Object> attributes()
ServerRequestattributes in interface ServerRequestpublic MultiValueMap<java.lang.String,java.lang.String> queryParams()
ServerRequestqueryParams in interface ServerRequestpublic java.util.Map<java.lang.String,java.lang.String> pathVariables()
ServerRequestpathVariables in interface ServerRequestpublic reactor.core.publisher.Mono<WebSession> session()
ServerRequestsession in interface ServerRequestpublic reactor.core.publisher.Mono<? extends java.security.Principal> principal()
ServerRequestprincipal in interface ServerRequestpublic reactor.core.publisher.Mono<MultiValueMap<java.lang.String,java.lang.String>> formData()
ServerRequest"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.
formData in interface ServerRequestpublic reactor.core.publisher.Mono<MultiValueMap<java.lang.String,Part>> multipartData()
ServerRequest"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.
multipartData in interface ServerRequestpublic static MockServerRequest.Builder builder()