org.springframework.test.web.servlet.setup

Class AbstractMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

java.lang.Object

org.springframework.test.web.servlet.MockMvcBuilderSupport

org.springframework.test.web.servlet.setup.AbstractMockMvcBuilder<B>

All Implemented Interfaces:

MockMvcBuilder, ConfigurableMockMvcBuilder<B>

Direct Known Subclasses:

DefaultMockMvcBuilder, StandaloneMockMvcBuilder

public abstract class AbstractMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>
extends MockMvcBuilderSupport
implements ConfigurableMockMvcBuilder<B>

An abstract implementation of MockMvcBuilder with common methods for configuring filters, default request properties, global expectations and global result actions.

Sub-classes can use different strategies to prepare a WebApplicationContext to pass to the DispatcherServlet.

Since:

4.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
AbstractMockMvcBuilder()

Method Summary

Modifier and Type	Method and Description
<T extends B> T	addFilter(Filter filter, String... urlPatterns) Add a filter mapped to a specific set of patterns.
<T extends B> T	addFilters(Filter... filters) Add filters mapped to any request (i.e.
<T extends B> T	alwaysDo(ResultHandler resultHandler) Define a global action that should always be applied to every response.
<T extends B> T	alwaysExpect(ResultMatcher resultMatcher) Define a global expectation that should always be applied to every response.
<T extends B> T	apply(MockMvcConfigurer configurer) Add a MockMvcConfigurer that automates MockMvc setup and configures it for some specific purpose (e.g.
MockMvc	build() Build a MockMvc instance.
<T extends B> T	defaultRequest(RequestBuilder requestBuilder) Define default request properties that should be merged into all performed requests.
<T extends B> T	dispatchOptions(boolean dispatchOptions) Whether to enable the DispatcherServlet property dispatchOptionsRequest which allows processing of HTTP OPTIONS requests.
protected abstract WebApplicationContext	initWebAppContext() A method to obtain the WebApplicationContext to be passed to the DispatcherServlet.

Methods inherited from class org.springframework.test.web.servlet.MockMvcBuilderSupport

createMockMvc

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMockMvcBuilder

public AbstractMockMvcBuilder()

Method Detail

addFilters

public final <T extends B> T addFilters(Filter... filters)

Description copied from interface: ConfigurableMockMvcBuilder

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.

Specified by:

addFilters in interface ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

Parameters:

filters - the filters to add

addFilter

public final <T extends B> T addFilter(Filter filter,
                                       String... urlPatterns)

Description copied from interface: ConfigurableMockMvcBuilder

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.

Specified by:

addFilter in interface ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

Parameters:

filter - the filter to add

urlPatterns - URL patterns to map to; if empty, "/*" is used by default

defaultRequest

public final <T extends B> T defaultRequest(RequestBuilder requestBuilder)

Description copied from interface: ConfigurableMockMvcBuilder

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.

Specified by:

defaultRequest in interface ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

Parameters:

requestBuilder - a RequestBuilder; see static factory methods in MockMvcRequestBuilders .

alwaysExpect

public final <T extends B> T alwaysExpect(ResultMatcher resultMatcher)

Description copied from interface: ConfigurableMockMvcBuilder

Define a global expectation that should always be applied to every response. For example, status code 200 (OK), content type "application/json", etc.

Specified by:

alwaysExpect in interface ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

Parameters:

resultMatcher - a ResultMatcher; see static factory methods in MockMvcResultMatchers

alwaysDo

public final <T extends B> T alwaysDo(ResultHandler resultHandler)

Description copied from interface: ConfigurableMockMvcBuilder

Define a global action that should always be applied to every response. For example, writing detailed information about the performed request and resulting response to System.out.

Specified by:

alwaysDo in interface ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

Parameters:

resultHandler - a ResultHandler; see static factory methods in MockMvcResultHandlers

dispatchOptions

public final <T extends B> T dispatchOptions(boolean dispatchOptions)

Description copied from interface: ConfigurableMockMvcBuilder

Whether to enable the DispatcherServlet property dispatchOptionsRequest which allows processing of HTTP OPTIONS requests.

Specified by:

dispatchOptions in interface ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

apply

public final <T extends B> T apply(MockMvcConfigurer configurer)

Description copied from interface: ConfigurableMockMvcBuilder

Add a MockMvcConfigurer that automates MockMvc setup and configures it for some specific purpose (e.g. security).

Specified by:

apply in interface ConfigurableMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

build

public final MockMvc build()

Build a MockMvc instance.

Specified by:

build in interface MockMvcBuilder

initWebAppContext

protected abstract WebApplicationContext initWebAppContext()

A method to obtain the WebApplicationContext to be passed to the DispatcherServlet. Invoked from build() before the MockMvc instance is created.