Interface ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder<B>>
- All Superinterfaces:
MockMvcBuilder
- All Known Implementing Classes:
AbstractMockMvcBuilder
,DefaultMockMvcBuilder
,StandaloneMockMvcBuilder
public interface ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder<B>> extends MockMvcBuilder
Defines common methods for building aMockMvc
.- Since:
- 4.1
- Author:
- Rossen Stoyanchev
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <T extends B>
TaddFilter(Filter filter, String... urlPatterns)
Add a filter mapped to a specific set of patterns.<T extends B>
TaddFilters(Filter... filters)
Add filters mapped to any request (i.e.<T extends B>
TalwaysDo(ResultHandler resultHandler)
Define a global action that should always be applied to every response.<T extends B>
TalwaysExpect(ResultMatcher resultMatcher)
Define a global expectation that should always be applied to every response.<T extends B>
Tapply(MockMvcConfigurer configurer)
Add aMockMvcConfigurer
that automates MockMvc setup and configures it for some specific purpose (e.g.<T extends B>
TdefaultRequest(RequestBuilder requestBuilder)
Define default request properties that should be merged into all performed requests.<T extends B>
TdispatchOptions(boolean dispatchOptions)
Whether to enable the DispatcherServlet propertydispatchOptionsRequest
which allows processing of HTTP OPTIONS requests.Methods inherited from interface org.springframework.test.web.servlet.MockMvcBuilder
build
Method Detail
addFilters
<T extends B> T addFilters(Filter... filters)
Add filters mapped to any request (i.e. "/*"). For example:mockMvcBuilder.addFilters(springSecurityFilterChain);
is the equivalent of the following web.xml configuration:
<filter-mapping> <filter-name>springSecurityFilterChain</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
Filters will be invoked in the order in which they are provided.
- Parameters:
filters
- the filters to add
addFilter
<T extends B> T addFilter(Filter filter, String... urlPatterns)
Add a filter mapped to a specific set of patterns. For example:mockMvcBuilder.addFilters(myResourceFilter, "/resources/*");
is the equivalent of:
<filter-mapping> <filter-name>myResourceFilter</filter-name> <url-pattern>/resources/*</url-pattern> </filter-mapping>
Filters will be invoked in the order in which they are provided.
- Parameters:
filter
- the filter to addurlPatterns
- URL patterns to map to; if empty, "/*" is used by default
defaultRequest
<T extends B> T defaultRequest(RequestBuilder requestBuilder)
Define default request properties that should be merged into all performed requests. In effect this provides a mechanism for defining common initialization for all requests such as the content type, request parameters, session attributes, and any other request property.Properties specified at the time of performing a request override the default properties defined here.
- Parameters:
requestBuilder
- a RequestBuilder; see static factory methods inMockMvcRequestBuilders
.
alwaysExpect
<T extends B> T alwaysExpect(ResultMatcher resultMatcher)
Define a global expectation that should always be applied to every response. For example, status code 200 (OK), content type"application/json"
, etc.- Parameters:
resultMatcher
- a ResultMatcher; see static factory methods inMockMvcResultMatchers
alwaysDo
<T extends B> T alwaysDo(ResultHandler resultHandler)
Define a global action that should always be applied to every response. For example, writing detailed information about the performed request and resulting response toSystem.out
.- Parameters:
resultHandler
- a ResultHandler; see static factory methods inMockMvcResultHandlers
dispatchOptions
<T extends B> T dispatchOptions(boolean dispatchOptions)
Whether to enable the DispatcherServlet propertydispatchOptionsRequest
which allows processing of HTTP OPTIONS requests.
apply
<T extends B> T apply(MockMvcConfigurer configurer)
Add aMockMvcConfigurer
that automates MockMvc setup and configures it for some specific purpose (e.g. security).