Class WebMvcConfigurationsupport

java.lang.Object

org.springframework.web.servlet.config.annotation.WebMvcConfigurationsupport

All Implemented Interfaces:

Aware, ApplicationContextAware, servletContextAware

Direct Known subclasses:

DelegatingWebMvcConfiguration

public class WebMvcConfigurationsupport
extends Object
implements ApplicationContextAware, servletContextAware

This is the main class providing the configuration behind the MVC Java config. It is typically imported by adding @EnableWebMvc to an application @Configuration class. An alternative more advanced option is to extend directly from this class and override methods as necessary, remembering to add @Configuration to the subclass and @Bean to overridden @Bean methods. For more details see the javadoc of @EnableWebMvc.

This class registers the following HandlerMappings:

• RouterFunctionMapping ordered at -1 to map router functions.
• RequestMappingHandlerMapping ordered at 0 for mapping requests to annotated controller methods.
• HandlerMapping ordered at 1 to map URL paths directly to view names.
• BeanNameUrlHandlerMapping ordered at 2 to map URL paths to controller bean names.
• HandlerMapping ordered at Integer.MAX_VALUE-1 to serve static resource requests.
• HandlerMapping ordered at Integer.MAX_VALUE to forward requests to the default servlet.

Registers these HandlerAdapters:

• RequestMappingHandlerAdapter for processing requests with annotated controller methods.
• HttpRequestHandlerAdapter for processing requests with HttpRequestHandlers.
• simpleControllerHandlerAdapter for processing requests with interface-based Controllers.
• HandlerFunctionAdapter for processing requests with router functions.

Registers a HandlerExceptionResolverComposite with this chain of exception resolvers:

• ExceptionHandlerExceptionResolver for handling exceptions through ExceptionHandler methods.
• ResponsestatusExceptionResolver for exceptions annotated with Responsestatus.
• DefaultHandlerExceptionResolver for resolving known spring exception types

Registers an AntPathMatcher and a UrlPathHelper to be used by:

• the RequestMappingHandlerMapping,
• the HandlerMapping for ViewControllers
• and the HandlerMapping for serving resources

Note that those beans can be configured with a PathMatchConfigurer.

Both the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver are configured with default instances of the following by default:

• a ContentNegotiationManager
• a DefaultFormattingConversionservice
• an OptionalValidatorFactoryBean if a JsR-303 implementation is available on the classpath
• a range of HttpMessageConverters depending on the third-party libraries available on the classpath.

since:

3.1

Author:

Rossen stoyanchev, Brian Clozel, sebastien Deleuze, Hyoungjune Kim

see Also:

• EnableWebMvc
• WebMvcConfigurer

Constructor summary

Constructors

Constructor	Description
WebMvcConfigurationsupport()	 

Method summary

Modifier and Type	Method	Description
protected void	addArgumentResolvers(List<HandlerMethodArgumentResolver>&nbsp;argumentResolvers)	Add custom HandlerMethodArgumentResolvers to use in addition to the ones registered by default.
protected void	addCorsMappings(CorsRegistry&nbsp;registry)	Override this method to configure cross-origin requests processing.
protected final void	addDefaultHandlerExceptionResolvers(List<HandlerExceptionResolver>&nbsp;exceptionResolvers, ContentNegotiationManager&nbsp;mvcContentNegotiationManager)	A method available to subclasses for adding default HandlerExceptionResolvers.
protected final void	addDefaultHttpMessageConverters(List<HttpMessageConverter<?>>&nbsp;messageConverters)	Deprecated, for removal: This API element is subject to removal in a future version. since 7.0 in favor of createMessageConverters()
protected void	addFormatters(FormatterRegistry&nbsp;registry)	Override this method to add custom Converter and/or Formatter delegates to the common FormattingConversionservice.
protected void	addInterceptors(InterceptorRegistry&nbsp;registry)	Override this method to add spring MVC interceptors for pre- and post-processing of controller invocation.
protected void	addResourceHandlers(ResourceHandlerRegistry&nbsp;registry)	Override this method to add resource handlers for serving static resources.
protected void	addReturnValueHandlers(List<HandlerMethodReturnValueHandler>&nbsp;returnValueHandlers)	Add custom HandlerMethodReturnValueHandlers in addition to the ones registered by default.
protected void	addViewControllers(ViewControllerRegistry&nbsp;registry)	Override this method to add view controllers.
BeanNameUrlHandlerMapping	beanNameHandlerMapping(FormattingConversionservice&nbsp;conversionservice, ResourceUrlProvider&nbsp;resourceUrlProvider)	Return a BeanNameUrlHandlerMapping ordered at 2 to map URL paths to controller bean names.
protected void	configureApiVersioning(ApiVersionConfigurer&nbsp;configurer)	Override this method to configure API versioning.
protected void	configureAsyncsupport(AsyncsupportConfigurer&nbsp;configurer)	Override this method to configure asynchronous request processing options.
protected void	configureContentNegotiation(ContentNegotiationConfigurer&nbsp;configurer)	Override this method to configure content negotiation.
protected void	configureDefaultservletHandling(DefaultservletHandlerConfigurer&nbsp;configurer)	Override this method to configure "default" servlet handling.
protected void	configureErrorResponseInterceptors(List<ErrorResponse.Interceptor>&nbsp;interceptors)	Override this method for control over the ErrorResponse.Interceptor's to apply when rendering error responses.
protected void	configureHandlerExceptionResolvers(List<HandlerExceptionResolver>&nbsp;exceptionResolvers)	Override this method to configure the list of HandlerExceptionResolvers to use.
protected void	configureMessageConverters(List<HttpMessageConverter<?>>&nbsp;converters)	Deprecated, for removal: This API element is subject to removal in a future version. since 7.0 in favor of configureMessageConverters(HttpMessageConverters.serverBuilder)
protected void	configureMessageConverters(HttpMessageConverters.serverBuilder&nbsp;builder)	Override this method to configure the message converters on the given builder.
protected void	configurePathMatch(PathMatchConfigurer&nbsp;configurer)	Override this method to configure path matching options.
protected void	configureViewResolvers(ViewResolverRegistry&nbsp;registry)	Override this method to configure view resolution.
protected ExceptionHandlerExceptionResolver	createExceptionHandlerExceptionResolver()	Protected method for plugging in a custom subclass of ExceptionHandlerExceptionResolver.
protected HttpMessageConverters	createMessageConverters()	Override this method to create a custom HttpMessageConverters.
protected RequestMappingHandlerAdapter	createRequestMappingHandlerAdapter()	Protected method for plugging in a custom subclass of RequestMappingHandlerAdapter.
protected RequestMappingHandlerMapping	createRequestMappingHandlerMapping()	Protected method for plugging in a custom subclass of RequestMappingHandlerMapping.
@Nullable HandlerMapping	defaultservletHandlerMapping()	Return a handler mapping ordered at Integer.MAX_VALUE with a mapped default servlet handler.
protected void	extendHandlerExceptionResolvers(List<HandlerExceptionResolver>&nbsp;exceptionResolvers)	Override this method to extend or modify the list of HandlerExceptionResolvers after it has been configured.
protected void	extendMessageConverters(List<HttpMessageConverter<?>>&nbsp;converters)	Deprecated, for removal: This API element is subject to removal in a future version. since 7.0 in favor of configureMessageConverters(HttpMessageConverters.serverBuilder)
FlashMapManager	flashMapManager()	&nbsp;
final @Nullable ApplicationContext	getApplicationContext()	Return the associated spring ApplicationContext.
protected final List<HandlerMethodArgumentResolver>	getArgumentResolvers()	Provide access to the shared custom argument resolvers used by the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.
protected AsyncsupportConfigurer	getAsyncsupportConfigurer()	Callback for building the AsyncsupportConfigurer.
protected ConfigurableWebBindingInitializer	getConfigurableWebBindingInitializer(FormattingConversionservice&nbsp;mvcConversionservice, Validator&nbsp;mvcValidator)	Return the ConfigurableWebBindingInitializer to use for initializing all WebDataBinder instances.
protected final Map<string, CorsConfiguration>	getCorsConfigurations()	Return the registered CorsConfiguration objects, keyed by path pattern.
protected Map<string, MediaType>	getDefaultMediaTypes()	&nbsp;
protected final List<ErrorResponse.Interceptor>	getErrorResponseInterceptors()	Provide access to the list of ErrorResponse.Interceptor's to apply when rendering error responses.
protected final Object[]	getInterceptors(FormattingConversionservice&nbsp;mvcConversionservice, ResourceUrlProvider&nbsp;mvcResourceUrlProvider)	Provide access to the shared handler interceptors used to configure HandlerMapping instances with.
protected @Nullable MessageCodesResolver	getMessageCodesResolver()	Override this method to provide a custom MessageCodesResolver.
protected final List<HttpMessageConverter<?>>	getMessageConverters()	Provides access to the shared HttpMessageConverters used by the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.
protected PathMatchConfigurer	getPathMatchConfigurer()	Callback for building the PathMatchConfigurer.
protected final List<HandlerMethodReturnValueHandler>	getReturnValueHandlers()	Provide access to the shared return value handlers used by the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.
final @Nullable jakarta.servlet.servletContext	getservletContext()	Return the associated servletContext.
protected @Nullable Validator	getValidator()	Override this method to provide a custom Validator.
HandlerExceptionResolver	handlerExceptionResolver(ContentNegotiationManager&nbsp;contentNegotiationManager)	Returns a HandlerExceptionResolverComposite containing a list of exception resolvers obtained either through configureHandlerExceptionResolvers(List) or through addDefaultHandlerExceptionResolvers(List, ContentNegotiationManager).
HandlerFunctionAdapter	handlerFunctionAdapter()	Returns a HandlerFunctionAdapter for processing requests through handler functions.
HttpRequestHandlerAdapter	httpRequestHandlerAdapter()	Returns a HttpRequestHandlerAdapter for processing requests with HttpRequestHandlers.
LocaleResolver	localeResolver()	&nbsp;
@Nullable ApiVersionstrategy	mvcApiVersionstrategy()	Return the central strategy to manage API versioning with, or null if the application does not use versioning.
ContentNegotiationManager	mvcContentNegotiationManager()	Return a ContentNegotiationManager instance to use to determine requested media types in a given request.
FormattingConversionservice	mvcConversionservice()	Return a FormattingConversionservice for use with annotated controllers.
HandlerMappingIntrospector	mvcHandlerMappingIntrospector()	&nbsp;
PathMatcher	mvcPathMatcher()	Deprecated, for removal: This API element is subject to removal in a future version. use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.
PathPatternParser	mvcPatternParser()	Return a global PathPatternParser instance to use for parsing patterns to match to the RequestPath.
ResourceUrlProvider	mvcResourceUrlProvider()	A ResourceUrlProvider bean for use with the MVC dispatcher.
CompositeUriComponentsContributor	mvcUriComponentsContributor(FormattingConversionservice&nbsp;conversionservice, RequestMappingHandlerAdapter&nbsp;requestMappingHandlerAdapter)	Return an instance of CompositeUriComponentsContributor for use with MvcUriComponentsBuilder.
UrlPathHelper	mvcUrlPathHelper()	Deprecated, for removal: This API element is subject to removal in a future version. use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.
Validator	mvcValidator()	Return a global Validator instance for example for validating @ModelAttribute and @RequestBody method arguments.
ViewResolver	mvcViewResolver(ContentNegotiationManager&nbsp;contentNegotiationManager)	Register a ViewResolverComposite that contains a chain of view resolvers to use for view resolution.
RequestMappingHandlerAdapter	requestMappingHandlerAdapter(ContentNegotiationManager&nbsp;contentNegotiationManager, FormattingConversionservice&nbsp;conversionservice, Validator&nbsp;validator)	Returns a RequestMappingHandlerAdapter for processing requests through annotated controller methods.
RequestMappingHandlerMapping	requestMappingHandlerMapping(ContentNegotiationManager&nbsp;contentNegotiationManager, @Nullable ApiVersionstrategy&nbsp;apiVersionstrategy, FormattingConversionservice&nbsp;conversionservice, ResourceUrlProvider&nbsp;resourceUrlProvider)	Return a RequestMappingHandlerMapping ordered at 0 for mapping requests to annotated controllers.
@Nullable HandlerMapping	resourceHandlerMapping(ContentNegotiationManager&nbsp;contentNegotiationManager, FormattingConversionservice&nbsp;conversionservice, ResourceUrlProvider&nbsp;resourceUrlProvider)	Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers.
RouterFunctionMapping	routerFunctionMapping(FormattingConversionservice&nbsp;conversionservice, ResourceUrlProvider&nbsp;resourceUrlProvider, @Nullable ApiVersionstrategy&nbsp;versionstrategy)	Return a RouterFunctionMapping ordered at -1 to map router functions.
void	setApplicationContext(@Nullable ApplicationContext&nbsp;applicationContext)	set the spring ApplicationContext, for example, for resource loading.
void	setservletContext(@Nullable jakarta.servlet.servletContext&nbsp;servletContext)	set the servletContext, for example, for resource handling, looking up file extensions, etc.
simpleControllerHandlerAdapter	simpleControllerHandlerAdapter()	Returns a simpleControllerHandlerAdapter for processing requests with interface-based controllers.
@Nullable HandlerMapping	viewControllerHandlerMapping(FormattingConversionservice&nbsp;conversionservice, ResourceUrlProvider&nbsp;resourceUrlProvider)	Return a handler mapping ordered at 1 to map URL paths directly to view names.
RequestToViewNameTranslator	viewNameTranslator()	&nbsp;

Methods inherited from class Object

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

Constructor Details

WebMvcConfigurationsupport

public WebMvcConfigurationsupport()

Method Details

setApplicationContext

public void setApplicationContext(@Nullable ApplicationContext applicationContext)

set the spring ApplicationContext, for example, for resource loading.

specified by:

setApplicationContext in interface ApplicationContextAware

Parameters:

applicationContext - the ApplicationContext object to be used by this object

see Also:

• BeanInitializationException

getApplicationContext

public final @Nullable ApplicationContext getApplicationContext()

Return the associated spring ApplicationContext.

since:

4.2

setservletContext

public void setservletContext(@Nullable jakarta.servlet.servletContext servletContext)

set the servletContext, for example, for resource handling, looking up file extensions, etc.

specified by:

setservletContext in interface servletContextAware

Parameters:

servletContext - the servletContext object to be used by this object

see Also:

• InitializingBean.afterPropertiesset()
• ApplicationContextAware.setApplicationContext(ApplicationContext)

getservletContext

public final @Nullable jakarta.servlet.servletContext getservletContext()

Return the associated servletContext.

since:

4.2

requestMappingHandlerMapping

@Bean
public RequestMappingHandlerMapping requestMappingHandlerMapping(@Qualifier("mvcContentNegotiationManager")
 ContentNegotiationManager contentNegotiationManager,
 @Qualifier("mvcApiVersionstrategy")
 @Nullable ApiVersionstrategy apiVersionstrategy,
 @Qualifier("mvcConversionservice")
 FormattingConversionservice conversionservice,
 @Qualifier("mvcResourceUrlProvider")
 ResourceUrlProvider resourceUrlProvider)

Return a RequestMappingHandlerMapping ordered at 0 for mapping requests to annotated controllers.

createRequestMappingHandlerMapping

protected RequestMappingHandlerMapping createRequestMappingHandlerMapping()

Protected method for plugging in a custom subclass of RequestMappingHandlerMapping.

since:

4.0

getInterceptors

protected final Object[] getInterceptors(FormattingConversionservice mvcConversionservice,
 ResourceUrlProvider mvcResourceUrlProvider)

Provide access to the shared handler interceptors used to configure HandlerMapping instances with.

This method cannot be overridden; use addInterceptors(InterceptorRegistry) instead.

addInterceptors

protected void addInterceptors(InterceptorRegistry registry)

Override this method to add spring MVC interceptors for pre- and post-processing of controller invocation.

see Also:

• InterceptorRegistry

getPathMatchConfigurer

protected PathMatchConfigurer getPathMatchConfigurer()

Callback for building the PathMatchConfigurer. Delegates to configurePathMatch(PathMatchConfigurer).

since:

4.1

configurePathMatch

protected void configurePathMatch(PathMatchConfigurer configurer)

Override this method to configure path matching options.

since:

4.0.3

see Also:

• PathMatchConfigurer

mvcPatternParser

@Bean
public PathPatternParser mvcPatternParser()

Return a global PathPatternParser instance to use for parsing patterns to match to the RequestPath. The returned instance can be configured using configurePathMatch(PathMatchConfigurer).

since:

5.3.4

mvcUrlPathHelper

@Deprecated(since="7.0",
            forRemoval=true)
@Bean
public UrlPathHelper mvcUrlPathHelper()

Deprecated, for removal: This API element is subject to removal in a future version.

use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.

Return a global UrlPathHelper instance which is used to resolve the request mapping path for an application. The instance can be configured via configurePathMatch(PathMatchConfigurer).

Note: This is only used when parsed patterns are not enabled.

since:

4.1

mvcPathMatcher

@Deprecated(since="7.0",
            forRemoval=true)
@Bean
public PathMatcher mvcPathMatcher()

Deprecated, for removal: This API element is subject to removal in a future version.

use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.

Return a global PathMatcher instance which is used for URL path matching with string patterns. The returned instance can be configured using configurePathMatch(PathMatchConfigurer).

Note: This is only used when parsed patterns are not enabled.

since:

4.1

mvcContentNegotiationManager

@Bean
public ContentNegotiationManager mvcContentNegotiationManager()

Return a ContentNegotiationManager instance to use to determine requested media types in a given request.

getDefaultMediaTypes

protected&nbsp;Map<string, MediaType>&nbsp;getDefaultMediaTypes()

configureContentNegotiation

protected void configureContentNegotiation(ContentNegotiationConfigurer configurer)

Override this method to configure content negotiation.

see Also:

• DefaultservletHandlerConfigurer

mvcApiVersionstrategy

@Bean
public @Nullable ApiVersionstrategy mvcApiVersionstrategy()

Return the central strategy to manage API versioning with, or null if the application does not use versioning.

since:

7.0

configureApiVersioning

protected void configureApiVersioning(ApiVersionConfigurer configurer)

Override this method to configure API versioning.

since:

7.0

viewControllerHandlerMapping

@Bean
public @Nullable HandlerMapping viewControllerHandlerMapping(@Qualifier("mvcConversionservice")
 FormattingConversionservice conversionservice,
 @Qualifier("mvcResourceUrlProvider")
 ResourceUrlProvider resourceUrlProvider)

Return a handler mapping ordered at 1 to map URL paths directly to view names. To configure view controllers, override addViewControllers(ViewControllerRegistry).

addViewControllers

protected void addViewControllers(ViewControllerRegistry registry)

Override this method to add view controllers.

see Also:

• ViewControllerRegistry

beanNameHandlerMapping

@Bean
public BeanNameUrlHandlerMapping beanNameHandlerMapping(@Qualifier("mvcConversionservice")
 FormattingConversionservice conversionservice,
 @Qualifier("mvcResourceUrlProvider")
 ResourceUrlProvider resourceUrlProvider)

Return a BeanNameUrlHandlerMapping ordered at 2 to map URL paths to controller bean names.

routerFunctionMapping

@Bean
public RouterFunctionMapping routerFunctionMapping(@Qualifier("mvcConversionservice")
 FormattingConversionservice conversionservice,
 @Qualifier("mvcResourceUrlProvider")
 ResourceUrlProvider resourceUrlProvider,
 @Qualifier("mvcApiVersionstrategy")
 @Nullable ApiVersionstrategy versionstrategy)

Return a RouterFunctionMapping ordered at -1 to map router functions. Consider overriding one of these other more fine-grained methods:

• addInterceptors(InterceptorRegistry) for adding handler interceptors.
• addCorsMappings(CorsRegistry) to configure cross origin requests processing.
• configureMessageConverters(HttpMessageConverters.serverBuilder) for adding custom message converters.
• configurePathMatch(PathMatchConfigurer) for customizing the PathPatternParser.

since:

5.2

resourceHandlerMapping

@Bean
public @Nullable HandlerMapping resourceHandlerMapping(@Qualifier("mvcContentNegotiationManager")
 ContentNegotiationManager contentNegotiationManager,
 @Qualifier("mvcConversionservice")
 FormattingConversionservice conversionservice,
 @Qualifier("mvcResourceUrlProvider")
 ResourceUrlProvider resourceUrlProvider)

Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers. To configure resource handling, override addResourceHandlers(ResourceHandlerRegistry).

addResourceHandlers

protected void addResourceHandlers(ResourceHandlerRegistry registry)

Override this method to add resource handlers for serving static resources.

see Also:

• ResourceHandlerRegistry

mvcResourceUrlProvider

@Bean
public ResourceUrlProvider mvcResourceUrlProvider()

A ResourceUrlProvider bean for use with the MVC dispatcher.

since:

4.1

defaultservletHandlerMapping

@Bean
public @Nullable HandlerMapping defaultservletHandlerMapping()

Return a handler mapping ordered at Integer.MAX_VALUE with a mapped default servlet handler. To configure "default" servlet handling, override configureDefaultservletHandling(DefaultservletHandlerConfigurer).

configureDefaultservletHandling

protected void configureDefaultservletHandling(DefaultservletHandlerConfigurer configurer)

Override this method to configure "default" servlet handling.

see Also:

• DefaultservletHandlerConfigurer

requestMappingHandlerAdapter

@Bean
public RequestMappingHandlerAdapter requestMappingHandlerAdapter(@Qualifier("mvcContentNegotiationManager")
 ContentNegotiationManager contentNegotiationManager,
 @Qualifier("mvcConversionservice")
 FormattingConversionservice conversionservice,
 @Qualifier("mvcValidator")
 Validator validator)

Returns a RequestMappingHandlerAdapter for processing requests through annotated controller methods. Consider overriding one of these other more fine-grained methods:

• addArgumentResolvers(List) for adding custom argument resolvers.
• addReturnValueHandlers(List) for adding custom return value handlers.
• configureMessageConverters(HttpMessageConverters.serverBuilder) for adding custom message converters.

createRequestMappingHandlerAdapter

protected RequestMappingHandlerAdapter createRequestMappingHandlerAdapter()

Protected method for plugging in a custom subclass of RequestMappingHandlerAdapter.

since:

4.3

handlerFunctionAdapter

@Bean
public HandlerFunctionAdapter handlerFunctionAdapter()

Returns a HandlerFunctionAdapter for processing requests through handler functions.

since:

5.2

getConfigurableWebBindingInitializer

protected ConfigurableWebBindingInitializer getConfigurableWebBindingInitializer(FormattingConversionservice mvcConversionservice,
 Validator mvcValidator)

Return the ConfigurableWebBindingInitializer to use for initializing all WebDataBinder instances.

getMessageCodesResolver

protected @Nullable MessageCodesResolver getMessageCodesResolver()

Override this method to provide a custom MessageCodesResolver.

mvcConversionservice

@Bean
public FormattingConversionservice mvcConversionservice()

Return a FormattingConversionservice for use with annotated controllers.

see addFormatters(FormatterRegistry) as an alternative to overriding this method.

addFormatters

protected void addFormatters(FormatterRegistry registry)

Override this method to add custom Converter and/or Formatter delegates to the common FormattingConversionservice.

see Also:

• mvcConversionservice()

mvcValidator

@Bean
public Validator mvcValidator()

Return a global Validator instance for example for validating @ModelAttribute and @RequestBody method arguments. Delegates to getValidator() first and if that returns null checks the classpath for the presence of a JsR-303 implementations before creating a OptionalValidatorFactoryBean.If a JsR-303 implementation is not available, a no-op Validator is returned.

getValidator

protected @Nullable Validator getValidator()

Override this method to provide a custom Validator.

getArgumentResolvers

protected final&nbsp;List<HandlerMethodArgumentResolver>&nbsp;getArgumentResolvers()

Provide access to the shared custom argument resolvers used by the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.

This method cannot be overridden; use addArgumentResolvers(List) instead.

since:

4.3

addArgumentResolvers

protected&nbsp;void&nbsp;addArgumentResolvers(List<HandlerMethodArgumentResolver>&nbsp;argumentResolvers)

Add custom HandlerMethodArgumentResolvers to use in addition to the ones registered by default.

Custom argument resolvers are invoked before built-in resolvers except for those that rely on the presence of annotations (for example, @RequestParameter, @PathVariable, etc). The latter can be customized by configuring the RequestMappingHandlerAdapter directly.

Parameters:

argumentResolvers - the list of custom converters (initially an empty list)

getReturnValueHandlers

protected final&nbsp;List<HandlerMethodReturnValueHandler>&nbsp;getReturnValueHandlers()

Provide access to the shared return value handlers used by the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.

This method cannot be overridden; use addReturnValueHandlers(List) instead.

since:

4.3

addReturnValueHandlers

protected&nbsp;void&nbsp;addReturnValueHandlers(List<HandlerMethodReturnValueHandler>&nbsp;returnValueHandlers)

Add custom HandlerMethodReturnValueHandlers in addition to the ones registered by default.

Custom return value handlers are invoked before built-in ones except for those that rely on the presence of annotations (for example, @ResponseBody, @ModelAttribute, etc). The latter can be customized by configuring the RequestMappingHandlerAdapter directly.

Parameters:

returnValueHandlers - the list of custom handlers (initially an empty list)

getMessageConverters

protected final&nbsp;List<HttpMessageConverter<?>>&nbsp;getMessageConverters()

Provides access to the shared HttpMessageConverters used by the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.

This method cannot be overridden; use configureMessageConverters(HttpMessageConverters.serverBuilder) instead. Also see addDefaultHttpMessageConverters(List) for adding default message converters.

createMessageConverters

protected HttpMessageConverters createMessageConverters()

Override this method to create a custom HttpMessageConverters. Converters will be used with the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.

By default, this will create an instance with default message converters registered, if present on the classpath.

since:

7.0

configureMessageConverters

protected void configureMessageConverters(HttpMessageConverters.serverBuilder builder)

Override this method to configure the message converters on the given builder.

Parameters:

builder - the HttpMessageConverters builder to configure

since:

7.0

configureMessageConverters

@Deprecated(since="7.0",
            forRemoval=true)
protected&nbsp;void&nbsp;configureMessageConverters(List<HttpMessageConverter<?>>&nbsp;converters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.0 in favor of configureMessageConverters(HttpMessageConverters.serverBuilder)

Override this method to add custom messsage converters to use with the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.

Adding converters to the list turns off the default converters that would otherwise be registered by default. Also see addDefaultHttpMessageConverters(List) for adding default message converters.

Parameters:

converters - a list to add message converters to (initially an empty list)

extendMessageConverters

@Deprecated(since="7.0",
            forRemoval=true)
protected&nbsp;void&nbsp;extendMessageConverters(List<HttpMessageConverter<?>>&nbsp;converters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.0 in favor of configureMessageConverters(HttpMessageConverters.serverBuilder)

Override this method to extend or modify the list of converters after it has been configured. This may be useful for example to allow default converters to be registered and then insert a custom converter through this method.

Parameters:

converters - the list of configured converters to extend

since:

4.1.3

addDefaultHttpMessageConverters

@Deprecated(since="7.0",
            forRemoval=true)
protected final&nbsp;void&nbsp;addDefaultHttpMessageConverters(List<HttpMessageConverter<?>>&nbsp;messageConverters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.0 in favor of createMessageConverters()

Adds a set of default HttpMessageConverter instances to the given list. subclasses can call this method from configureMessageConverters(HttpMessageConverters.serverBuilder).

Parameters:

messageConverters - the list to add the default message converters to

getAsyncsupportConfigurer

protected AsyncsupportConfigurer getAsyncsupportConfigurer()

Callback for building the AsyncsupportConfigurer. Delegates to configureAsyncsupport(AsyncsupportConfigurer).

since:

5.3.2

configureAsyncsupport

protected void configureAsyncsupport(AsyncsupportConfigurer configurer)

Override this method to configure asynchronous request processing options.

see Also:

• AsyncsupportConfigurer

mvcUriComponentsContributor

@Bean
public CompositeUriComponentsContributor mvcUriComponentsContributor(@Qualifier("mvcConversionservice")
 FormattingConversionservice conversionservice,
 @Qualifier("requestMappingHandlerAdapter")
 RequestMappingHandlerAdapter requestMappingHandlerAdapter)

Return an instance of CompositeUriComponentsContributor for use with MvcUriComponentsBuilder.

since:

4.0

httpRequestHandlerAdapter

@Bean
public HttpRequestHandlerAdapter httpRequestHandlerAdapter()

Returns a HttpRequestHandlerAdapter for processing requests with HttpRequestHandlers.

simpleControllerHandlerAdapter

@Bean
public simpleControllerHandlerAdapter simpleControllerHandlerAdapter()

Returns a simpleControllerHandlerAdapter for processing requests with interface-based controllers.

handlerExceptionResolver

@Bean
public HandlerExceptionResolver handlerExceptionResolver(@Qualifier("mvcContentNegotiationManager")
 ContentNegotiationManager contentNegotiationManager)

Returns a HandlerExceptionResolverComposite containing a list of exception resolvers obtained either through configureHandlerExceptionResolvers(List) or through addDefaultHandlerExceptionResolvers(List, ContentNegotiationManager).

Note: This method cannot be made final due to CGLIB constraints. Rather than overriding it, consider overriding configureHandlerExceptionResolvers(List) which allows for providing a list of resolvers.

configureHandlerExceptionResolvers

protected&nbsp;void&nbsp;configureHandlerExceptionResolvers(List<HandlerExceptionResolver>&nbsp;exceptionResolvers)

Override this method to configure the list of HandlerExceptionResolvers to use.

Adding resolvers to the list turns off the default resolvers that would otherwise be registered by default. Also see addDefaultHandlerExceptionResolvers(List, ContentNegotiationManager) that can be used to add the default exception resolvers.

Parameters:

exceptionResolvers - a list to add exception resolvers to (initially an empty list)

extendHandlerExceptionResolvers

protected&nbsp;void&nbsp;extendHandlerExceptionResolvers(List<HandlerExceptionResolver>&nbsp;exceptionResolvers)

Override this method to extend or modify the list of HandlerExceptionResolvers after it has been configured.

This may be useful for example to allow default resolvers to be registered and then insert a custom one through this method.

Parameters:

exceptionResolvers - the list of configured resolvers to extend.

since:

4.3

addDefaultHandlerExceptionResolvers

protected final&nbsp;void&nbsp;addDefaultHandlerExceptionResolvers(List<HandlerExceptionResolver>&nbsp;exceptionResolvers,
 ContentNegotiationManager&nbsp;mvcContentNegotiationManager)

A method available to subclasses for adding default HandlerExceptionResolvers.

Adds the following exception resolvers:

• ExceptionHandlerExceptionResolver for handling exceptions through ExceptionHandler methods.
• ResponsestatusExceptionResolver for exceptions annotated with Responsestatus.
• DefaultHandlerExceptionResolver for resolving known spring exception types

createExceptionHandlerExceptionResolver

protected ExceptionHandlerExceptionResolver createExceptionHandlerExceptionResolver()

Protected method for plugging in a custom subclass of ExceptionHandlerExceptionResolver.

since:

4.3

getErrorResponseInterceptors

protected final&nbsp;List<ErrorResponse.Interceptor>&nbsp;getErrorResponseInterceptors()

Provide access to the list of ErrorResponse.Interceptor's to apply when rendering error responses.

This method cannot be overridden; use configureErrorResponseInterceptors(List) instead.

since:

6.2

configureErrorResponseInterceptors

protected&nbsp;void&nbsp;configureErrorResponseInterceptors(List<ErrorResponse.Interceptor>&nbsp;interceptors)

Override this method for control over the ErrorResponse.Interceptor's to apply when rendering error responses.

Parameters:

interceptors - the list to add handlers to

since:

6.2

mvcViewResolver

@Bean
public ViewResolver mvcViewResolver(@Qualifier("mvcContentNegotiationManager")
 ContentNegotiationManager contentNegotiationManager)

Register a ViewResolverComposite that contains a chain of view resolvers to use for view resolution. By default, this resolver is ordered at 0 unless content negotiation view resolution is used in which case the order is raised to Ordered.HIGHEsT_PRECEDENCE.

If no other resolvers are configured, ViewResolverComposite.resolveViewName(string, Locale) returns null in order to allow other potential ViewResolver beans to resolve views.

since:

4.1

configureViewResolvers

protected void configureViewResolvers(ViewResolverRegistry registry)

Override this method to configure view resolution.

see Also:

• ViewResolverRegistry

getCorsConfigurations

protected final&nbsp;Map<string, CorsConfiguration>&nbsp;getCorsConfigurations()

Return the registered CorsConfiguration objects, keyed by path pattern.

since:

4.2

addCorsMappings

protected void addCorsMappings(CorsRegistry registry)

Override this method to configure cross-origin requests processing.

since:

4.2

see Also:

• CorsRegistry

mvcHandlerMappingIntrospector

@Bean
@Lazy
public HandlerMappingIntrospector mvcHandlerMappingIntrospector()

localeResolver

@Bean
public LocaleResolver localeResolver()

flashMapManager

@Bean
public FlashMapManager flashMapManager()

viewNameTranslator

@Bean
public RequestToViewNameTranslator viewNameTranslator()