WebMvcConfigurer (Spring Framework 4.1.3.RELEASE API)

All Known Implementing Classes:

WebMvcConfigurerAdapter
```
public interface WebMvcConfigurer
```
Defines callback methods to customize the Java-based configuration for Spring MVC enabled via @EnableWebMvc.
@EnableWebMvc-annotated configuration classes may implement this interface to be called back and given a chance to customize the default configuration. Consider extending WebMvcConfigurerAdapter, which provides a stub implementation of all interface methods.

Since:

3.1

Author:

Rossen Stoyanchev, Keith Donald, David Syer

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)` Add resolvers to support custom controller method argument types.
`void`	`addFormatters(FormatterRegistry registry)` Add `Converter`s and `Formatter`s 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(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 the `HandlerExceptionResolver`s to handle unresolved controller exceptions.
`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`	`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.

- Method Detail
  - addFormatters
```
void addFormatters(FormatterRegistry registry)
```
    Add Converters and Formatters in addition to the ones registered by default.
  - configureMessageConverters
```
void configureMessageConverters(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 extendMessageConverters(java.util.List) instead.
    
    Parameters:
    
    converters - initially an empty list of converters
  - extendMessageConverters
```
void extendMessageConverters(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.
    
    Parameters:
    
    converters - the list of configured converters to extend.
    
    Since:
    
    4.1.3
  - getValidator
```
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.
  - configureContentNegotiation
```
void configureContentNegotiation(ContentNegotiationConfigurer configurer)
```
    Configure content negotiation options.
  - configureAsyncSupport
```
void configureAsyncSupport(AsyncSupportConfigurer configurer)
```
    Configure asynchronous request handling options.
  - configurePathMatch
```
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
    Since:
    
    4.0.3
  - addArgumentResolvers
```
void addArgumentResolvers(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.
    
    Parameters:
    
    argumentResolvers - initially an empty list
  - addReturnValueHandlers
```
void addReturnValueHandlers(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.
    
    Parameters:
    
    returnValueHandlers - initially an empty list
  - configureHandlerExceptionResolvers
```
void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers)
```
    Configure the HandlerExceptionResolvers to handle unresolved controller exceptions. If no resolvers are added to the list, default exception resolvers are added instead.
    
    Parameters:
    
    exceptionResolvers - initially an empty list
  - addInterceptors
```
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.
  - getMessageCodesResolver
```
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.
  - addViewControllers
```
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.
  - configureViewResolvers
```
void configureViewResolvers(ViewResolverRegistry registry)
```
    Configure view resolvers to translate String-based view names returned from controllers into concrete View implementations to perform rendering with.
  - addResourceHandlers
```
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.
  - configureDefaultServletHandling
```
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.

Interface WebMvcConfigurer

Method Summary

Method Detail

addFormatters

configureMessageConverters

extendMessageConverters

getValidator

configureContentNegotiation

configureAsyncSupport

configurePathMatch

addArgumentResolvers

addReturnValueHandlers

configureHandlerExceptionResolvers

addInterceptors

getMessageCodesResolver

addViewControllers

configureViewResolvers

addResourceHandlers

configureDefaultServletHandling