Class MockServerHttpRequest
java.lang.Object
org.springframework.http.server.reactive.AbstractServerHttpRequest
org.springframework.mock.http.server.reactive.MockServerHttpRequest
- All Implemented Interfaces:
org.springframework.http.HttpMessage
,org.springframework.http.HttpRequest
,org.springframework.http.ReactiveHttpInputMessage
,org.springframework.http.server.reactive.ServerHttpRequest
public final class MockServerHttpRequest
extends org.springframework.http.server.reactive.AbstractServerHttpRequest
Mock extension of
AbstractServerHttpRequest
for use in tests without
an actual server. Use the static methods to obtain a builder.- Since:
- 5.0
- Author:
- Rossen Stoyanchev
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Request builder exposing properties not related to the body.static interface
A builder that adds a body to the request.Nested classes/interfaces inherited from interface org.springframework.http.server.reactive.ServerHttpRequest
org.springframework.http.server.reactive.ServerHttpRequest.Builder
-
Method Summary
Modifier and TypeMethodDescriptionstatic MockServerHttpRequest.BaseBuilder<?>
HTTP DELETE variant.static MockServerHttpRequest.BaseBuilder<?>
Create an HTTP GET builder with the given URI template.reactor.core.publisher.Flux<org.springframework.core.io.buffer.DataBuffer>
getBody()
org.springframework.http.HttpMethod
<T> T
static MockServerHttpRequest.BaseBuilder<?>
HTTP HEAD variant.protected org.springframework.util.MultiValueMap<String,
org.springframework.http.HttpCookie> protected org.springframework.http.server.reactive.SslInfo
Deprecated.Alternative tomethod(HttpMethod, URI)
that accepts a URI template.Create a builder with the given HTTP method and aURI
.static MockServerHttpRequest.BaseBuilder<?>
HTTP OPTIONS variant.HTTP PATCH variant.HTTP POST variant.HTTP PUT variant.Methods inherited from class org.springframework.http.server.reactive.AbstractServerHttpRequest
getCookies, getHeaders, getId, getPath, getQueryParams, getSslInfo, getURI, initId, initLogPrefix, initQueryParams
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.http.HttpRequest
getMethodValue
Methods inherited from interface org.springframework.http.server.reactive.ServerHttpRequest
mutate
-
Method Details
-
getMethod
public org.springframework.http.HttpMethod getMethod() -
getLocalAddress
-
getRemoteAddress
-
initSslInfo
@Nullable protected org.springframework.http.server.reactive.SslInfo initSslInfo()- Specified by:
initSslInfo
in classorg.springframework.http.server.reactive.AbstractServerHttpRequest
-
getBody
public reactor.core.publisher.Flux<org.springframework.core.io.buffer.DataBuffer> getBody() -
initCookies
protected org.springframework.util.MultiValueMap<String,org.springframework.http.HttpCookie> initCookies()- Specified by:
initCookies
in classorg.springframework.http.server.reactive.AbstractServerHttpRequest
-
getNativeRequest
public <T> T getNativeRequest()- Specified by:
getNativeRequest
in classorg.springframework.http.server.reactive.AbstractServerHttpRequest
-
get
Create an HTTP GET builder with the given URI template. The given URI may contain query parameters, or those may be added later viaqueryParam
builder methods.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables- Returns:
- the created builder
-
head
HTTP HEAD variant. Seeget(String, Object...)
for general info.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables- Returns:
- the created builder
-
post
HTTP POST variant. Seeget(String, Object...)
for general info.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables- Returns:
- the created builder
-
put
HTTP PUT variant. Seeget(String, Object...)
for general info.queryParam
builder methods.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables- Returns:
- the created builder
-
patch
HTTP PATCH variant. Seeget(String, Object...)
for general info.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables- Returns:
- the created builder
-
delete
HTTP DELETE variant. Seeget(String, Object...)
for general info.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables- Returns:
- the created builder
-
options
HTTP OPTIONS variant. Seeget(String, Object...)
for general info.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables- Returns:
- the created builder
-
method
public static MockServerHttpRequest.BodyBuilder method(org.springframework.http.HttpMethod method, URI url) Create a builder with the given HTTP method and aURI
.- Parameters:
method
- the HTTP method (GET, POST, etc)url
- the URL- Returns:
- the created builder
-
method
public static MockServerHttpRequest.BodyBuilder method(org.springframework.http.HttpMethod method, String uri, Object... vars) Alternative tomethod(HttpMethod, URI)
that accepts a URI template. The given URI may contain query parameters, or those may be added later viaqueryParam
builder methods.- Parameters:
method
- the HTTP method (GET, POST, etc)uri
- the URI template for the target URLvars
- variables to expand into the template- Returns:
- the created builder
-
method
@Deprecated(since="6.0") public static MockServerHttpRequest.BodyBuilder method(String httpMethod, String uri, Object... vars) Deprecated.as of Spring Framework 6.0 in favor ofmethod(HttpMethod, String, Object...)
Create a builder with a raw HTTP method value that is outside the range ofHttpMethod
enum values.- Parameters:
httpMethod
- the HTTP methodValue valueuri
- the URI template for target the URLvars
- variables to expand into the template- Returns:
- the created builder
- Since:
- 5.2.7
-
method(HttpMethod, String, Object...)