public final class MockServerHttpRequest
extends org.springframework.http.server.reactive.AbstractServerHttpRequest
AbstractServerHttpRequest
for use in tests without
an actual server. Use the static methods to obtain a builder.Modifier and Type | Class and Description |
---|---|
static interface |
MockServerHttpRequest.BaseBuilder<B extends MockServerHttpRequest.BaseBuilder<B>>
Request builder exposing properties not related to the body.
|
static interface |
MockServerHttpRequest.BodyBuilder
A builder that adds a body to the request.
|
Modifier and Type | Method and Description |
---|---|
static MockServerHttpRequest.BaseBuilder<?> |
delete(String urlTemplate,
Object... uriVars)
HTTP DELETE variant.
|
static MockServerHttpRequest.BaseBuilder<?> |
get(String urlTemplate,
Object... uriVars)
Create an HTTP GET builder with the given URI template.
|
reactor.core.publisher.Flux<org.springframework.core.io.buffer.DataBuffer> |
getBody() |
InetSocketAddress |
getLocalAddress() |
org.springframework.http.HttpMethod |
getMethod() |
String |
getMethodValue() |
<T> T |
getNativeRequest() |
InetSocketAddress |
getRemoteAddress() |
static MockServerHttpRequest.BaseBuilder<?> |
head(String urlTemplate,
Object... uriVars)
HTTP HEAD variant.
|
protected org.springframework.util.MultiValueMap<String,org.springframework.http.HttpCookie> |
initCookies() |
protected org.springframework.http.server.reactive.SslInfo |
initSslInfo() |
static MockServerHttpRequest.BodyBuilder |
method(org.springframework.http.HttpMethod method,
String uri,
Object... vars)
Alternative to
method(HttpMethod, URI) that accepts a URI template. |
static MockServerHttpRequest.BodyBuilder |
method(org.springframework.http.HttpMethod method,
URI url)
Create a builder with the given HTTP method and a
URI . |
static MockServerHttpRequest.BodyBuilder |
method(String httpMethod,
String uri,
Object... vars)
Create a builder with a raw HTTP method value that is outside the
range of
HttpMethod enum values. |
static MockServerHttpRequest.BaseBuilder<?> |
options(String urlTemplate,
Object... uriVars)
HTTP OPTIONS variant.
|
static MockServerHttpRequest.BodyBuilder |
patch(String urlTemplate,
Object... uriVars)
HTTP PATCH variant.
|
static MockServerHttpRequest.BodyBuilder |
post(String urlTemplate,
Object... uriVars)
HTTP POST variant.
|
static MockServerHttpRequest.BodyBuilder |
put(String urlTemplate,
Object... uriVars)
HTTP PUT variant.
|
getCookies, getHeaders, getId, getPath, getQueryParams, getSslInfo, getURI, initId, initLogPrefix, initQueryParams
@Nullable public org.springframework.http.HttpMethod getMethod()
public String getMethodValue()
@Nullable public InetSocketAddress getLocalAddress()
@Nullable public InetSocketAddress getRemoteAddress()
@Nullable protected org.springframework.http.server.reactive.SslInfo initSslInfo()
initSslInfo
in class org.springframework.http.server.reactive.AbstractServerHttpRequest
public reactor.core.publisher.Flux<org.springframework.core.io.buffer.DataBuffer> getBody()
protected org.springframework.util.MultiValueMap<String,org.springframework.http.HttpCookie> initCookies()
initCookies
in class org.springframework.http.server.reactive.AbstractServerHttpRequest
public <T> T getNativeRequest()
getNativeRequest
in class org.springframework.http.server.reactive.AbstractServerHttpRequest
public static MockServerHttpRequest.BaseBuilder<?> get(String urlTemplate, Object... uriVars)
queryParam
builder methods.urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variablespublic static MockServerHttpRequest.BaseBuilder<?> head(String urlTemplate, Object... uriVars)
get(String, Object...)
for general info.urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variablespublic static MockServerHttpRequest.BodyBuilder post(String urlTemplate, Object... uriVars)
get(String, Object...)
for general info.urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variablespublic static MockServerHttpRequest.BodyBuilder put(String urlTemplate, Object... uriVars)
get(String, Object...)
for general info.
queryParam
builder methods.urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variablespublic static MockServerHttpRequest.BodyBuilder patch(String urlTemplate, Object... uriVars)
get(String, Object...)
for general info.urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variablespublic static MockServerHttpRequest.BaseBuilder<?> delete(String urlTemplate, Object... uriVars)
get(String, Object...)
for general info.urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variablespublic static MockServerHttpRequest.BaseBuilder<?> options(String urlTemplate, Object... uriVars)
get(String, Object...)
for general info.urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variablespublic static MockServerHttpRequest.BodyBuilder method(org.springframework.http.HttpMethod method, URI url)
URI
.method
- the HTTP method (GET, POST, etc)url
- the URLpublic static MockServerHttpRequest.BodyBuilder method(org.springframework.http.HttpMethod method, String uri, Object... vars)
method(HttpMethod, URI)
that accepts a URI template.
The given URI may contain query parameters, or those may be added later via
queryParam
builder methods.method
- the HTTP method (GET, POST, etc)uri
- the URI template for the target URLvars
- variables to expand into the templatepublic static MockServerHttpRequest.BodyBuilder method(String httpMethod, String uri, Object... vars)
HttpMethod
enum values.httpMethod
- the HTTP methodValue valueuri
- the URI template for target the URLvars
- variables to expand into the template