com.atlassian.config.lifecycle
Class LifecyclePluginModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      com.atlassian.config.lifecycle.LifecyclePluginModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor, Resourced, Comparable

public class LifecyclePluginModuleDescriptor
extends AbstractModuleDescriptor
implements Comparable

Descriptor for lifecycle plugin modules.

A lifecycle plugin module must either implement LifecycleItem, or ServletContextListener. The latter will automatically be wrapped in a ServletContextListenerWrapper by the descriptor, so getModule() will always return a LifecycleItem instance.

Each module has a sequence number. On startup, the modules will be invoked in ascending order of sequence (lowest to highest), and then on shutdown, the order will be reversed.

Field Summary

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

plugin, singleton

Constructor Summary

LifecyclePluginModuleDescriptor()
Default no-arg constructor

Method Summary

int	compareTo(Object o)
Object	getModule()
int	getSequence()
void	init(Plugin plugin, org.dom4j.Element element)

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

assertModuleClassImplements, destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, satisfiesMinJavaVersion, setPlugin

Methods inherited from class java.lang.Object

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

Constructor Detail

LifecyclePluginModuleDescriptor

public LifecyclePluginModuleDescriptor()

Default no-arg constructor

Method Detail

init

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

Specified by:

init in interface ModuleDescriptor

Overrides:

init in class AbstractModuleDescriptor

Throws:

PluginParseException

getModule

public Object getModule()

Specified by:

getModule in interface ModuleDescriptor

Specified by:

getModule in class AbstractModuleDescriptor

getSequence

public int getSequence()

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable