org.springframework.test.web.servlet.setup

Interface MockMvcConfigurer

All Known Implementing Classes:

MockMvcConfigurerAdapter, SharedHttpSessionConfigurer

public interface MockMvcConfigurer

Contract for customizing a ConfigurableMockMvcBuilder in some specific way, e.g. a 3rd party library that wants to provide shortcuts for setting up a MockMvc.

An implementation of this interface can be plugged in via ConfigurableMockMvcBuilder.apply(org.springframework.test.web.servlet.setup.MockMvcConfigurer) with instances of this type likely created via static methods, e.g.:

 import static org.example.ExampleSetup.mySetup;

 // ...

 MockMvcBuilders.webAppContextSetup(context).apply(mySetup("foo","bar")).build();
 

Since:

4.1

Author:

Rossen Stoyanchev

See Also:

MockMvcConfigurerAdapter

Method Summary

Modifier and Type	Method and Description
default void	afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder) Invoked immediately when this MockMvcConfigurer is added via ConfigurableMockMvcBuilder.apply(org.springframework.test.web.servlet.setup.MockMvcConfigurer).
default RequestPostProcessor	beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder, WebApplicationContext context) Invoked when the MockMvc instance is about to be created with the MockMvc builder and the Spring WebApplicationContext that will be passed to the DispatcherServlet.

Method Detail

afterConfigurerAdded

default void afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder)

Invoked immediately when this MockMvcConfigurer is added via ConfigurableMockMvcBuilder.apply(org.springframework.test.web.servlet.setup.MockMvcConfigurer).

Parameters:

builder - the builder for the MockMvc

beforeMockMvcCreated

@Nullable
default RequestPostProcessor beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder,
                                                            WebApplicationContext context)

Invoked when the MockMvc instance is about to be created with the MockMvc builder and the Spring WebApplicationContext that will be passed to the DispatcherServlet.

Parameters:

builder - the builder for the MockMvc

context - the Spring configuration

Returns:

a post processor to be applied to every request performed through the MockMvc instance.