com.atlassian.johnson.spring.web.servlet.support

Class AbstractJohnsonDispatcherServletInitializer

java.lang.Object

org.springframework.web.context.AbstractContextLoaderInitializer

org.springframework.web.servlet.support.AbstractDispatcherServletInitializer

com.atlassian.johnson.spring.web.servlet.support.AbstractJohnsonDispatcherServletInitializer

All Implemented Interfaces:

org.springframework.web.WebApplicationInitializer

public abstract class AbstractJohnsonDispatcherServletInitializer
extends org.springframework.web.servlet.support.AbstractDispatcherServletInitializer

Extends Spring's AbstractDispatcherServletInitializer to use Johnson-aware components.

• A JohnsonContextListener will be registered before any other listeners that are registered by this initializer
• A JohnsonContextLoaderListener will be used to initialize the root ApplicationContext, if one is created
• A JohnsonDispatcherServlet will be used to initialize the servlet ApplicationContext

In addition to using Johnson-aware components by default, this base class allows derived initializers to override the ContextLoaderListener and DispatcherServlet types used. This is intended to allow for application-specific handling on top of the Johnson-aware handling.

Since:

3.0

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
AbstractJohnsonDispatcherServletInitializer()

Method Summary

Modifier and Type	Method and Description
protected org.springframework.web.context.ContextLoaderListener	createContextLoaderListener(org.springframework.web.context.WebApplicationContext context) Creates a JohnsonContextLoaderListener which will initialize and terminate the provided WebApplicationContext.
protected org.springframework.web.servlet.DispatcherServlet	createDispatcherServlet(org.springframework.web.context.WebApplicationContext context) Creates a JohnsonDispatcherServlet, which will initialize the SpringMVC context in a Johnson-aware away.
void	onStartup(javax.servlet.ServletContext servletContext) Registers a JohnsonContextListener and then delegates to the superclass's onStartup(ServletContext) implementation.
protected void	registerContextLoaderListener(javax.servlet.ServletContext servletContext) Overrides AbstractContextLoaderListener's registerContextLoaderListener to register a JohnsonContextLoaderListener instead of the standard Spring ContextLoaderListener.
protected void	registerDispatcherServlet(javax.servlet.ServletContext servletContext) Overrides AbstractDispatcherServletInitializer's registerDispatcherServlet(ServletContext) to register a JohnsonDispatcherServlet instead of the standard Spring DispatcherServlet.
protected void	registerJohnsonContextListener(javax.servlet.ServletContext servletContext) Registers an JohnsonContextListener in in the provided ServletContext.

Methods inherited from class org.springframework.web.servlet.support.AbstractDispatcherServletInitializer

createServletApplicationContext, customizeRegistration, getServletFilters, getServletMappings, getServletName, isAsyncSupported, registerServletFilter

Methods inherited from class org.springframework.web.context.AbstractContextLoaderInitializer

createRootApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJohnsonDispatcherServletInitializer

public AbstractJohnsonDispatcherServletInitializer()

Method Detail

createContextLoaderListener

protected org.springframework.web.context.ContextLoaderListener createContextLoaderListener(org.springframework.web.context.WebApplicationContext context)

Creates a JohnsonContextLoaderListener which will initialize and terminate the provided WebApplicationContext. This method is provided as a convenience for derived classes to simplify replacing the listener used.

Parameters:

context - the WebApplicationContext to be initialized by the created listener

Returns:

the listener to register with the ServletContext

createDispatcherServlet

protected org.springframework.web.servlet.DispatcherServlet createDispatcherServlet(org.springframework.web.context.WebApplicationContext context)

Creates a JohnsonDispatcherServlet, which will initialize the SpringMVC context in a Johnson-aware away. If SpringMVC initialization fails, the application will be locked.

Parameters:

context - the WebApplicationContext to be initialized by the created dispatcher

Returns:

the servlet to register with the ServletContext

onStartup

public void onStartup(javax.servlet.ServletContext servletContext)
               throws javax.servlet.ServletException

Registers a JohnsonContextListener and then delegates to the superclass's onStartup(ServletContext) implementation.

Specified by:

onStartup in interface org.springframework.web.WebApplicationInitializer

Overrides:

onStartup in class org.springframework.web.servlet.support.AbstractDispatcherServletInitializer

Parameters:

servletContext - the ServletContext to initialize

Throws:

javax.servlet.ServletException - potentially thrown by the superclass onStartup(ServletContext) implementation

registerContextLoaderListener

protected void registerContextLoaderListener(javax.servlet.ServletContext servletContext)

Overrides AbstractContextLoaderListener's registerContextLoaderListener to register a JohnsonContextLoaderListener instead of the standard Spring ContextLoaderListener.

Overrides:

registerContextLoaderListener in class org.springframework.web.context.AbstractContextLoaderInitializer

Parameters:

servletContext - the ServletContext to register the JohnsonContextLoaderListener in

registerDispatcherServlet

protected void registerDispatcherServlet(javax.servlet.ServletContext servletContext)

Overrides AbstractDispatcherServletInitializer's registerDispatcherServlet(ServletContext) to register a JohnsonDispatcherServlet instead of the standard Spring DispatcherServlet.

Overrides:

registerDispatcherServlet in class org.springframework.web.servlet.support.AbstractDispatcherServletInitializer

Parameters:

servletContext - the ServletContext to register the JohnsonDispatcherServlet in

registerJohnsonContextListener

protected void registerJohnsonContextListener(javax.servlet.ServletContext servletContext)

Registers an JohnsonContextListener in in the provided ServletContext. This listener ensures Johnson is initialized and terminated with the application.

Note: Even if this method is called multiple times, with its default implementation the listener will only be added once.

Parameters:

servletContext - the ServletContext to register the JohnsonContextListener in

See Also:

JohnsonContextListener.register(ServletContext)