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

Fields

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

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

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

Constructor Summary

Constructors

Constructor and Description
ServletContextListenerModuleDescriptor(ModuleFactory moduleFactory)

Method Summary

Methods

Modifier and Type	Method and Description
javax.servlet.ServletContextListener	getModule() The particular module object created by this plugin.
void	init(Plugin plugin, org.dom4j.Element element) Initialise a module given it's parent plugin and the XML element representing the module.

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

assertModuleClassImplements, checkPermissions, destroy, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, 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)

Since:

2.5.0

Method Detail

init

public void init(@NotNull
        Plugin plugin,
        @NotNull
        org.dom4j.Element element)
          throws PluginParseException

Description copied from interface: ModuleDescriptor

Initialise a module given it's parent plugin and the XML element representing the module.

Since atlassian-plugins v2.2, you can no longer load classes from the plugin in this method, because the OSGi bundle that they will live in is not built yet. Load classes in the AbstractModuleDescriptor.enabled() method instead.

Specified by:

init in interface ModuleDescriptor<javax.servlet.ServletContextListener>

Overrides:

init in class AbstractModuleDescriptor<javax.servlet.ServletContextListener>

Parameters:

plugin - The plugin that the module belongs to. Must not be null.

element - XML element representing the module. Must not be null.

Throws:

PluginParseException - Can be thrown if an error occurs while parsing the XML element.

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()