de.skuzzle.tinyplugz

Class TinyPlugzServletContextListener

java.lang.Object

de.skuzzle.tinyplugz.TinyPlugzServletContextListener

All Implemented Interfaces:

EventListener, javax.servlet.ServletContextListener

public abstract class TinyPlugzServletContextListener
extends Object
implements javax.servlet.ServletContextListener

ServletContextListener for configuring TinyPlugz for a web application. Users need to extend this class to provide the actual configuration for TinyPlugz by implementing #configure(DefineProperties, Path). You then need to register the listener in your web.xml:

 <listener>
     <listener-class>com.your.domain.TinyPlugzServletContextListenerImpl</listener-class>
 </listener>
 

TinyPlugz will then be deployed when this listener receives the contextInitialized event and will be undeployed when the listener receives the contextDestroyed event.

Author:

Simon Taddiken

Constructor Summary

Constructors

Constructor and Description
TinyPlugzServletContextListener()

Method Summary

Modifier and Type	Method and Description
protected abstract TinyPlugzConfigurator.DeployTinyPlugz	configure(TinyPlugzConfigurator.DefineProperties props, Path webInfDir) Provides settings for deploying TinyPlugz.
void	contextDestroyed(javax.servlet.ServletContextEvent sce)
void	contextInitialized(javax.servlet.ServletContextEvent sce)

Methods inherited from class java.lang.Object

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

Constructor Detail

TinyPlugzServletContextListener

public TinyPlugzServletContextListener()

Method Detail

configure

protected abstract TinyPlugzConfigurator.DeployTinyPlugz configure(TinyPlugzConfigurator.DefineProperties props,
                                                                   Path webInfDir)

Provides settings for deploying TinyPlugz. The passed in path is the location of the web application's WEB-INF directory and may be used for looking up plugins. Sample implementation of this method:

 @Override
 protected final DeployTinyPlugz configure(DefineProperties props, Path webInfDir) {
     final Path pluginDir = webInfDir.resolve("plugins");

     return props.withProperty(Options.FAIL_ON_MULTIPLE_PROVIDERS)
             .withPlugins(source -> source.addAllPluginJars(pluginDir));
 }
 

Parameters:

props - Builder object for specifying configuration properties.

webInfDir - The location of the WEB-INF directory.

Returns:

The TinyPlugzConfigurator.DeployTinyPlugz instance which is returned by the given builder's withPlugins method.

contextInitialized

public final void contextInitialized(javax.servlet.ServletContextEvent sce)

Specified by:

contextInitialized in interface javax.servlet.ServletContextListener

contextDestroyed

public final void contextDestroyed(javax.servlet.ServletContextEvent sce)

Specified by:

contextDestroyed in interface javax.servlet.ServletContextListener