Class StandaloneMockMvcBuilder

Constructor Detail

• StandaloneMockMvcBuilder

  protected StandaloneMockMvcBuilder​(Object... controllers)

  Protected constructor. Not intended for direct instantiation.

  See Also:

  MockMvcBuilders.standaloneSetup(Object...)

Method Detail

• setControllerAdvice

  public StandaloneMockMvcBuilder setControllerAdvice​(Object... controllerAdvice)

  Register one or more ControllerAdvice instances to be used in tests.

  Normally @ControllerAdvice are auto-detected as long as they're declared as Spring beans. However since the standalone setup does not load any Spring config, they need to be registered explicitly here instead much like controllers.

  Since:

  4.2

• setMessageConverters

  public StandaloneMockMvcBuilder setMessageConverters​(HttpMessageConverter<?>... messageConverters)

  Set the message converters to use in argument resolvers and in return value handlers, which support reading and/or writing to the body of the request and response. If no message converters are added to the list, a default list of converters is added instead.

• setValidator

  public StandaloneMockMvcBuilder setValidator​(Validator validator)

  Provide a custom Validator instead of the one created by default. The default implementation used, assuming JSR-303 is on the classpath, is LocalValidatorFactoryBean.

• setConversionService

  public StandaloneMockMvcBuilder setConversionService​(FormattingConversionService conversionService)

  Provide a conversion service with custom formatters and converters. If not set, a DefaultFormattingConversionService is used by default.

• addInterceptors

  public StandaloneMockMvcBuilder addInterceptors​(HandlerInterceptor... interceptors)

  Add interceptors mapped to all incoming requests.

• addMappedInterceptors

  public StandaloneMockMvcBuilder addMappedInterceptors​(String[] pathPatterns,
                                                        HandlerInterceptor... interceptors)

  Add interceptors mapped to a set of path patterns.

• setContentNegotiationManager

  public StandaloneMockMvcBuilder setContentNegotiationManager​(ContentNegotiationManager manager)

  Set a ContentNegotiationManager.

• setAsyncRequestTimeout

  public StandaloneMockMvcBuilder setAsyncRequestTimeout​(long timeout)

  Specify the timeout value for async execution. In Spring MVC Test, this value is used to determine how to long to wait for async execution to complete so that a test can verify the results synchronously.

  Parameters:

  timeout - the timeout value in milliseconds

• setCustomArgumentResolvers

  public StandaloneMockMvcBuilder setCustomArgumentResolvers​(HandlerMethodArgumentResolver... argumentResolvers)

  Provide custom resolvers for controller method arguments.

• setCustomReturnValueHandlers

  public StandaloneMockMvcBuilder setCustomReturnValueHandlers​(HandlerMethodReturnValueHandler... handlers)

  Provide custom handlers for controller method return values.

• setHandlerExceptionResolvers

  public StandaloneMockMvcBuilder setHandlerExceptionResolvers​(List<HandlerExceptionResolver> exceptionResolvers)

  Set the HandlerExceptionResolver types to use as a list.

• setHandlerExceptionResolvers

  public StandaloneMockMvcBuilder setHandlerExceptionResolvers​(HandlerExceptionResolver... exceptionResolvers)

  Set the HandlerExceptionResolver types to use as an array.

• setViewResolvers

  public StandaloneMockMvcBuilder setViewResolvers​(ViewResolver... resolvers)

  Set up view resolution with the given ViewResolvers. If not set, an InternalResourceViewResolver is used by default.

• setSingleView

  public StandaloneMockMvcBuilder setSingleView​(View view)

  Sets up a single ViewResolver that always returns the provided view instance. This is a convenient shortcut if you need to use one View instance only -- e.g. rendering generated content (JSON, XML, Atom).

• setLocaleResolver

  public StandaloneMockMvcBuilder setLocaleResolver​(LocaleResolver localeResolver)

  Provide a LocaleResolver instance. If not provided, the default one used is AcceptHeaderLocaleResolver.

• setFlashMapManager

  public StandaloneMockMvcBuilder setFlashMapManager​(FlashMapManager flashMapManager)

  Provide a custom FlashMapManager instance. If not provided, SessionFlashMapManager is used by default.

• setUseSuffixPatternMatch

  public StandaloneMockMvcBuilder setUseSuffixPatternMatch​(boolean useSuffixPatternMatch)

  Whether to use suffix pattern match (".*") when matching patterns to requests. If enabled a method mapped to "/users" also matches to "/users.*".

  The default value is true.

• setUseTrailingSlashPatternMatch

  public StandaloneMockMvcBuilder setUseTrailingSlashPatternMatch​(boolean useTrailingSlashPatternMatch)

  Whether to match to URLs irrespective of the presence of a trailing slash. If enabled a method mapped to "/users" also matches to "/users/".

  The default value is true.

• setRemoveSemicolonContent

  public StandaloneMockMvcBuilder setRemoveSemicolonContent​(boolean removeSemicolonContent)

  Set if ";" (semicolon) content should be stripped from the request URI. The value, if provided, is in turn set on AbstractHandlerMapping.setRemoveSemicolonContent(boolean).

• addPlaceholderValue

  public StandaloneMockMvcBuilder addPlaceholderValue​(String name,
                                                      String value)

  In a standalone setup there is no support for placeholder values embedded in request mappings. This method allows manually provided placeholder values so they can be resolved. Alternatively consider creating a test that initializes a WebApplicationContext.

  Since:

  4.2.8

• addPlaceHolderValue

  @Deprecated
  public StandaloneMockMvcBuilder addPlaceHolderValue​(String name,
                                                      String value)

  Deprecated.

  as of 4.2.8, in favor of addPlaceholderValue(String, String)

• initWebAppContext

  protected WebApplicationContext initWebAppContext()

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

  Specified by:

  initWebAppContext in class AbstractMockMvcBuilder<StandaloneMockMvcBuilder>