Class AbstractMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>

java.lang.Object

org.springframework.test.web.servlet.MockMvcBuilderSupport

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

Type Parameters:

B - a self reference to the builder type

All Implemented Interfaces:

MockMvcBuilder, ConfigurableMockMvcBuilder<B>

Direct Known Subclasses:

DefaultMockMvcBuilder, RouterFunctionMockMvcBuilder, StandaloneMockMvcBuilder

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

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

Subclasses can use different strategies to prepare the Spring WebApplicationContext that will be passed to the DispatcherServlet.

Since:

4.0

Author:

Rossen Stoyanchev, Stephane Nicoll, Sam Brannen

Constructor Summary

Constructors

Constructor	Description
AbstractMockMvcBuilder()

Method Summary

Modifier and Type	Method	Description
final <T extends B> T	addDispatcherServletCustomizer(DispatcherServletCustomizer customizer)	A more advanced variant of ConfigurableMockMvcBuilder.dispatchOptions(boolean) that allows customizing any DispatcherServlet property.
<T extends B> T	addFilter(jakarta.servlet.Filter filter, @Nullable String filterName, Map<String,String> initParams, EnumSet<jakarta.servlet.DispatcherType> dispatcherTypes, String... urlPatterns)	Add a filter that will be initialized via Filter.init(FilterConfig) with the given init parameters, and will also apply only to requests that match the given dispatcher types and URL patterns.
final <T extends B> T	addFilter(jakarta.servlet.Filter filter, String... urlPatterns)	Add a filter mapped to specific patterns.
final <T extends B> T	addFilters(jakarta.servlet.Filter... filters)	Add filters mapped to all requests.
final <T extends B> T	alwaysDo(ResultHandler resultHandler)	Define a global action that should always be applied to every response.
final <T extends B> T	alwaysExpect(ResultMatcher resultMatcher)	Define a global expectation that should always be applied to every response.
<T extends B> T	apiVersionInserter(@Nullable ApiVersionInserter versionInserter)	Set the ApiVersionInserter to use to apply to versions specified via AbstractMockHttpServletRequestBuilder.apiVersion(Object).
final <T extends B> T	apply(MockMvcConfigurer configurer)	Add a MockMvcConfigurer that automates MockMvc setup and configures it for some specific purpose (for example, security).
final MockMvc	build()	Build a MockMvc instance.
final <T extends B> T	defaultRequest(RequestBuilder requestBuilder)	Define default request properties that should be merged into all performed requests.
final <T extends B> T	defaultResponseCharacterEncoding(Charset defaultResponseCharacterEncoding)	Define the default character encoding to be applied to every response.
final <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.
protected <T extends B> T	self()

Methods inherited from class MockMvcBuilderSupport

createMockMvc, createMockMvc

Methods inherited from class Object

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

Constructor Details

AbstractMockMvcBuilder

public AbstractMockMvcBuilder()

Method Details

addFilters

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

Description copied from interface: ConfigurableMockMvcBuilder

Add filters mapped to all requests. Filters are invoked in the same order.

Note: if you need the filter to be initialized with Filter.init(FilterConfig), please use ConfigurableMockMvcBuilder.addFilter(Filter, String, Map, EnumSet, String...) instead.

Specified by:

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

Parameters:

filters - the filters to add

addFilter

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

Description copied from interface: ConfigurableMockMvcBuilder

Add a filter mapped to specific patterns.

Note: if you need the filter to be initialized with Filter.init(FilterConfig), please use ConfigurableMockMvcBuilder.addFilter(Filter, String, Map, EnumSet, String...) instead.

Specified by:

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

Parameters:

filter - the filter to add

urlPatterns - the URL patterns to map to; if empty, matches all requests

addFilter

public <T extends B> T addFilter(jakarta.servlet.Filter filter,
 @Nullable String filterName,
 Map<String,String> initParams,
 EnumSet<jakarta.servlet.DispatcherType> dispatcherTypes,
 String... urlPatterns)

Description copied from interface: ConfigurableMockMvcBuilder

Add a filter that will be initialized via Filter.init(FilterConfig) with the given init parameters, and will also apply only to requests that match the given dispatcher types and URL patterns.

Specified by:

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

Parameters:

filter - the filter to add

filterName - the name to use for the filter; if null, then MockFilterConfig is created without a name, which defaults to an empty String for the name

initParams - the init parameters to initialize the filter with

dispatcherTypes - dispatcher types the filter applies to

urlPatterns - the URL patterns to map to; if empty, matches all requests

See Also:

• MockFilterConfig

apiVersionInserter

public <T extends B> T apiVersionInserter(@Nullable ApiVersionInserter versionInserter)

Description copied from interface: ConfigurableMockMvcBuilder

Set the ApiVersionInserter to use to apply to versions specified via AbstractMockHttpServletRequestBuilder.apiVersion(Object).

ApiVersionInserter exposes shortcut methods for several built-in inserter implementation types. See the class-level Javadoc of ApiVersionInserter for a list of choices.

Specified by:

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

Parameters:

versionInserter - the inserter to use

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

defaultResponseCharacterEncoding

public final <T extends B> T defaultResponseCharacterEncoding(Charset defaultResponseCharacterEncoding)

Define the default character encoding to be applied to every response.

Specified by:

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

Parameters:

defaultResponseCharacterEncoding - the default response character encoding

Since:

5.3.10

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

addDispatcherServletCustomizer

public final <T extends B> T addDispatcherServletCustomizer(DispatcherServletCustomizer customizer)

Description copied from interface: ConfigurableMockMvcBuilder

A more advanced variant of ConfigurableMockMvcBuilder.dispatchOptions(boolean) that allows customizing any DispatcherServlet property.

Specified by:

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

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 (for example, 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.

Specified by:

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

See Also:

• SharedHttpSessionConfigurer

self

protected <T extends B> T self()

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.