Package com.atlassian.plugin.servlet.descriptors

Class ServletContextListenerModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<javax.servlet.ServletContextListener>

com.atlassian.plugin.servlet.descriptors.ServletContextListenerModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor<javax.servlet.ServletContextListener>, Resourced, ScopeAware, StateAware

public class ServletContextListenerModuleDescriptor
extends AbstractModuleDescriptor<javax.servlet.ServletContextListener>

Provides a way for plugins to declare ServletContextListeners so they can be notified when the ServletContext is created for the plugin. Implementors need to extend this class and implement the {#link autowireObject} method.

Since:

2.1.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	log

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor	Description
ServletContextListenerModuleDescriptor(ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method	Description
javax.servlet.ServletContextListener	getModule()
void	init(Plugin plugin, Element element)

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

getDisplayName

Field Details

log

protected static final org.slf4j.Logger log

Constructor Details

ServletContextListenerModuleDescriptor

public ServletContextListenerModuleDescriptor(ModuleFactory moduleFactory)

Since:

2.5.0

Method Details

init

public void init(@Nonnull
 Plugin plugin,
 @Nonnull
 Element element)

Specified by:

init in interface ModuleDescriptor<javax.servlet.ServletContextListener>

Overrides:

init in class AbstractModuleDescriptor<javax.servlet.ServletContextListener>

getModule

public javax.servlet.ServletContextListener getModule()

Specified by:

getModule in interface ModuleDescriptor<javax.servlet.ServletContextListener>

Specified by:

getModule in class AbstractModuleDescriptor<javax.servlet.ServletContextListener>