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, 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

protected static org.slf4j.Logger

log

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

moduleClass, moduleClassName, moduleFactory, plugin, resources, singleton

Constructor Summary

ServletContextListenerModuleDescriptor(ModuleFactory moduleFactory)

Method Summary

javax.servlet.ServletContextListener

getModule() The particular module object created by this plugin.

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

assertModuleClassImplements, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, init, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

Constructor Detail

ServletContextListenerModuleDescriptor

public ServletContextListenerModuleDescriptor(ModuleFactory moduleFactory)

Parameters:

moduleFactory -

Since:

2.5.0

Method Detail

getModule

public javax.servlet.ServletContextListener getModule()

Description copied from interface: ModuleDescriptor

The particular module object created by this plugin.

Specified by:

getModule in interface ModuleDescriptor<javax.servlet.ServletContextListener>

Specified by:

getModule in class AbstractModuleDescriptor<javax.servlet.ServletContextListener>

Returns:

The module object created by this plugin.

See Also:

ModuleDescriptor.getModuleClass()