org.springframework.web.servlet.support

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

WebApplicationInitializer to register a DispatcherServlet and use Java-based Spring configuration.

Implementations are required to implement:

• getRootConfigClasses() -- for "root" application context (non-web infrastructure) configuration.
• getServletConfigClasses() -- for DispatcherServlet application context (Spring MVC infrastructure) configuration.

If an application context hierarchy is not required, applications may return all configuration via getRootConfigClasses() and return null from getServletConfigClasses().

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 and Description
AbstractAnnotationConfigDispatcherServletInitializer()

Method Summary

Modifier and Type	Method and Description
protected WebApplicationContext	createRootApplicationContext() Create the "root" application context to be provided to the ContextLoaderListener.
protected WebApplicationContext	createServletApplicationContext() Create a servlet application context to be provided to the DispatcherServlet.
protected abstract Class<?>[]	getRootConfigClasses() Specify @Configuration and/or @Component classes for the root application context.
protected abstract Class<?>[]	getServletConfigClasses() Specify @Configuration and/or @Component classes for the 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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAnnotationConfigDispatcherServletInitializer

public AbstractAnnotationConfigDispatcherServletInitializer()

Method Detail

createRootApplicationContext

@Nullable
protected WebApplicationContext createRootApplicationContext()

Create the "root" application context to be provided to the ContextLoaderListener.

The returned context is delegated to ContextLoaderListener.ContextLoaderListener(WebApplicationContext) and will be established as the parent context for any DispatcherServlet application contexts. As such, it typically contains middle-tier services, data sources, etc.

This implementation creates an AnnotationConfigWebApplicationContext, providing it the annotated classes returned by getRootConfigClasses(). Returns null if getRootConfigClasses() returns null.

Specified by:

createRootApplicationContext in class AbstractContextLoaderInitializer

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 the DispatcherServlet.

The returned context is delegated to Spring's DispatcherServlet.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 by getServletConfigClasses().

Specified by:

createServletApplicationContext in class AbstractDispatcherServletInitializer

See Also:

AbstractDispatcherServletInitializer.registerDispatcherServlet(ServletContext)

getRootConfigClasses

@Nullable
protected abstract Class<?>[] getRootConfigClasses()

Specify @Configuration and/or @Component classes for the root application context.

Returns:

the configuration for the root application context, or null if creation and registration of a root context is not desired

getServletConfigClasses

@Nullable
protected abstract Class<?>[] getServletConfigClasses()

Specify @Configuration and/or @Component classes for the Servlet application context.

Returns:

the configuration for the Servlet application context, or null if all configuration is specified through root config classes.