B
- a self reference to the builder typepublic interface ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder<B>> extends MockMvcBuilder
MockMvc
.Modifier and Type | Method and Description |
---|---|
<T extends B> |
addDispatcherServletCustomizer(DispatcherServletCustomizer customizer)
A more advanced variant of
dispatchOptions(boolean) that allows
customizing any DispatcherServlet
property. |
<T extends B> |
addFilter(Filter filter,
String... urlPatterns)
Add a filter mapped to a specific set of patterns.
|
<T extends B> |
addFilters(Filter... filters)
Add filters mapped to any request (i.e.
|
<T extends B> |
alwaysDo(ResultHandler resultHandler)
Define a global action that should always be applied to every
response.
|
<T extends B> |
alwaysExpect(ResultMatcher resultMatcher)
Define a global expectation that should always be applied to
every response.
|
<T extends B> |
apply(MockMvcConfigurer configurer)
Add a
MockMvcConfigurer that automates MockMvc setup and
configures it for some specific purpose (e.g. |
<T extends B> |
defaultRequest(RequestBuilder requestBuilder)
Define default request properties that should be merged into all
performed requests.
|
default <T extends B> |
defaultResponseCharacterEncoding(Charset defaultResponseCharacterEncoding)
Define the default character encoding to be applied to every response.
|
<T extends B> |
dispatchOptions(boolean dispatchOptions)
Whether to enable the DispatcherServlet property
dispatchOptionsRequest which allows processing of HTTP OPTIONS requests. |
build
<T extends B> T addFilters(Filter... filters)
mockMvcBuilder.addFilters(springSecurityFilterChain);
It 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.
filters
- the filters to add<T extends B> T addFilter(Filter filter, String... urlPatterns)
mockMvcBuilder.addFilter(myResourceFilter, "/resources/*");
It 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.
filter
- the filter to addurlPatterns
- the URL patterns to map to; if empty, "/*" is used by default<T extends B> T defaultRequest(RequestBuilder requestBuilder)
Properties specified at the time of performing a request override the default properties defined here.
requestBuilder
- a RequestBuilder; see static factory methods in
MockMvcRequestBuilders
default <T extends B> T defaultResponseCharacterEncoding(Charset defaultResponseCharacterEncoding)
The default implementation of this method throws an
UnsupportedOperationException
. Concrete implementations are therefore
encouraged to override this method.
defaultResponseCharacterEncoding
- the default response character encoding<T extends B> T alwaysExpect(ResultMatcher resultMatcher)
"application/json"
, etc.resultMatcher
- a ResultMatcher; see static factory methods in
MockMvcResultMatchers
<T extends B> T alwaysDo(ResultHandler resultHandler)
System.out
.resultHandler
- a ResultHandler; see static factory methods in
MockMvcResultHandlers
<T extends B> T dispatchOptions(boolean dispatchOptions)
dispatchOptionsRequest
which allows processing of HTTP OPTIONS requests.<T extends B> T addDispatcherServletCustomizer(DispatcherServletCustomizer customizer)
dispatchOptions(boolean)
that allows
customizing any DispatcherServlet
property.<T extends B> T apply(MockMvcConfigurer configurer)
MockMvcConfigurer
that automates MockMvc setup and
configures it for some specific purpose (e.g. security).
There is a built-in SharedHttpSessionConfigurer
that can be
used to re-use the HTTP session across requests. 3rd party frameworks
like Spring Security also use this mechanism to provide configuration
shortcuts.
SharedHttpSessionConfigurer