Class AbstractAnnotationConfigDispatcherServletInitializer
- java.lang.Object
- org.springframework.web.context.AbstractContextLoaderInitializer
- org.springframework.web.servlet.support.AbstractDispatcherServletInitializer
- org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer
- All Implemented Interfaces:
WebApplicationInitializer
public abstract class AbstractAnnotationConfigDispatcherServletInitializer extends AbstractDispatcherServletInitializer
Base class forWebApplicationInitializer
implementations that register aDispatcherServlet
configured with annotated classes, e.g. Spring's@Configuration
classes.Concrete implementations are required to implement
getRootConfigClasses()
andgetServletConfigClasses()
as well asAbstractDispatcherServletInitializer.getServletMappings()
. Further template and customization methods are provided byAbstractDispatcherServletInitializer
.This is the preferred approach for applications that use Java-based Spring configuration.
- Since:
- 3.2
- Author:
- Arjen Poutsma, Chris Beams
Field Summary
Fields inherited from class org.springframework.web.servlet.support.AbstractDispatcherServletInitializer
DEFAULT_SERVLET_NAME
Fields inherited from class org.springframework.web.context.AbstractContextLoaderInitializer
logger
Constructor Summary
Constructors Constructor Description AbstractAnnotationConfigDispatcherServletInitializer()
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected WebApplicationContext
createRootApplicationContext()
Create the "root" application context to be provided to theContextLoaderListener
.protected WebApplicationContext
createServletApplicationContext()
Create a servlet application context to be provided to theDispatcherServlet
.protected abstract Class<?>[]
getRootConfigClasses()
protected abstract Class<?>[]
getServletConfigClasses()
Specify@Configuration
and/or@Component
classes to be provided to the dispatcher servlet application context.Methods inherited from class org.springframework.web.servlet.support.AbstractDispatcherServletInitializer
createDispatcherServlet, customizeRegistration, getServletApplicationContextInitializers, getServletFilters, getServletMappings, getServletName, isAsyncSupported, onStartup, registerDispatcherServlet, registerServletFilter
Methods inherited from class org.springframework.web.context.AbstractContextLoaderInitializer
getRootApplicationContextInitializers, registerContextLoaderListener
Constructor Detail
AbstractAnnotationConfigDispatcherServletInitializer
public AbstractAnnotationConfigDispatcherServletInitializer()
Method Detail
createRootApplicationContext
protected WebApplicationContext createRootApplicationContext()
Create the "root" application context to be provided to theContextLoaderListener
.The returned context is delegated to
ContextLoaderListener(WebApplicationContext)
and will be established as the parent context for anyDispatcherServlet
application contexts. As such, it typically contains middle-tier services, data sources, etc.This implementation creates an
AnnotationConfigWebApplicationContext
, providing it the annotated classes returned bygetRootConfigClasses()
. Returnsnull
ifgetRootConfigClasses()
returnsnull
.- Specified by:
createRootApplicationContext
in classAbstractContextLoaderInitializer
- Returns:
- the root application context, or
null
if a root context is not desired - See Also:
AbstractDispatcherServletInitializer
createServletApplicationContext
protected WebApplicationContext createServletApplicationContext()
Create a servlet application context to be provided to theDispatcherServlet
.The returned context is delegated to Spring's
DispatcherServlet(WebApplicationContext)
. As such, it typically contains controllers, view resolvers, locale resolvers, and other web-related beans.This implementation creates an
AnnotationConfigWebApplicationContext
, providing it the annotated classes returned bygetServletConfigClasses()
.
getRootConfigClasses
protected abstract Class<?>[] getRootConfigClasses()
- Returns:
- the configuration classes for the root application context, or
null
if creation and registration of a root context is not desired
getServletConfigClasses
protected abstract Class<?>[] getServletConfigClasses()
Specify@Configuration
and/or@Component
classes to be provided to the dispatcher servlet application context.- Returns:
- the configuration classes for the dispatcher servlet application context or
null
if all configuration is specified through root config classes.