Class MockMvcRequestBuilders

java.lang.Object

org.springframework.test.web.servlet.request.MockMvcRequestBuilders

public abstract class MockMvcRequestBuilders
extends Object

Static factory methods for RequestBuilders.

Integration with the Spring TestContext Framework

Methods in this class will reuse a MockServletContext that was created by the Spring TestContext Framework.

Eclipse Users

Consider adding this class as a Java editor favorite. To navigate to this setting, open the Preferences and type "favorites".

Since:

3.2

Author:

Arjen Poutsma, Rossen Stoyanchev, Greg Turnquist, Sebastien Deleuze, Sam Brannen, Kamill Sokol

Constructor Summary

Constructors

Constructor	Description
MockMvcRequestBuilders()

Method Summary

Modifier and Type	Method	Description
static RequestBuilder	asyncDispatch(MvcResult mvcResult)	Create a RequestBuilder for an async dispatch from the MvcResult of the request that started async processing.
static MockHttpServletRequestBuilder	delete(String uriTemplate, @Nullable Object... uriVariables)	Create a MockHttpServletRequestBuilder for a DELETE request.
static MockHttpServletRequestBuilder	delete(URI uri)	Create a MockHttpServletRequestBuilder for a DELETE request.
static MockHttpServletRequestBuilder	get(String uriTemplate, @Nullable Object... uriVariables)	Create a MockHttpServletRequestBuilder for a GET request.
static MockHttpServletRequestBuilder	get(URI uri)	Create a MockHttpServletRequestBuilder for a GET request.
static MockHttpServletRequestBuilder	head(String uriTemplate, @Nullable Object... uriVariables)	Create a MockHttpServletRequestBuilder for a HEAD request.
static MockHttpServletRequestBuilder	head(URI uri)	Create a MockHttpServletRequestBuilder for a HEAD request.
static MockMultipartHttpServletRequestBuilder	multipart(String uriTemplate, @Nullable Object... uriVariables)	Create a MockMultipartHttpServletRequestBuilder for a multipart request, using POST as the HTTP method.
static MockMultipartHttpServletRequestBuilder	multipart(URI uri)	Variant of multipart(String, Object...) with a URI.
static MockMultipartHttpServletRequestBuilder	multipart(HttpMethod httpMethod, String uriTemplate, @Nullable Object... uriVariables)	Variant of multipart(String, Object...) that also accepts an HttpMethod.
static MockMultipartHttpServletRequestBuilder	multipart(HttpMethod httpMethod, URI uri)	Variant of multipart(String, Object...) with a URI and an HttpMethod.
static MockHttpServletRequestBuilder	options(String uriTemplate, @Nullable Object... uriVariables)	Create a MockHttpServletRequestBuilder for an OPTIONS request.
static MockHttpServletRequestBuilder	options(URI uri)	Create a MockHttpServletRequestBuilder for an OPTIONS request.
static MockHttpServletRequestBuilder	patch(String uriTemplate, @Nullable Object... uriVariables)	Create a MockHttpServletRequestBuilder for a PATCH request.
static MockHttpServletRequestBuilder	patch(URI uri)	Create a MockHttpServletRequestBuilder for a PATCH request.
static MockHttpServletRequestBuilder	post(String uriTemplate, @Nullable Object... uriVariables)	Create a MockHttpServletRequestBuilder for a POST request.
static MockHttpServletRequestBuilder	post(URI uri)	Create a MockHttpServletRequestBuilder for a POST request.
static MockHttpServletRequestBuilder	put(String uriTemplate, @Nullable Object... uriVariables)	Create a MockHttpServletRequestBuilder for a PUT request.
static MockHttpServletRequestBuilder	put(URI uri)	Create a MockHttpServletRequestBuilder for a PUT request.
static MockHttpServletRequestBuilder	request(String httpMethod, URI uri)	Deprecated. in favor of request(HttpMethod, URI)
static MockHttpServletRequestBuilder	request(HttpMethod method, String uriTemplate, @Nullable Object... uriVariables)	Create a MockHttpServletRequestBuilder for a request with the given HTTP method.
static MockHttpServletRequestBuilder	request(HttpMethod httpMethod, URI uri)	Create a MockHttpServletRequestBuilder for a request with the given HTTP method.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MockMvcRequestBuilders

public MockMvcRequestBuilders()

Method Details

get

public static MockHttpServletRequestBuilder get(String uriTemplate,
 @Nullable Object... uriVariables)

Create a MockHttpServletRequestBuilder for a GET request.

Parameters:

uriTemplate - a URI template; the resulting URI will be encoded

uriVariables - zero or more URI variables

get

public static MockHttpServletRequestBuilder get(URI uri)

Create a MockHttpServletRequestBuilder for a GET request.

Parameters:

uri - the URI

Since:

4.0.3

post

public static MockHttpServletRequestBuilder post(String uriTemplate,
 @Nullable Object... uriVariables)

Create a MockHttpServletRequestBuilder for a POST request.

Parameters:

uriTemplate - a URI template; the resulting URI will be encoded

uriVariables - zero or more URI variables

post

public static MockHttpServletRequestBuilder post(URI uri)

Create a MockHttpServletRequestBuilder for a POST request.

Parameters:

uri - the URI

Since:

4.0.3

put

public static MockHttpServletRequestBuilder put(String uriTemplate,
 @Nullable Object... uriVariables)

Create a MockHttpServletRequestBuilder for a PUT request.

Parameters:

uriTemplate - a URI template; the resulting URI will be encoded

uriVariables - zero or more URI variables

put

public static MockHttpServletRequestBuilder put(URI uri)

Create a MockHttpServletRequestBuilder for a PUT request.

Parameters:

uri - the URI

Since:

4.0.3

patch

public static MockHttpServletRequestBuilder patch(String uriTemplate,
 @Nullable Object... uriVariables)

Create a MockHttpServletRequestBuilder for a PATCH request.

Parameters:

uriTemplate - a URI template; the resulting URI will be encoded

uriVariables - zero or more URI variables

patch

public static MockHttpServletRequestBuilder patch(URI uri)

Create a MockHttpServletRequestBuilder for a PATCH request.

Parameters:

uri - the URI

Since:

4.0.3

delete

public static MockHttpServletRequestBuilder delete(String uriTemplate,
 @Nullable Object... uriVariables)

Create a MockHttpServletRequestBuilder for a DELETE request.

Parameters:

uriTemplate - a URI template; the resulting URI will be encoded

uriVariables - zero or more URI variables

delete

public static MockHttpServletRequestBuilder delete(URI uri)

Create a MockHttpServletRequestBuilder for a DELETE request.

Parameters:

uri - the URI

Since:

4.0.3

options

public static MockHttpServletRequestBuilder options(String uriTemplate,
 @Nullable Object... uriVariables)

Create a MockHttpServletRequestBuilder for an OPTIONS request.

Parameters:

uriTemplate - a URI template; the resulting URI will be encoded

uriVariables - zero or more URI variables

options

public static MockHttpServletRequestBuilder options(URI uri)

Create a MockHttpServletRequestBuilder for an OPTIONS request.

Parameters:

uri - the URI

Since:

4.0.3

head

public static MockHttpServletRequestBuilder head(String uriTemplate,
 @Nullable Object... uriVariables)

Create a MockHttpServletRequestBuilder for a HEAD request.

Parameters:

uriTemplate - a URI template; the resulting URI will be encoded

uriVariables - zero or more URI variables

Since:

4.1

head

public static MockHttpServletRequestBuilder head(URI uri)

Create a MockHttpServletRequestBuilder for a HEAD request.

Parameters:

uri - the URI

Since:

4.1

request

public static MockHttpServletRequestBuilder request(HttpMethod method,
 String uriTemplate,
 @Nullable Object... uriVariables)

Create a MockHttpServletRequestBuilder for a request with the given HTTP method.

Parameters:

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

uriTemplate - a URI template; the resulting URI will be encoded

uriVariables - zero or more URI variables

request

public static MockHttpServletRequestBuilder request(HttpMethod httpMethod,
 URI uri)

Create a MockHttpServletRequestBuilder for a request with the given HTTP method.

Parameters:

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

uri - the URI

Since:

4.0.3

request

@Deprecated(since="6.2")
public static MockHttpServletRequestBuilder request(String httpMethod,
 URI uri)

Deprecated.

in favor of request(HttpMethod, URI)

Alternative factory method that allows for custom HTTP verbs (for example, WebDAV).

Parameters:

httpMethod - the HTTP method

uri - the URI

Since:

4.3

multipart

public static MockMultipartHttpServletRequestBuilder multipart(String uriTemplate,
 @Nullable Object... uriVariables)

Create a MockMultipartHttpServletRequestBuilder for a multipart request, using POST as the HTTP method.

Parameters:

uriTemplate - a URI template; the resulting URI will be encoded

uriVariables - zero or more URI variables

Since:

5.0

multipart

public static MockMultipartHttpServletRequestBuilder multipart(HttpMethod httpMethod,
 String uriTemplate,
 @Nullable Object... uriVariables)

Variant of multipart(String, Object...) that also accepts an HttpMethod.

Parameters:

httpMethod - the HTTP method to use

uriTemplate - a URI template; the resulting URI will be encoded

uriVariables - zero or more URI variables

Since:

5.3.22

multipart

public static MockMultipartHttpServletRequestBuilder multipart(URI uri)

Variant of multipart(String, Object...) with a URI.

Parameters:

uri - the URI

Since:

5.0

multipart

public static MockMultipartHttpServletRequestBuilder multipart(HttpMethod httpMethod,
 URI uri)

Variant of multipart(String, Object...) with a URI and an HttpMethod.

Parameters:

httpMethod - the HTTP method to use

uri - the URI

Since:

5.3.21

asyncDispatch

public static RequestBuilder asyncDispatch(MvcResult mvcResult)

Create a RequestBuilder for an async dispatch from the MvcResult of the request that started async processing.

Usage involves performing a request that starts async processing first:

MvcResult mvcResult = this.mockMvc.perform(get("/1"))
.andExpect(request().asyncStarted())
.andReturn();
 

And then performing the async dispatch re-using the MvcResult:

this.mockMvc.perform(asyncDispatch(mvcResult))
        .andExpect(status().isOk())
        .andExpect(content().contentType(MediaType.APPLICATION_JSON))
        .andExpect(content().string("{\"name\":\"Joe\",\"someDouble\":0.0,\"someBoolean\":false}"));

Parameters:

mvcResult - the result from the request that started async processing