Package org.springframework.test.web.servlet.client

Interface MockMvcWebTestClient.ControllerSpec

All Superinterfaces:

MockMvcWebTestClient.MockMvcServerSpec<MockMvcWebTestClient.ControllerSpec>

Enclosing interface:

MockMvcWebTestClient

public static interface MockMvcWebTestClient.ControllerSpec
extends MockMvcWebTestClient.MockMvcServerSpec<MockMvcWebTestClient.ControllerSpec>

Specification for configuring MockMvc to test one or more controllers directly, and a simple facade around StandaloneMockMvcBuilder.

Method Summary

Modifier and Type	Method	Description
MockMvcWebTestClient.ControllerSpec	asyncRequestTimeout(long timeout)	Specify the timeout value for async execution.
MockMvcWebTestClient.ControllerSpec	contentNegotiationManager(ContentNegotiationManager manager)	Set a ContentNegotiationManager.
MockMvcWebTestClient.ControllerSpec	controllerAdvice(Object... controllerAdvice)	Register ControllerAdvice
MockMvcWebTestClient.ControllerSpec	conversionService(FormattingConversionService conversionService)	Provide a conversion service.
MockMvcWebTestClient.ControllerSpec	customArgumentResolvers(HandlerMethodArgumentResolver... argumentResolvers)	Provide custom argument resolvers.
MockMvcWebTestClient.ControllerSpec	customHandlerMapping(Supplier<RequestMappingHandlerMapping> factory)	Configure factory for a custom RequestMappingHandlerMapping.
MockMvcWebTestClient.ControllerSpec	customReturnValueHandlers(HandlerMethodReturnValueHandler... handlers)	Provide custom return value handlers.
MockMvcWebTestClient.ControllerSpec	flashMapManager(FlashMapManager flashMapManager)	Provide a custom FlashMapManager.
MockMvcWebTestClient.ControllerSpec	handlerExceptionResolvers(HandlerExceptionResolver... exceptionResolvers)	Set the HandlerExceptionResolver types to use.
MockMvcWebTestClient.ControllerSpec	interceptors(HandlerInterceptor... interceptors)	Add global interceptors.
MockMvcWebTestClient.ControllerSpec	localeResolver(LocaleResolver localeResolver)	Provide the LocaleResolver to use.
MockMvcWebTestClient.ControllerSpec	mappedInterceptors(String[] pathPatterns, HandlerInterceptor... interceptors)	Add interceptors for specific patterns.
MockMvcWebTestClient.ControllerSpec	messageConverters(HttpMessageConverter<?>... messageConverters)	Set the message converters to use.
MockMvcWebTestClient.ControllerSpec	patternParser(PathPatternParser parser)	Enable URL path matching with parsed PathPatterns.
MockMvcWebTestClient.ControllerSpec	placeholderValue(String name, String value)	Configure placeholder values to use.
MockMvcWebTestClient.ControllerSpec	singleView(View view)	Set up a single ViewResolver with a fixed view.
MockMvcWebTestClient.ControllerSpec	useTrailingSlashPatternMatch(boolean useTrailingSlashPatternMatch)	Deprecated. as of 6.0, see PathPatternParser.setMatchOptionalTrailingSeparator(boolean)
MockMvcWebTestClient.ControllerSpec	validator(Validator validator)	Provide a custom Validator.
MockMvcWebTestClient.ControllerSpec	viewResolvers(ViewResolver... resolvers)	Set up view resolution.

Methods inherited from interface org.springframework.test.web.servlet.client.MockMvcWebTestClient.MockMvcServerSpec

alwaysExpect, apply, build, configureClient, defaultRequest, dispatcherServletCustomizer, dispatchOptions, filter, filters

Method Details

controllerAdvice

MockMvcWebTestClient.ControllerSpec controllerAdvice(Object... controllerAdvice)

Register ControllerAdvice

This is delegated to StandaloneMockMvcBuilder.setControllerAdvice(Object...).

messageConverters

MockMvcWebTestClient.ControllerSpec messageConverters(HttpMessageConverter<?>... messageConverters)

Set the message converters to use.

This is delegated to StandaloneMockMvcBuilder.setMessageConverters(HttpMessageConverter[]).

validator

MockMvcWebTestClient.ControllerSpec validator(Validator validator)

Provide a custom Validator.

This is delegated to StandaloneMockMvcBuilder.setValidator(Validator).

conversionService

MockMvcWebTestClient.ControllerSpec conversionService(FormattingConversionService conversionService)

Provide a conversion service.

This is delegated to StandaloneMockMvcBuilder.setConversionService(FormattingConversionService).

interceptors

MockMvcWebTestClient.ControllerSpec interceptors(HandlerInterceptor... interceptors)

Add global interceptors.

This is delegated to StandaloneMockMvcBuilder.addInterceptors(HandlerInterceptor...).

mappedInterceptors

MockMvcWebTestClient.ControllerSpec mappedInterceptors(@Nullable
 String[] pathPatterns,
 HandlerInterceptor... interceptors)

Add interceptors for specific patterns.

This is delegated to StandaloneMockMvcBuilder.addMappedInterceptors(String[], HandlerInterceptor...).

contentNegotiationManager

MockMvcWebTestClient.ControllerSpec contentNegotiationManager(ContentNegotiationManager manager)

Set a ContentNegotiationManager.

This is delegated to StandaloneMockMvcBuilder.setContentNegotiationManager(ContentNegotiationManager).

asyncRequestTimeout

MockMvcWebTestClient.ControllerSpec asyncRequestTimeout(long timeout)

Specify the timeout value for async execution.

This is delegated to StandaloneMockMvcBuilder.setAsyncRequestTimeout(long).

customArgumentResolvers

MockMvcWebTestClient.ControllerSpec customArgumentResolvers(HandlerMethodArgumentResolver... argumentResolvers)

Provide custom argument resolvers.

This is delegated to StandaloneMockMvcBuilder.setCustomArgumentResolvers(HandlerMethodArgumentResolver...).

customReturnValueHandlers

MockMvcWebTestClient.ControllerSpec customReturnValueHandlers(HandlerMethodReturnValueHandler... handlers)

Provide custom return value handlers.

This is delegated to StandaloneMockMvcBuilder.setCustomReturnValueHandlers(HandlerMethodReturnValueHandler...).

handlerExceptionResolvers

MockMvcWebTestClient.ControllerSpec handlerExceptionResolvers(HandlerExceptionResolver... exceptionResolvers)

Set the HandlerExceptionResolver types to use.

This is delegated to StandaloneMockMvcBuilder.setHandlerExceptionResolvers(HandlerExceptionResolver...).

viewResolvers

MockMvcWebTestClient.ControllerSpec viewResolvers(ViewResolver... resolvers)

Set up view resolution.

This is delegated to StandaloneMockMvcBuilder.setViewResolvers(ViewResolver...).

singleView

MockMvcWebTestClient.ControllerSpec singleView(View view)

Set up a single ViewResolver with a fixed view.

This is delegated to StandaloneMockMvcBuilder.setSingleView(View).

localeResolver

MockMvcWebTestClient.ControllerSpec localeResolver(LocaleResolver localeResolver)

Provide the LocaleResolver to use.

This is delegated to StandaloneMockMvcBuilder.setLocaleResolver(LocaleResolver).

flashMapManager

MockMvcWebTestClient.ControllerSpec flashMapManager(FlashMapManager flashMapManager)

Provide a custom FlashMapManager.

This is delegated to StandaloneMockMvcBuilder.setFlashMapManager(FlashMapManager).

patternParser

MockMvcWebTestClient.ControllerSpec patternParser(PathPatternParser parser)

Enable URL path matching with parsed PathPatterns.

This is delegated to StandaloneMockMvcBuilder.setPatternParser(PathPatternParser).

useTrailingSlashPatternMatch

@Deprecated(since="6.0")
MockMvcWebTestClient.ControllerSpec useTrailingSlashPatternMatch(boolean useTrailingSlashPatternMatch)

Deprecated.

as of 6.0, see PathPatternParser.setMatchOptionalTrailingSeparator(boolean)

Whether to match trailing slashes.

This is delegated to StandaloneMockMvcBuilder.setUseTrailingSlashPatternMatch(boolean).

placeholderValue

MockMvcWebTestClient.ControllerSpec placeholderValue(String name,
 String value)

Configure placeholder values to use.

This is delegated to StandaloneMockMvcBuilder.addPlaceholderValue(String, String).

customHandlerMapping

MockMvcWebTestClient.ControllerSpec customHandlerMapping(Supplier<RequestMappingHandlerMapping> factory)

Configure factory for a custom RequestMappingHandlerMapping.

This is delegated to StandaloneMockMvcBuilder.setCustomHandlerMapping(Supplier).