Spring Framework 6.1.4 · org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

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 org.springframework.web.bind.annotation.ExceptionHandler methods.
ResponseStatusExceptionResolver for exceptions annotated with org.springframework.web.bind.annotation.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 org.springframework.validation.beanvalidation.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.

Modifier and Type	Class and Description
private static class	WebMvcConfigurationSupport.NoOpValidator

Modifier and Type	Field and Description
private ApplicationContext	applicationContext
private List<HandlerMethodArgumentResolver>	argumentResolvers
private AsyncSupportConfigurer	asyncSupportConfigurer
private ContentNegotiationManager	contentNegotiationManager
private Map<String, CorsConfiguration>	corsConfigurations
private static final boolean	gsonPresent
private List<Object>	interceptors
private static final boolean	jackson2CborPresent
private static final boolean	jackson2Present
private static final boolean	jackson2SmilePresent
private static final boolean	jackson2XmlPresent
private static final boolean	jaxb2Present
private static final boolean	jsonbPresent
private static final boolean	kotlinSerializationCborPresent
private static final boolean	kotlinSerializationJsonPresent
private static final boolean	kotlinSerializationProtobufPresent
private List<HttpMessageConverter<?>>	messageConverters
private PathMatchConfigurer	pathMatchConfigurer
private List<HandlerMethodReturnValueHandler>	returnValueHandlers
private static final boolean	romePresent
private ServletContext	servletContext

Access	Constructor and Description
public	WebMvcConfigurationSupport()

Method Summary

Modifier and Type	Method and Description
protected void	addArgumentResolvers(List<HandlerMethodArgumentResolver> the list of custom converters (initially an empty list) argumentResolvers) Add custom `HandlerMethodArgumentResolvers` to use in addition to the ones registered by default.
protected void	addCorsMappings(CorsRegistry registry) Override this method to configure cross-origin requests processing.
protected final void	addDefaultHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers, ContentNegotiationManager mvcContentNegotiationManager) A method available to subclasses for adding default `HandlerExceptionResolvers`.
protected final void	addDefaultHttpMessageConverters(List<HttpMessageConverter<?>> the list to add the default message converters to messageConverters) Adds a set of default HttpMessageConverter instances to the given list.
protected void	addFormatters(FormatterRegistry registry) Override this method to add custom `Converter` and/or `Formatter` delegates to the common `FormattingConversionService`.
protected void	addInterceptors(InterceptorRegistry registry) Override this method to add Spring MVC interceptors for pre- and post-processing of controller invocation.
protected void	addResourceHandlers(ResourceHandlerRegistry registry) Override this method to add resource handlers for serving static resources.
protected void	addReturnValueHandlers(List<HandlerMethodReturnValueHandler> the list of custom handlers (initially an empty list) returnValueHandlers) Add custom `HandlerMethodReturnValueHandlers` in addition to the ones registered by default.
protected void	addViewControllers(ViewControllerRegistry registry) Override this method to add view controllers.
public BeanNameUrlHandlerMapping	beanNameHandlerMapping(FormattingConversionService conversionService, ResourceUrlProvider resourceUrlProvider) Return a `BeanNameUrlHandlerMapping` ordered at 2 to map URL paths to controller bean names.
protected void	configureAsyncSupport(AsyncSupportConfigurer configurer) Override this method to configure asynchronous request processing options.
protected void	configureContentNegotiation(ContentNegotiationConfigurer configurer) Override this method to configure content negotiation.
protected void	configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) Override this method to configure "default" Servlet handling.
protected void	configureHandlerExceptionResolvers(List<HandlerExceptionResolver> a list to add exception resolvers to (initially an empty list) exceptionResolvers) Override this method to configure the list of `HandlerExceptionResolvers` to use.
protected void	configureMessageConverters(List<HttpMessageConverter<?>> a list to add message converters to (initially an empty list) converters) Override this method to add custom `HttpMessageConverters` to use with the `RequestMappingHandlerAdapter` and the `ExceptionHandlerExceptionResolver`.
protected void	configurePathMatch(PathMatchConfigurer configurer) Override this method to configure path matching options.
protected void	configureViewResolvers(ViewResolverRegistry registry) Override this method to configure view resolution.
protected ExceptionHandlerExceptionResolver	createExceptionHandlerExceptionResolver() Protected method for plugging in a custom subclass of `ExceptionHandlerExceptionResolver`.
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`.
public HandlerMapping	defaultServletHandlerMapping() Return a handler mapping ordered at Integer.MAX_VALUE with a mapped default servlet handler.
protected void	extendHandlerExceptionResolvers(List<HandlerExceptionResolver> the list of configured resolvers to extend. exceptionResolvers) Override this method to extend or modify the list of `HandlerExceptionResolvers` after it has been configured.
protected void	extendMessageConverters(List<HttpMessageConverter<?>> the list of configured converters to extend converters) Override this method to extend or modify the list of converters after it has been configured.
public FlashMapManager	flashMapManager()
public final 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 mvcConversionService, Validator 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()
protected final Object[]	getInterceptors(FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider) Provide access to the shared handler interceptors used to configure `HandlerMapping` instances with.
protected 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`.
public final ServletContext	getServletContext() Return the associated `jakarta.servlet.ServletContext`.
protected Validator	getValidator() Override this method to provide a custom `Validator`.
public HandlerExceptionResolver	handlerExceptionResolver(ContentNegotiationManager contentNegotiationManager) Returns a `HandlerExceptionResolverComposite` containing a list of exception resolvers obtained either through `configureHandlerExceptionResolvers` or through `addDefaultHandlerExceptionResolvers`.
public HandlerFunctionAdapter	handlerFunctionAdapter() Returns a `HandlerFunctionAdapter` for processing requests through handler functions.
public HttpRequestHandlerAdapter	httpRequestHandlerAdapter() Returns a `HttpRequestHandlerAdapter` for processing requests with `HttpRequestHandlers`.
private void	initHandlerMapping(AbstractHandlerMapping mapping, FormattingConversionService conversionService, ResourceUrlProvider resourceUrlProvider)
public LocaleResolver	localeResolver()
public ContentNegotiationManager	mvcContentNegotiationManager() Return a `ContentNegotiationManager` instance to use to determine requested media types in a given request.
public FormattingConversionService	mvcConversionService() Return a `FormattingConversionService` for use with annotated controllers.
public HandlerMappingIntrospector	mvcHandlerMappingIntrospector()
public PathMatcher	mvcPathMatcher() Return a global `PathMatcher` instance which is used for URL path matching with String patterns.
public PathPatternParser	mvcPatternParser() Return a global `PathPatternParser` instance to use for parsing patterns to match to the `org.springframework.http.server.RequestPath`.
public ResourceUrlProvider	mvcResourceUrlProvider() A `ResourceUrlProvider` bean for use with the MVC dispatcher.
public CompositeUriComponentsContributor	mvcUriComponentsContributor(FormattingConversionService conversionService, RequestMappingHandlerAdapter requestMappingHandlerAdapter) Return an instance of `CompositeUriComponentsContributor` for use with `org.springframework.web.servlet.mvc.method.annotation.MvcUriComponentsBuilder`.
public UrlPathHelper	mvcUrlPathHelper() Return a global `UrlPathHelper` instance which is used to resolve the request mapping path for an application.
public Validator	mvcValidator() Return a global `Validator` instance for example for validating `@ModelAttribute` and `@RequestBody` method arguments.
public ViewResolver	mvcViewResolver(ContentNegotiationManager contentNegotiationManager) Register a `ViewResolverComposite` that contains a chain of view resolvers to use for view resolution.
public RequestMappingHandlerAdapter	requestMappingHandlerAdapter(ContentNegotiationManager contentNegotiationManager, FormattingConversionService conversionService, Validator validator) Returns a `RequestMappingHandlerAdapter` for processing requests through annotated controller methods.
public RequestMappingHandlerMapping	requestMappingHandlerMapping(ContentNegotiationManager contentNegotiationManager, FormattingConversionService conversionService, ResourceUrlProvider resourceUrlProvider) Return a `RequestMappingHandlerMapping` ordered at 0 for mapping requests to annotated controllers.
public HandlerMapping	resourceHandlerMapping(ContentNegotiationManager contentNegotiationManager, FormattingConversionService conversionService, ResourceUrlProvider resourceUrlProvider) Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers.
public RouterFunctionMapping	routerFunctionMapping(FormattingConversionService conversionService, ResourceUrlProvider resourceUrlProvider) Return a `RouterFunctionMapping` ordered at -1 to map router functions.
public void	setApplicationContext(ApplicationContext the ApplicationContext object to be used by this object applicationContext) Implements org.springframework.context.ApplicationContextAware.setApplicationContext. Set the Spring `ApplicationContext`, e.g. for resource loading.
public void	setServletContext(ServletContext the ServletContext object to be used by this object servletContext) Implements org.springframework.web.context.ServletContextAware.setServletContext. Set the `jakarta.servlet.ServletContext`, e.g. for resource handling, looking up file extensions, etc.
public SimpleControllerHandlerAdapter	simpleControllerHandlerAdapter() Returns a `SimpleControllerHandlerAdapter` for processing requests with interface-based controllers.
public ThemeResolver	themeResolver() Deprecated
public HandlerMapping	viewControllerHandlerMapping(FormattingConversionService conversionService, ResourceUrlProvider resourceUrlProvider) Return a handler mapping ordered at 1 to map URL paths directly to view names.
public RequestToViewNameTranslator	viewNameTranslator()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class WebMvcConfigurationSupport

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary