Package com.atlassian.confluence.plugin.descriptor

Class Extractor2ModuleDescriptor

  • All Implemented Interfaces:
    PluginModuleFactory<Extractor2>, com.atlassian.plugin.ModuleDescriptor<Extractor2>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, Comparable<Extractor2ModuleDescriptor>
    @Internal
public class Extractor2ModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Extractor2>
implements Comparable<Extractor2ModuleDescriptor>, PluginModuleFactory<Extractor2>
    A module descriptor that allows plugin to add an Extractor2 into indexing pipeline. e.g. 
     
     <extractor2 name="extraCommentDataExtractor" key="extraCommentDataExtractor"
                 class="com.atlassian.confluence.plugins.extractor.tutorial.ExtraCommentDataExtractor"
                 priority="1100" index="CONTENT" requires-latest-version="true">
     </extractor2>
    Since:
    7.0

    • Field Summary

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

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

    • Constructor Summary

      Constructors 
      Constructor Description
      Extractor2ModuleDescriptor​(com.atlassian.plugin.module.ModuleFactory moduleFactory)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(Extractor2ModuleDescriptor other)
      Module descriptors naturally sort from least to most priority
      Extractor2 createModule()  
      void disabled()  
      void enabled()  
      Extractor2 getModule()  
      int getPriority()  
      SearchIndex getSearchIndex()  
      void init​(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)  
      boolean requiresLatestVersion()  

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

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

        getDisplayName, init

    • Constructor Detail

      • Extractor2ModuleDescriptor

        public Extractor2ModuleDescriptor​(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<Extractor2>
        Overrides:
        init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Extractor2>
        Throws:
        com.atlassian.plugin.PluginParseException

      • getModule

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

      • enabled

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

      • disabled

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

      • getPriority

        public int getPriority()

      • requiresLatestVersion

        public boolean requiresLatestVersion()