org.springframework.test.web.servlet

Class MockMvc

java.lang.Object

org.springframework.test.web.servlet.MockMvc

public final class MockMvc
extends java.lang.Object

Main entry point for server-side Spring MVC test support.

Below is an example:

 static imports:
 MockMvcBuilders.*, MockMvcRequestBuilders.*, MockMvcResultMatchers.*

 WebApplicationContext wac = ...;

 MockMvc mockMvc = webAppContextSetup(wac).build();

 mockMvc.perform(get("/form"))
     .andExpect(status().isOk())
     .andExpect(content().mimeType("text/html"))
     .andExpect(forwardedUrl("/WEB-INF/layouts/main.jsp"));
 

Since:

3.2

Author:

Rossen Stoyanchev, Rob Winch, Sam Brannen

Field Summary

Fields

Modifier and Type	Field and Description
private RequestBuilder	defaultRequestBuilder
private java.util.List<ResultHandler>	defaultResultHandlers
private java.util.List<ResultMatcher>	defaultResultMatchers
private Filter[]	filters
(package private) static java.lang.String	MVC_RESULT_ATTRIBUTE
private TestDispatcherServlet	servlet
private ServletContext	servletContext

Constructor Summary

Constructors

Constructor and Description
MockMvc(TestDispatcherServlet servlet, Filter[] filters, ServletContext servletContext) Private constructor, not for direct instantiation.

Method Summary

Modifier and Type	Method and Description
private void	applyDefaultResultActions(MvcResult mvcResult)
ResultActions	perform(RequestBuilder requestBuilder) Perform a request and return a type that allows chaining further actions, such as asserting expectations, on the result.
(package private) void	setDefaultRequest(RequestBuilder requestBuilder) A default request builder merged into every performed request.
(package private) void	setGlobalResultHandlers(java.util.List<ResultHandler> resultHandlers) General actions to apply after every performed request.
(package private) void	setGlobalResultMatchers(java.util.List<ResultMatcher> resultMatchers) Expectations to assert after every performed request.

Methods inherited from class java.lang.Object

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

Field Detail

MVC_RESULT_ATTRIBUTE

static java.lang.String MVC_RESULT_ATTRIBUTE

servlet

private final TestDispatcherServlet servlet

filters

private final Filter[] filters

servletContext

private final ServletContext servletContext

defaultRequestBuilder

private RequestBuilder defaultRequestBuilder

defaultResultMatchers

private java.util.List<ResultMatcher> defaultResultMatchers

defaultResultHandlers

private java.util.List<ResultHandler> defaultResultHandlers

Constructor Detail

MockMvc

MockMvc(TestDispatcherServlet servlet,
        Filter[] filters,
        ServletContext servletContext)

Private constructor, not for direct instantiation.

See Also:

MockMvcBuilders

Method Detail

setDefaultRequest

void setDefaultRequest(RequestBuilder requestBuilder)

A default request builder merged into every performed request.

See Also:

AbstractMockMvcBuilder.defaultRequest(RequestBuilder)

setGlobalResultMatchers

void setGlobalResultMatchers(java.util.List<ResultMatcher> resultMatchers)

Expectations to assert after every performed request.

See Also:

AbstractMockMvcBuilder.alwaysExpect(ResultMatcher)

setGlobalResultHandlers

void setGlobalResultHandlers(java.util.List<ResultHandler> resultHandlers)

General actions to apply after every performed request.

See Also:

AbstractMockMvcBuilder.alwaysDo(ResultHandler)

perform

public ResultActions perform(RequestBuilder requestBuilder)
                      throws java.lang.Exception

Perform a request and return a type that allows chaining further actions, such as asserting expectations, on the result.

Parameters:

requestBuilder - used to prepare the request to execute; see static factory methods in MockMvcRequestBuilders

Returns:

an instance of ResultActions; never null

Throws:

java.lang.Exception

See Also:

MockMvcRequestBuilders, MockMvcResultMatchers

applyDefaultResultActions

private void applyDefaultResultActions(MvcResult mvcResult)
                                throws java.lang.Exception

Throws:

java.lang.Exception