org.springframework.web.servlet.config.annotation

Class WebMvcConfigurerAdapter

java.lang.Object

org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

All Implemented Interfaces:

WebMvcConfigurer

public abstract class WebMvcConfigurerAdapter
extends java.lang.Object
implements WebMvcConfigurer

An implementation of WebMvcConfigurer with empty methods allowing subclasses to override only the methods they're interested in.

Since:

3.1

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
WebMvcConfigurerAdapter()

Method Summary

Modifier and Type	Method and Description
void	addArgumentResolvers(java.util.List<HandlerMethodArgumentResolver> argumentResolvers) Add resolvers to support custom controller method argument types.
void	addCorsMappings(CorsRegistry registry) Configure cross origin requests processing.
void	addFormatters(FormatterRegistry registry) Add Converters and Formatters in addition to the ones registered by default.
void	addInterceptors(InterceptorRegistry registry) Add Spring MVC lifecycle interceptors for pre- and post-processing of controller method invocations.
void	addResourceHandlers(ResourceHandlerRegistry registry) Add handlers to serve static resources such as images, js, and, css files from specific locations under web application root, the classpath, and others.
void	addReturnValueHandlers(java.util.List<HandlerMethodReturnValueHandler> returnValueHandlers) Add handlers to support custom controller method return value types.
void	addViewControllers(ViewControllerRegistry registry) Configure simple automated controllers pre-configured with the response status code and/or a view to render the response body.
void	configureAsyncSupport(AsyncSupportConfigurer configurer) Configure asynchronous request handling options.
void	configureContentNegotiation(ContentNegotiationConfigurer configurer) Configure content negotiation options.
void	configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) Configure a handler to delegate unhandled requests by forwarding to the Servlet container's "default" servlet.
void	configureHandlerExceptionResolvers(java.util.List<HandlerExceptionResolver> exceptionResolvers) Configure exception resolvers.
void	configureMessageConverters(java.util.List<HttpMessageConverter<?>> converters) Configure the HttpMessageConverters to use for reading or writing to the body of the request or response.
void	configurePathMatch(PathMatchConfigurer configurer) Helps with configuring HandlerMappings path matching options such as trailing slash match, suffix registration, path matcher and path helper.
void	configureViewResolvers(ViewResolverRegistry registry) Configure view resolvers to translate String-based view names returned from controllers into concrete View implementations to perform rendering with.
void	extendHandlerExceptionResolvers(java.util.List<HandlerExceptionResolver> exceptionResolvers) Extending or modify the list of exception resolvers configured by default.
void	extendMessageConverters(java.util.List<HttpMessageConverter<?>> converters) A hook for extending or modifying the list of converters after it has been configured.
MessageCodesResolver	getMessageCodesResolver() Provide a custom MessageCodesResolver for building message codes from data binding and validation error codes.
Validator	getValidator() Provide a custom Validator instead of the one created by default.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebMvcConfigurerAdapter

public WebMvcConfigurerAdapter()

Method Detail

configurePathMatch

public void configurePathMatch(PathMatchConfigurer configurer)

Helps with configuring HandlerMappings path matching options such as trailing slash match, suffix registration, path matcher and path helper. Configured path matcher and path helper instances are shared for:

• RequestMappings
• ViewControllerMappings
• ResourcesMappings

This implementation is empty.

Specified by:

configurePathMatch in interface WebMvcConfigurer

configureContentNegotiation

public void configureContentNegotiation(ContentNegotiationConfigurer configurer)

Configure content negotiation options.

This implementation is empty.

Specified by:

configureContentNegotiation in interface WebMvcConfigurer

configureAsyncSupport

public void configureAsyncSupport(AsyncSupportConfigurer configurer)

Configure asynchronous request handling options.

This implementation is empty.

Specified by:

configureAsyncSupport in interface WebMvcConfigurer

configureDefaultServletHandling

public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)

Configure a handler to delegate unhandled requests by forwarding to the Servlet container's "default" servlet. A common use case for this is when the DispatcherServlet is mapped to "/" thus overriding the Servlet container's default handling of static resources.

This implementation is empty.

Specified by:

configureDefaultServletHandling in interface WebMvcConfigurer

addFormatters

public void addFormatters(FormatterRegistry registry)

Add Converters and Formatters in addition to the ones registered by default.

This implementation is empty.

Specified by:

addFormatters in interface WebMvcConfigurer

addInterceptors

public void addInterceptors(InterceptorRegistry registry)

Add Spring MVC lifecycle interceptors for pre- and post-processing of controller method invocations. Interceptors can be registered to apply to all requests or be limited to a subset of URL patterns.

Note that interceptors registered here only apply to controllers and not to resource handler requests. To intercept requests for static resources either declare a MappedInterceptor bean or switch to advanced configuration mode by extending WebMvcConfigurationSupport and then override resourceHandlerMapping.

This implementation is empty.

Specified by:

addInterceptors in interface WebMvcConfigurer

addResourceHandlers

public void addResourceHandlers(ResourceHandlerRegistry registry)

Add handlers to serve static resources such as images, js, and, css files from specific locations under web application root, the classpath, and others.

This implementation is empty.

Specified by:

addResourceHandlers in interface WebMvcConfigurer

addCorsMappings

public void addCorsMappings(CorsRegistry registry)

Configure cross origin requests processing.

This implementation is empty.

Specified by:

addCorsMappings in interface WebMvcConfigurer

addViewControllers

public void addViewControllers(ViewControllerRegistry registry)

Configure simple automated controllers pre-configured with the response status code and/or a view to render the response body. This is useful in cases where there is no need for custom controller logic -- e.g. render a home page, perform simple site URL redirects, return a 404 status with HTML content, a 204 with no content, and more.

This implementation is empty.

Specified by:

addViewControllers in interface WebMvcConfigurer

configureViewResolvers

public void configureViewResolvers(ViewResolverRegistry registry)

Configure view resolvers to translate String-based view names returned from controllers into concrete View implementations to perform rendering with.

This implementation is empty.

Specified by:

configureViewResolvers in interface WebMvcConfigurer

addArgumentResolvers

public void addArgumentResolvers(java.util.List<HandlerMethodArgumentResolver> argumentResolvers)

Add resolvers to support custom controller method argument types.

This does not override the built-in support for resolving handler method arguments. To customize the built-in support for argument resolution, configure RequestMappingHandlerAdapter directly.

This implementation is empty.

Specified by:

addArgumentResolvers in interface WebMvcConfigurer

Parameters:

argumentResolvers - initially an empty list

addReturnValueHandlers

public void addReturnValueHandlers(java.util.List<HandlerMethodReturnValueHandler> returnValueHandlers)

Add handlers to support custom controller method return value types.

Using this option does not override the built-in support for handling return values. To customize the built-in support for handling return values, configure RequestMappingHandlerAdapter directly.

This implementation is empty.

Specified by:

addReturnValueHandlers in interface WebMvcConfigurer

Parameters:

returnValueHandlers - initially an empty list

configureMessageConverters

public void configureMessageConverters(java.util.List<HttpMessageConverter<?>> converters)

Configure the HttpMessageConverters to use for reading or writing to the body of the request or response. If no converters are added, a default list of converters is registered.

Note that adding converters to the list, turns off default converter registration. To simply add a converter without impacting default registration, consider using the method WebMvcConfigurer.extendMessageConverters(java.util.List) instead.

This implementation is empty.

Specified by:

configureMessageConverters in interface WebMvcConfigurer

Parameters:

converters - initially an empty list of converters

extendMessageConverters

public void extendMessageConverters(java.util.List<HttpMessageConverter<?>> converters)

A hook for extending or modifying 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.

This implementation is empty.

Specified by:

extendMessageConverters in interface WebMvcConfigurer

Parameters:

converters - the list of configured converters to extend.

configureHandlerExceptionResolvers

public void configureHandlerExceptionResolvers(java.util.List<HandlerExceptionResolver> exceptionResolvers)

Configure exception resolvers.

The given list starts out empty. If it is left empty, the framework configures a default set of resolvers, see WebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List). Or if any exception resolvers are added to the list, then the application effectively takes over and must provide, fully initialized, exception resolvers.

Alternatively you can use WebMvcConfigurer.extendHandlerExceptionResolvers(List) which allows you to extend or modify the list of exception resolvers configured by default.

This implementation is empty.

Specified by:

configureHandlerExceptionResolvers in interface WebMvcConfigurer

Parameters:

exceptionResolvers - initially an empty list

See Also:

WebMvcConfigurer.extendHandlerExceptionResolvers(List), WebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List)

extendHandlerExceptionResolvers

public void extendHandlerExceptionResolvers(java.util.List<HandlerExceptionResolver> exceptionResolvers)

Extending or modify the list of exception resolvers configured by default. This can be useful for inserting a custom exception resolver without interfering with default ones.

This implementation is empty.

Specified by:

extendHandlerExceptionResolvers in interface WebMvcConfigurer

Parameters:

exceptionResolvers - the list of configured resolvers to extend

See Also:

WebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List)

getValidator

public Validator getValidator()

Provide a custom Validator instead of the one created by default. The default implementation, assuming JSR-303 is on the classpath, is: OptionalValidatorFactoryBean. Leave the return value as null to keep the default.

This implementation returns null.

Specified by:

getValidator in interface WebMvcConfigurer

getMessageCodesResolver

public MessageCodesResolver getMessageCodesResolver()

Provide a custom MessageCodesResolver for building message codes from data binding and validation error codes. Leave the return value as null to keep the default.

This implementation returns null.

Specified by:

getMessageCodesResolver in interface WebMvcConfigurer