org.resthub.web.springmvc.router

Class RouterConfigurationSupport

java.lang.Object

org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

org.springframework.web.servlet.config.annotation.DelegatingWebMvcConfiguration

org.resthub.web.springmvc.router.RouterConfigurationSupport

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware

public abstract class RouterConfigurationSupport
extends org.springframework.web.servlet.config.annotation.DelegatingWebMvcConfiguration

This class provides MVC Java config support for the RouterHandlerMapping, on top of the existing WebMvcConfigurationSupport. Unlike WebMvcConfigurationSupport, you SHOULD NOT import it using @EnableWebMvc within an application @Configuration class. Extending this class and adding @Configuration is enough. You should also implement the configureRouteFiles method to add the list of route configuration files. You can then instantiate your own beans and override WebMvcConfigurationSupport methods.

This class registers the following HandlerMappings:

• RouterHandlerMapping 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.
• RequestMappingHandlerMapping ordered at 3 for mapping requests to annotated controller methods.
• 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.

Author:

Brian Clozel

See Also:

WebMvcConfigurationSupport

Constructor Summary

Constructors

Constructor and Description
RouterConfigurationSupport()

Method Summary

Methods

Modifier and Type	Method and Description
RouterHandlerMapping	createRouterHandlerMapping() Return a RouterHandlerMapping ordered at 0 for mapping requests to controllers' actions mapped by routes.
protected boolean	isHandlerMappingReloadEnabled() By default, route configuration files auto-reload is not enabled.
abstract List<String>	listRouteFiles() Return the ordered list of route configuration files to be loaded by the Router at startup.
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping	requestMappingHandlerMapping() Return a RequestMappingHandlerMapping ordered at 3 for mapping requests to annotated controllers.

Methods inherited from class org.springframework.web.servlet.config.annotation.DelegatingWebMvcConfiguration

addArgumentResolvers, addFormatters, addInterceptors, addResourceHandlers, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, getMessageCodesResolver, getValidator, setConfigurers

Methods inherited from class org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

addDefaultHandlerExceptionResolvers, addDefaultHttpMessageConverters, beanNameHandlerMapping, defaultServletHandlerMapping, getConfigurableWebBindingInitializer, getDefaultMediaTypes, getInterceptors, getMessageConverters, handlerExceptionResolver, httpRequestHandlerAdapter, mvcContentNegotiationManager, mvcConversionService, mvcValidator, requestMappingHandlerAdapter, resourceHandlerMapping, setApplicationContext, setServletContext, simpleControllerHandlerAdapter, viewControllerHandlerMapping

Methods inherited from class java.lang.Object

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

Constructor Detail

RouterConfigurationSupport

public RouterConfigurationSupport()

Method Detail

createRouterHandlerMapping

@Bean
public RouterHandlerMapping createRouterHandlerMapping()

Return a RouterHandlerMapping ordered at 0 for mapping requests to controllers' actions mapped by routes.

isHandlerMappingReloadEnabled

protected boolean isHandlerMappingReloadEnabled()

By default, route configuration files auto-reload is not enabled. You can override this method to enable this feature.

See Also:

RouterHandlerMapping

requestMappingHandlerMapping

@Bean
public org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping requestMappingHandlerMapping()

Return a RequestMappingHandlerMapping ordered at 3 for mapping requests to annotated controllers.

Overrides:

requestMappingHandlerMapping in class org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

listRouteFiles

public abstract List<String> listRouteFiles()

Return the ordered list of route configuration files to be loaded by the Router at startup.