com.atlassian.johnson.spring.web.context.support

Class AbstractJohnsonContextLoaderInitializer

java.lang.Object

org.springframework.web.context.AbstractContextLoaderInitializer

com.atlassian.johnson.spring.web.context.support.AbstractJohnsonContextLoaderInitializer

All Implemented Interfaces:

org.springframework.web.WebApplicationInitializer

public abstract class AbstractJohnsonContextLoaderInitializer
extends org.springframework.web.context.AbstractContextLoaderInitializer

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

In addition to using Johnson-aware components by default, this base class allows derived initializers to override the ContextLoaderListener 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.context.AbstractContextLoaderInitializer

logger

Constructor Summary

Constructors

Constructor and Description
AbstractJohnsonContextLoaderInitializer()

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.
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 AbstractContextLoaderInitializer's registerContextLoaderListener to register a JohnsonContextLoaderListener instead of the standard Spring ContextLoaderListener.
protected void	registerJohnsonContextListener(javax.servlet.ServletContext servletContext) Registers an JohnsonContextListener in in the provided ServletContext.

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

AbstractJohnsonContextLoaderInitializer

public AbstractJohnsonContextLoaderInitializer()

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

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.context.AbstractContextLoaderInitializer

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 AbstractContextLoaderInitializer'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

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)