Package org.springframework.test.web.servlet.setup

Interface ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder<B>>

Type Parameters:
B - a self reference to the builder type
All Superinterfaces:
MockMvcBuilder
All Known Implementing Classes:
AbstractMockMvcBuilder, DefaultMockMvcBuilder, RouterFunctionMockMvcBuilder, StandaloneMockMvcBuilder
public interface ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder<B>> extends MockMvcBuilder
Defines common methods for building a MockMvc.
Since:
4.1
Author:
Rossen Stoyanchev, Sam Brannen

  • Method Details

    • addFilters

      <T extends B> T addFilters(Filter... filters)
      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 addFilter(Filter, String, Map, EnumSet, String...) instead.

      Parameters:
      filters - the filters to add

    • addFilter

      <T extends B> T addFilter(Filter filter, String... urlPatterns)
      Add a filter mapped to specific patterns.

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

      Parameters:
      filter - the filter to add
      urlPatterns - the URL patterns to map to; if empty, matches all requests

    • addFilter

      <T extends B> T addFilter(Filter filter, @Nullable String filterName, Map<String,String> initParams, EnumSet<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.
      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
      Since:
      6.1
      See Also:

    • 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 in MockMvcRequestBuilders

    • defaultResponseCharacterEncoding

      default <T extends B> T defaultResponseCharacterEncoding(Charset defaultResponseCharacterEncoding)
      Define the default character encoding to be applied to every response.

      The default implementation of this method throws an UnsupportedOperationException. Concrete implementations are therefore encouraged to override this method.

      Parameters:
      defaultResponseCharacterEncoding - the default response character encoding
      Since:
      5.3.10

    • 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 in MockMvcResultMatchers

    • 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 to System.out.
      Parameters:
      resultHandler - a ResultHandler; see static factory methods in MockMvcResultHandlers

    • dispatchOptions

      <T extends B> T dispatchOptions(boolean dispatchOptions)
      Whether to enable the DispatcherServlet property dispatchOptionsRequest which allows processing of HTTP OPTIONS requests.

    • addDispatcherServletCustomizer

      <T extends B> T addDispatcherServletCustomizer(DispatcherServletCustomizer customizer)
      A more advanced variant of dispatchOptions(boolean) that allows customizing any DispatcherServlet property.
      Since:
      5.3

    • apply

      <T extends B> T apply(MockMvcConfigurer configurer)
      Add a 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.

      See Also: