org.jasypt.web.pbeconfig

Class WebPBEInitializationContextListener

java.lang.Object

org.jasypt.web.pbeconfig.WebPBEInitializationContextListener

All Implemented Interfaces:

EventListener, ServletContextListener

public final class WebPBEInitializationContextListener
extends Object
implements ServletContextListener

ContextListener which takes a WebPBEInitializer implementation class name as a parameter (<context-param>) and calls its initializeWebPBEConfigs() method to allow the webapp to create its PBE encryptors and declare their associated WebPBEConfig objects.

An example web.xml fragment:

    <context-param>
      <param-name>webPBEInitializerClassName</param-name>
      <param-value>myapp.MyWebPBEInitializer</param-value>
    </context-param>

    <listener>
      <listener-class>
        org.jasypt.web.pbeconfig.WebPBEInitializationContextListener
      </listener-class>
    </listener>
 

Important: If the web application uses Spring Framework, WebPBEConfig objects are declared as beans in the Spring context and this Spring context is initialized at application deploy time (with Spring's ContextLoaderListener), the use of this context listener will become unnecessary.

Since:

1.3

Author:

Daniel Fernández

Field Summary

Fields

Modifier and Type	Field and Description
static String	INIT_PARAM_INITIALIZER_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
WebPBEInitializationContextListener()

Method Summary

Modifier and Type	Method and Description
void	contextDestroyed(ServletContextEvent sce) Receives notification that the ServletContext is about to be shut down.
void	contextInitialized(ServletContextEvent sce) Receives notification that the web application initialization process is starting.

Methods inherited from class java.lang.Object

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

Field Detail

INIT_PARAM_INITIALIZER_CLASS_NAME

public static final String INIT_PARAM_INITIALIZER_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

WebPBEInitializationContextListener

public WebPBEInitializationContextListener()

Method Detail

contextDestroyed

public void contextDestroyed(ServletContextEvent sce)

Description copied from interface: ServletContextListener

Receives notification that the ServletContext is about to be shut down.

All servlets and filters will have been destroyed before any ServletContextListeners are notified of context destruction.

Specified by:

contextDestroyed in interface ServletContextListener

Parameters:

sce - the ServletContextEvent containing the ServletContext that is being destroyed

contextInitialized

public void contextInitialized(ServletContextEvent sce)

Description copied from interface: ServletContextListener

Receives notification that the web application initialization process is starting.

All ServletContextListeners are notified of context initialization before any filters or servlets in the web application are initialized.

Specified by:

contextInitialized in interface ServletContextListener

Parameters:

sce - the ServletContextEvent containing the ServletContext that is being initialized