org.springframework.mock.http.server.reactive

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 class MockServerHttpRequest
extends org.springframework.http.server.reactive.AbstractServerHttpRequest

Mock extension of AbstractServerHttpRequest for use in tests without an actual server.

Use the static builder methods in this class to create an instance possibly further creating a MockServerWebExchange via toExchange().

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from interface org.springframework.http.server.reactive.ServerHttpRequest

org.springframework.http.server.reactive.ServerHttpRequest.Builder

Method Summary

Modifier and Type	Method and Description
static MockServerHttpRequest.BaseBuilder<?>	delete(String urlTemplate, Object... uriVars) Create an HTTP DELETE builder with the given url.
static MockServerHttpRequest.BaseBuilder<?>	get(String urlTemplate, Object... uriVars) Create an HTTP GET builder with the given url.
reactor.core.publisher.Flux<org.springframework.core.io.buffer.DataBuffer>	getBody()
org.springframework.http.HttpMethod	getMethod()
String	getMethodValue()
InetSocketAddress	getRemoteAddress()
static MockServerHttpRequest.BaseBuilder<?>	head(String urlTemplate, Object... uriVars) Create an HTTP HEAD builder with the given url.
protected org.springframework.util.MultiValueMap<String,org.springframework.http.HttpCookie>	initCookies()
static MockServerHttpRequest.BodyBuilder	method(org.springframework.http.HttpMethod method, String urlTemplate, 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.BaseBuilder<?>	options(String urlTemplate, Object... uriVars) Creates an HTTP OPTIONS builder with the given url.
static MockServerHttpRequest.BodyBuilder	patch(String urlTemplate, Object... uriVars) Create an HTTP PATCH builder with the given url.
static MockServerHttpRequest.BodyBuilder	post(String urlTemplate, Object... uriVars) Create an HTTP POST builder with the given url.
static MockServerHttpRequest.BodyBuilder	put(String urlTemplate, Object... uriVars) Create an HTTP PUT builder with the given url.
MockServerWebExchange	toExchange() Shortcut to wrap the request with a MockServerWebExchange.

Methods inherited from class org.springframework.http.server.reactive.AbstractServerHttpRequest

getCookies, getHeaders, getPath, getQueryParams, getURI, 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.server.reactive.ServerHttpRequest

mutate

Method Detail

getMethod

public org.springframework.http.HttpMethod getMethod()

getMethodValue

public String getMethodValue()

getRemoteAddress

@Nullable
public InetSocketAddress getRemoteAddress()

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 class org.springframework.http.server.reactive.AbstractServerHttpRequest

toExchange

public MockServerWebExchange toExchange()

Shortcut to wrap the request with a MockServerWebExchange.

method

public static MockServerHttpRequest.BodyBuilder method(org.springframework.http.HttpMethod method,
                                                       URI url)

Create a builder with the given HTTP method and a URI.

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 urlTemplate,
                                                       Object... vars)

Alternative to method(HttpMethod, URI) that accepts a URI template.

Parameters:

method - the HTTP method (GET, POST, etc)

urlTemplate - the URL template

vars - variables to expand into the template

Returns:

the created builder

get

public static MockServerHttpRequest.BaseBuilder<?> get(String urlTemplate,
                                                       Object... uriVars)

Create an HTTP GET builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

head

public static MockServerHttpRequest.BaseBuilder<?> head(String urlTemplate,
                                                        Object... uriVars)

Create an HTTP HEAD builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

post

public static MockServerHttpRequest.BodyBuilder post(String urlTemplate,
                                                     Object... uriVars)

Create an HTTP POST builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

put

public static MockServerHttpRequest.BodyBuilder put(String urlTemplate,
                                                    Object... uriVars)

Create an HTTP PUT builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

patch

public static MockServerHttpRequest.BodyBuilder patch(String urlTemplate,
                                                      Object... uriVars)

Create an HTTP PATCH builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

delete

public static MockServerHttpRequest.BaseBuilder<?> delete(String urlTemplate,
                                                          Object... uriVars)

Create an HTTP DELETE builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

options

public static MockServerHttpRequest.BaseBuilder<?> options(String urlTemplate,
                                                           Object... uriVars)

Creates an HTTP OPTIONS builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder