Class MockMvcRequestBuilders
- java.lang.Object
- org.springframework.test.web.servlet.request.MockMvcRequestBuilders
public abstract class MockMvcRequestBuilders extends Object
Static factory methods forRequestBuilders
.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
Constructor Detail
MockMvcRequestBuilders
public MockMvcRequestBuilders()
Method Detail
get
public static MockHttpServletRequestBuilder get(String urlTemplate, Object... uriVars)
Create aMockHttpServletRequestBuilder
for a GET request.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables
get
public static MockHttpServletRequestBuilder get(URI uri)
Create aMockHttpServletRequestBuilder
for a GET request.- Parameters:
uri
- the URL- Since:
- 4.0.3
post
public static MockHttpServletRequestBuilder post(String urlTemplate, Object... uriVars)
Create aMockHttpServletRequestBuilder
for a POST request.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables
post
public static MockHttpServletRequestBuilder post(URI uri)
Create aMockHttpServletRequestBuilder
for a POST request.- Parameters:
uri
- the URL- Since:
- 4.0.3
put
public static MockHttpServletRequestBuilder put(String urlTemplate, Object... uriVars)
Create aMockHttpServletRequestBuilder
for a PUT request.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables
put
public static MockHttpServletRequestBuilder put(URI uri)
Create aMockHttpServletRequestBuilder
for a PUT request.- Parameters:
uri
- the URL- Since:
- 4.0.3
patch
public static MockHttpServletRequestBuilder patch(String urlTemplate, Object... uriVars)
Create aMockHttpServletRequestBuilder
for a PATCH request.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables
patch
public static MockHttpServletRequestBuilder patch(URI uri)
Create aMockHttpServletRequestBuilder
for a PATCH request.- Parameters:
uri
- the URL- Since:
- 4.0.3
delete
public static MockHttpServletRequestBuilder delete(String urlTemplate, Object... uriVars)
Create aMockHttpServletRequestBuilder
for a DELETE request.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables
delete
public static MockHttpServletRequestBuilder delete(URI uri)
Create aMockHttpServletRequestBuilder
for a DELETE request.- Parameters:
uri
- the URL- Since:
- 4.0.3
options
public static MockHttpServletRequestBuilder options(String urlTemplate, Object... uriVars)
Create aMockHttpServletRequestBuilder
for an OPTIONS request.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables
options
public static MockHttpServletRequestBuilder options(URI uri)
Create aMockHttpServletRequestBuilder
for an OPTIONS request.- Parameters:
uri
- the URL- Since:
- 4.0.3
head
public static MockHttpServletRequestBuilder head(String urlTemplate, Object... uriVars)
Create aMockHttpServletRequestBuilder
for a HEAD request.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables- Since:
- 4.1
head
public static MockHttpServletRequestBuilder head(URI uri)
Create aMockHttpServletRequestBuilder
for a HEAD request.- Parameters:
uri
- the URL- Since:
- 4.1
request
public static MockHttpServletRequestBuilder request(HttpMethod method, String urlTemplate, Object... uriVars)
Create aMockHttpServletRequestBuilder
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 encodeduriVars
- zero or more URI variables
request
public static MockHttpServletRequestBuilder request(HttpMethod httpMethod, URI uri)
Create aMockHttpServletRequestBuilder
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 methoduri
- the URL- Since:
- 4.3
fileUpload
public static MockMultipartHttpServletRequestBuilder fileUpload(String urlTemplate, Object... uriVars)
Create aMockMultipartHttpServletRequestBuilder
for a multipart request.- Parameters:
urlTemplate
- a URL template; the resulting URL will be encodeduriVars
- zero or more URI variables
fileUpload
public static MockMultipartHttpServletRequestBuilder fileUpload(URI uri)
Create aMockMultipartHttpServletRequestBuilder
for a multipart request.- Parameters:
uri
- the URL- Since:
- 4.0.3
asyncDispatch
public static RequestBuilder asyncDispatch(MvcResult mvcResult)
Create aRequestBuilder
for an async dispatch from theMvcResult
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