org.springframework.web.servlet.config.annotation Documentation Differences

This file contains all the changes in documentation in the package org.springframework.web.servlet.config.annotation as colored differences. Deletions are shown like this, and additions are shown like this.

If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.

Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

ExtendsA sub-class of {@code WebMvcConfigurationSupport} withthat thedetects and abilitydelegates to detectall beans beans of type WebMvcConfigurer and giveallowing them a chance to customize the the configuration provided configuration by delegating{@code toWebMvcConfigurationSupport}. them at the appropriateThis is the class times. actually imported by @EnableWebMvc. @author Rossen Stoyanchev @since 3.1 @see EnableWebMvc1

EncapsulatesAssists a HandlerInterceptor and an optional list ofwith URL patterns. Results in the creation of a MappedInterceptor if URL patterns are provided. @author Rossen Stoyanchev @author Keith Donald @since 3.1

AddsAdd one or more URL patterns to which the registered interceptor should apply to. If no URL patterns are provided, the interceptor applies to all paths.

Returns the underlying interceptor. If URL patterns are provided the returned type isis MappedInterceptor; otherwise HandlerInterceptor.

Stores and providesHelps with configuring access to a list of interceptors. For each interceptor you can optionally mapped specify one or more URL patterns it applies tointerceptors. @author Rossen Stoyanchev @author Keith Donald Donald @since 3.1

Adds the provided HandlerInterceptor. @param interceptor the interceptor to add @return An InterceptorRegistration that allows you optionally configure the the registered interceptor further for example adding URL patterns it should apply to.

Adds the provided WebRequestInterceptor. @param interceptor the interceptor to add @return An InterceptorRegistration that allows you optionally configure the the registered interceptor further for example adding URL patterns it should apply to.

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

This class registers the following HandlerMappings:

• 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 {@code Integer.MAX_VALUE-1} to serve static resource requests.
• HandlerMapping ordered at {@code 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.

Registers a HandlerExceptionResolverComposite with this chain of exception resolvers:

• ExceptionHandlerExceptionResolver for handling exceptions exceptions through @ExceptionHandler methods.
• ResponseStatusExceptionResolver for exceptions annotated annotated with @ResponseStatus.
• DefaultHandlerExceptionResolver for resolving known Spring Spring exception types

Both the RequestMappingHandlerAdapter and the the ExceptionHandlerExceptionResolver are configured with default default instances of the following kind, unless custom instances areby provideddefault:

• A ContentNegotiationManager
• A DefaultFormattingConversionService
• A LocalValidatorFactoryBean if a JSR-303 implementation is is available on the classpath
• A range of HttpMessageConverters depending on the 3rd party party libraries available on the classpath.

@see EnableWebMvc @see WebMvcConfigurer @see WebMvcConfigurerAdapter @author Rossen Stoyanchev @since 3.1

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

Custom argument resolvers are invoked before built-in resolvers resolvers except for those that rely on the presence of annotations (e.g. {@code @RequestParameter}, {@code @PathVariable}, etc.). The latter can be customized by configuring the the RequestMappingHandlerAdapter directly. @param argumentResolvers the list of custom converters; initially an empty list.

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

Adds a set of default HttpMessageConverter instances to the given list. Subclasses can call this method from .configureMessageConverters(List). @param messageConverters the list to add the default message converters to

Override this method to add Spring MVC interceptors forfor pre- and post-processing of controller invocation. @see InterceptorRegistry

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

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

Custom return value handlers are invoked before built-in ones exceptexcept for those that rely on the presence of annotations (e.g. {@code @ResponseBody}, {@code @ModelAttribute}, etc.). The latter can be customized by configuring the the RequestMappingHandlerAdapter directly. @param returnValueHandlers the list of custom handlers; initially an empty list.

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

Override this method to configure "default" Servlet handling. @see DefaultServletHandlerConfigurer

Override this method to configure the list ofof HandlerExceptionResolvers to use. Adding resolvers to the list list turns off the default resolvers that would otherwise be registered byby default. Also see .addDefaultHandlerExceptionResolvers(List) that can be used to add the default exception resolvers. @param exceptionResolvers a list to add exception resolvers to; initially an empty list.

Override this method to add custom HttpMessageConverters to useuse with the RequestMappingHandlerAdapter and the the ExceptionHandlerExceptionResolver. Adding converters to the the list turns off the default converters that would otherwise be registered by default. Also see .addDefaultHttpMessageConverters(List) that that can be used to add default message converters. @param converters a list to add message converters to; initially an empty list.

Return a handler mapping ordered at Integer.MAX_VALUE with a mappedmapped default servlet handler. To configure "default" Servlet handling, override .configureDefaultServletHandling.

Provide access to the shared handler interceptors used to configureconfigure HandlerMapping instances with. This method cannot be overridden, use .addInterceptors(InterceptorRegistry) instead.

Provides access to the shared HttpMessageConverters used by the the RequestMappingHandlerAdapter and the the ExceptionHandlerExceptionResolver. This method cannot be overridden. Use .configureMessageConverters(List) instead. Also see .addDefaultHttpMessageConverters(List) that can be be used to add default message converters.

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

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

Returns a HttpRequestHandlerAdapter for processing requestsrequests with HttpRequestHandlers.

Returns a FormattingConversionService for use with annotatedannotated controller methods and the {@code spring:eval} JSP tag. Also see .addFormatters as an alternative to overriding this method.

Returns a global Validator instance for example for validatingvalidating {@code @ModelAttribute} and {@code @RequestBody} method arguments. Delegates to .getValidator() first and if that returns {@code null} checks the classpath for the presence of a JSR-303 implementations before creating a {@code LocalValidatorFactoryBean}.If a JSR-303 303 implementation is not available, a no-op Validator is returned.

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

• .addArgumentResolvers for adding custom argument resolvers.
• .addReturnValueHandlers for adding custom return value handlers.
• .configureMessageConverters for adding custom message converters.

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

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

Returns a SimpleControllerHandlerAdapter for processing requestsrequests with interface-based controllers.

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

Defines callback methods to customize the Java-based configuration forfor Spring MVC enabled via {@code @EnableWebMvc}.

{@code @EnableWebMvc}-annotated configuration classes may implement 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. @author Rossen Stoyanchev @author Keith Donald @author David Syer @since 3.1

Add resolvers to support custom controller method argument types.

This does not override the built-in support for resolving handler handler method arguments. To customize the built-in support for argument argument resolution, configure RequestMappingHandlerAdapter directly. @param argumentResolvers initially an empty list

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

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

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

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 return values, configure RequestMappingHandlerAdapter directly. @param returnValueHandlers initially an empty list

Add view controllers to create a direct mapping between a URL path andand view name without the need for a controller in between.

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

Configure the HandlerExceptionResolvers to handle unresolvedunresolved controller exceptions. If no resolvers are added to the list, default exception resolvers are added instead. @param exceptionResolvers initially an empty list

An convenient baseimplementation of classWebMvcConfigurer with empty method implementationsmethods allowing ofsub-classes WebMvcConfigurerto override only the methods they're interested in. @author Rossen Stoyanchev @since 3.1