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

All Methods Static Methods Concrete Methods Deprecated Methods
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 urlTemplate, Object... uriVars)`	Create a `MockHttpServletRequestBuilder` for a DELETE request.
`static MockHttpServletRequestBuilder`	`delete(URI uri)`	Create a `MockHttpServletRequestBuilder` for a DELETE request.
`static MockMultipartHttpServletRequestBuilder`	`fileUpload(String urlTemplate, Object... uriVars)`	Deprecated. in favor of `multipart(String, Object...)`
`static MockMultipartHttpServletRequestBuilder`	`fileUpload(URI uri)`	Deprecated. in favor of `multipart(URI)`
`static MockHttpServletRequestBuilder`	`get(String urlTemplate, Object... uriVars)`	Create a `MockHttpServletRequestBuilder` for a GET request.
`static MockHttpServletRequestBuilder`	`get(URI uri)`	Create a `MockHttpServletRequestBuilder` for a GET request.
`static MockHttpServletRequestBuilder`	`head(String urlTemplate, Object... uriVars)`	Create a `MockHttpServletRequestBuilder` for a HEAD request.
`static MockHttpServletRequestBuilder`	`head(URI uri)`	Create a `MockHttpServletRequestBuilder` for a HEAD request.
`static MockMultipartHttpServletRequestBuilder`	`multipart(String urlTemplate, Object... uriVars)`	Create a `MockMultipartHttpServletRequestBuilder` for a multipart request.
`static MockMultipartHttpServletRequestBuilder`	`multipart(URI uri)`	Create a `MockMultipartHttpServletRequestBuilder` for a multipart request.
`static MockHttpServletRequestBuilder`	`options(String urlTemplate, Object... uriVars)`	Create a `MockHttpServletRequestBuilder` for an OPTIONS request.
`static MockHttpServletRequestBuilder`	`options(URI uri)`	Create a `MockHttpServletRequestBuilder` for an OPTIONS request.
`static MockHttpServletRequestBuilder`	`patch(String urlTemplate, Object... uriVars)`	Create a `MockHttpServletRequestBuilder` for a PATCH request.
`static MockHttpServletRequestBuilder`	`patch(URI uri)`	Create a `MockHttpServletRequestBuilder` for a PATCH request.
`static MockHttpServletRequestBuilder`	`post(String urlTemplate, Object... uriVars)`	Create a `MockHttpServletRequestBuilder` for a POST request.
`static MockHttpServletRequestBuilder`	`post(URI uri)`	Create a `MockHttpServletRequestBuilder` for a POST request.
`static MockHttpServletRequestBuilder`	`put(String urlTemplate, Object... uriVars)`	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)`	Alternative factory method that allows for custom HTTP verbs (e.g.
`static MockHttpServletRequestBuilder`	`request(HttpMethod method, String urlTemplate, Object... uriVars)`	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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- MockMvcRequestBuilders
```
public MockMvcRequestBuilders()
```

Method Detail

get

public static MockHttpServletRequestBuilder get(String urlTemplate,
                                                Object... uriVars)

Create a MockHttpServletRequestBuilder for a GET request.

Parameters:: urlTemplate - a URL template; the resulting URL will be encoded; uriVars - zero or more URI variables

get
```
public static MockHttpServletRequestBuilder get(URI uri)
```
Create a MockHttpServletRequestBuilder for a GET request.
Parameters:
uri - the URL
Since:
4.0.3

post

public static MockHttpServletRequestBuilder post(String urlTemplate,
                                                 Object... uriVars)

Create a MockHttpServletRequestBuilder for a POST request.

Parameters:: urlTemplate - a URL template; the resulting URL will be encoded; uriVars - zero or more URI variables

post
```
public static MockHttpServletRequestBuilder post(URI uri)
```
Create a MockHttpServletRequestBuilder for a POST request.
Parameters:
uri - the URL
Since:
4.0.3

put

public static MockHttpServletRequestBuilder put(String urlTemplate,
                                                Object... uriVars)

Create a MockHttpServletRequestBuilder for a PUT request.

Parameters:: urlTemplate - a URL template; the resulting URL will be encoded; uriVars - zero or more URI variables

put
```
public static MockHttpServletRequestBuilder put(URI uri)
```
Create a MockHttpServletRequestBuilder for a PUT request.
Parameters:
uri - the URL
Since:
4.0.3

patch

public static MockHttpServletRequestBuilder patch(String urlTemplate,
                                                  Object... uriVars)

Create a MockHttpServletRequestBuilder for a PATCH request.

Parameters:: urlTemplate - a URL template; the resulting URL will be encoded; uriVars - zero or more URI variables

patch
```
public static MockHttpServletRequestBuilder patch(URI uri)
```
Create a MockHttpServletRequestBuilder for a PATCH request.
Parameters:
uri - the URL
Since:
4.0.3

delete

public static MockHttpServletRequestBuilder delete(String urlTemplate,
                                                   Object... uriVars)

Create a MockHttpServletRequestBuilder for a DELETE request.

Parameters:: urlTemplate - a URL template; the resulting URL will be encoded; uriVars - zero or more URI variables

delete
```
public static MockHttpServletRequestBuilder delete(URI uri)
```
Create a MockHttpServletRequestBuilder for a DELETE request.
Parameters:
uri - the URL
Since:
4.0.3

options

public static MockHttpServletRequestBuilder options(String urlTemplate,
                                                    Object... uriVars)

Create a MockHttpServletRequestBuilder for an OPTIONS request.

Parameters:: urlTemplate - a URL template; the resulting URL will be encoded; uriVars - zero or more URI variables

options
```
public static MockHttpServletRequestBuilder options(URI uri)
```
Create a MockHttpServletRequestBuilder for an OPTIONS request.
Parameters:
uri - the URL
Since:
4.0.3

head

public static MockHttpServletRequestBuilder head(String urlTemplate,
                                                 Object... uriVars)

Create a MockHttpServletRequestBuilder for a HEAD request.

Parameters:: urlTemplate - a URL template; the resulting URL will be encoded; uriVars - 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 URL
Since:
4.1

request

public static MockHttpServletRequestBuilder request(HttpMethod method,
                                                    String urlTemplate,
                                                    Object... uriVars)

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

Parameters:: method - the HTTP method (GET, POST, etc); urlTemplate - a URL template; the resulting URL will be encoded; uriVars - 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 URL
Since:: 4.0.3

request

public static MockHttpServletRequestBuilder request(String httpMethod,
                                                    URI uri)

Alternative factory method that allows for custom HTTP verbs (e.g. WebDAV).

Parameters:: httpMethod - the HTTP method; uri - the URL
Since:: 4.3

multipart

public static MockMultipartHttpServletRequestBuilder multipart(String urlTemplate,
                                                               Object... uriVars)

Create a MockMultipartHttpServletRequestBuilder for a multipart request.

Parameters:: urlTemplate - a URL template; the resulting URL will be encoded; uriVars - zero or more URI variables
Since:: 5.0

multipart
```
public static MockMultipartHttpServletRequestBuilder multipart(URI uri)
```
Create a MockMultipartHttpServletRequestBuilder for a multipart request.
Parameters:
uri - the URL
Since:
5.0

fileUpload

@Deprecated
public static MockMultipartHttpServletRequestBuilder fileUpload(String urlTemplate,
                                                                Object... uriVars)

Deprecated.

in favor of multipart(String, Object...)

Create a MockMultipartHttpServletRequestBuilder for a multipart request.

Parameters:: urlTemplate - a URL template; the resulting URL will be encoded; uriVars - zero or more URI variables

fileUpload
```
@Deprecated
public static MockMultipartHttpServletRequestBuilder fileUpload(URI uri)
```
Deprecated.
in favor of multipart(URI)
Create a MockMultipartHttpServletRequestBuilder for a multipart request.
Parameters:
uri - the URL
Since:
4.0.3

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

Class MockMvcRequestBuilders

Integration with the Spring TestContext Framework

Eclipse Users

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockMvcRequestBuilders

Method Detail

get

get

post

post

put

put

patch

patch

delete

delete

options

options

head

head

request

request

request

multipart

multipart

fileUpload

fileUpload

asyncDispatch