Package org.springframework.web.context
Class AbstractContextLoaderInitializer
- java.lang.Object
- org.springframework.web.context.AbstractContextLoaderInitializer
- All Implemented Interfaces:
WebApplicationInitializer
- Direct Known Subclasses:
AbstractDispatcherServletInitializer
public abstract class AbstractContextLoaderInitializer extends Object implements WebApplicationInitializer
Convenient base class forWebApplicationInitializerimplementations that register aContextLoaderListenerin the servlet context.The only method required to be implemented by subclasses is
createRootApplicationContext(), which gets invoked fromregisterContextLoaderListener(ServletContext).- Since:
- 3.2
- Author:
- Arjen Poutsma, Chris Beams, Juergen Hoeller
Constructor Summary
Constructors Constructor Description AbstractContextLoaderInitializer()
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract WebApplicationContextcreateRootApplicationContext()Create the "root" application context to be provided to theContextLoaderListener.protected ApplicationContextInitializer<?>[]getRootApplicationContextInitializers()Specify application context initializers to be applied to the root application context that theContextLoaderListeneris being created with.voidonStartup(ServletContext servletContext)Configure the givenServletContextwith any servlets, filters, listeners context-params and attributes necessary for initializing this web application.protected voidregisterContextLoaderListener(ServletContext servletContext)Register aContextLoaderListeneragainst the given servlet context.
Constructor Detail
AbstractContextLoaderInitializer
public AbstractContextLoaderInitializer()
Method Detail
onStartup
public void onStartup(ServletContext servletContext) throws ServletException
Description copied from interface:WebApplicationInitializerConfigure the givenServletContextwith any servlets, filters, listeners context-params and attributes necessary for initializing this web application. See examples above.- Specified by:
onStartupin interfaceWebApplicationInitializer- Parameters:
servletContext- theServletContextto initialize- Throws:
ServletException- if any call against the givenServletContextthrows aServletException
registerContextLoaderListener
protected void registerContextLoaderListener(ServletContext servletContext)
Register aContextLoaderListeneragainst the given servlet context. TheContextLoaderListeneris initialized with the application context returned from thecreateRootApplicationContext()template method.- Parameters:
servletContext- the servlet context to register the listener against
createRootApplicationContext
protected abstract 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 anyDispatcherServletapplication contexts. As such, it typically contains middle-tier services, data sources, etc.- Returns:
- the root application context, or
nullif a root context is not desired - See Also:
AbstractDispatcherServletInitializer
getRootApplicationContextInitializers
protected ApplicationContextInitializer<?>[] getRootApplicationContextInitializers()
Specify application context initializers to be applied to the root application context that theContextLoaderListeneris being created with.