Package com.atlassian.confluence.impl.setup

Class LifecyclePluginModuleDescriptor

  • All Implemented Interfaces:
    com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, Comparable<LifecyclePluginModuleDescriptor>
    public class LifecyclePluginModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor
implements Comparable<LifecyclePluginModuleDescriptor>
    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.

    Since:
    6.6.0

    • Field Summary

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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(LifecyclePluginModuleDescriptor o)  
      void disabled()  
      void enabled()  
      Object getModule()  
      int getSequence()  
      void init​(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)  

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

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

      • Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

        getDisplayName

    • Constructor Detail

      • LifecyclePluginModuleDescriptor

        public LifecyclePluginModuleDescriptor​(com.atlassian.plugin.module.ModuleFactory moduleFactory)

    • Method Detail

      • init

        public void init​(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException
        Specified by:
        init in interface com.atlassian.plugin.ModuleDescriptor
        Overrides:
        init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
        Throws:
        com.atlassian.plugin.PluginParseException

      • getModule

        public Object getModule()
        Specified by:
        getModule in interface com.atlassian.plugin.ModuleDescriptor
        Specified by:
        getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

      • enabled

        public void enabled()
        Specified by:
        enabled in interface com.atlassian.plugin.StateAware
        Overrides:
        enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

      • disabled

        public void disabled()
        Specified by:
        disabled in interface com.atlassian.plugin.StateAware
        Overrides:
        disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

      • getSequence

        public int getSequence()