public abstract class WebMvcConfigurerAdapter extends Object implements WebMvcConfigurer
WebMvcConfigurer
with empty methods allowing
subclasses to override only the methods they're interested in.Constructor and Description |
---|
WebMvcConfigurerAdapter() |
Modifier and Type | Method and Description |
---|---|
void |
addArgumentResolvers(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)
|
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(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(List<HandlerExceptionResolver> exceptionResolvers)
Configure exception resolvers.
|
void |
configureMessageConverters(List<HttpMessageConverter<?>> converters)
Configure the
HttpMessageConverter s 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(List<HandlerExceptionResolver> exceptionResolvers)
Extending or modify the list of exception resolvers configured by default.
|
void |
extendMessageConverters(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. |
public void configurePathMatch(PathMatchConfigurer configurer)
This implementation is empty.
configurePathMatch
in interface WebMvcConfigurer
public void configureContentNegotiation(ContentNegotiationConfigurer configurer)
This implementation is empty.
configureContentNegotiation
in interface WebMvcConfigurer
public void configureAsyncSupport(AsyncSupportConfigurer configurer)
This implementation is empty.
configureAsyncSupport
in interface WebMvcConfigurer
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)
DispatcherServlet
is mapped to "/" thus overriding the
Servlet container's default handling of static resources.
This implementation is empty.
configureDefaultServletHandling
in interface WebMvcConfigurer
public void addFormatters(FormatterRegistry registry)
Converter
s and Formatter
s in addition to the ones
registered by default.
This implementation is empty.
addFormatters
in interface WebMvcConfigurer
public void addInterceptors(InterceptorRegistry registry)
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.
addInterceptors
in interface WebMvcConfigurer
public void addResourceHandlers(ResourceHandlerRegistry registry)
This implementation is empty.
addResourceHandlers
in interface WebMvcConfigurer
public void addCorsMappings(CorsRegistry registry)
This implementation is empty.
addCorsMappings
in interface WebMvcConfigurer
public void addViewControllers(ViewControllerRegistry registry)
This implementation is empty.
addViewControllers
in interface WebMvcConfigurer
public void configureViewResolvers(ViewResolverRegistry registry)
View
implementations to perform rendering with.
This implementation is empty.
configureViewResolvers
in interface WebMvcConfigurer
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
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.
addArgumentResolvers
in interface WebMvcConfigurer
argumentResolvers
- initially an empty listpublic void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
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.
addReturnValueHandlers
in interface WebMvcConfigurer
returnValueHandlers
- initially an empty listpublic void configureMessageConverters(List<HttpMessageConverter<?>> converters)
HttpMessageConverter
s 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.
configureMessageConverters
in interface WebMvcConfigurer
converters
- initially an empty list of converterspublic void extendMessageConverters(List<HttpMessageConverter<?>> converters)
This implementation is empty.
extendMessageConverters
in interface WebMvcConfigurer
converters
- the list of configured converters to extend.public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers)
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.
configureHandlerExceptionResolvers
in interface WebMvcConfigurer
exceptionResolvers
- initially an empty listWebMvcConfigurer.extendHandlerExceptionResolvers(List)
,
WebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List)
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers)
This implementation is empty.
extendHandlerExceptionResolvers
in interface WebMvcConfigurer
exceptionResolvers
- the list of configured resolvers to extendWebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List)
public Validator getValidator()
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
.
getValidator
in interface WebMvcConfigurer
public MessageCodesResolver getMessageCodesResolver()
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
.
getMessageCodesResolver
in interface WebMvcConfigurer