Package com.atlassian.confluence.plugin.descriptor

Class FieldMappingsProviderModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<FieldMappingsProvider>
com.atlassian.confluence.plugin.descriptor.FieldMappingsProviderModuleDescriptor
All Implemented Interfaces:
PluginModuleFactory<FieldMappingsProvider>, com.atlassian.plugin.ModuleDescriptor<FieldMappingsProvider>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
public class FieldMappingsProviderModuleDescriptor extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<FieldMappingsProvider> implements PluginModuleFactory<FieldMappingsProvider>
A module descriptor that allows plugin to add an FieldMapping into the search index. e.g. 
 
     <field-mappings-provider name="extraCommentMappings" key="extraCommentMappings"
                 class="com.atlassian.confluence.plugins.index.tutorial.ExtraCommentMappings"
                 index="CONTENT" />
Since:
8.8

  • Field Summary

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

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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    FieldMappingsProvider
    createModule()
     
    void
    disabled()
     
    void
    enabled()
     
    List<Index>
    getIndices()
     
    FieldMappingsProvider
    getModule()
     
    void
    init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
     
    protected void
    provideValidationRules(com.atlassian.plugin.util.validation.ValidationPattern pattern)
     

    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, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

    getDisplayName, init

  • Constructor Details

    • FieldMappingsProviderModuleDescriptor

      public FieldMappingsProviderModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

  • Method Details

    • init

      public void init(@Nonnull com.atlassian.plugin.Plugin plugin, @Nonnull org.dom4j.Element element)
      Specified by:
      init in interface com.atlassian.plugin.ModuleDescriptor<FieldMappingsProvider>
      Overrides:
      init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<FieldMappingsProvider>

    • provideValidationRules

      protected void provideValidationRules(com.atlassian.plugin.util.validation.ValidationPattern pattern)
      Overrides:
      provideValidationRules in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<FieldMappingsProvider>

    • getIndices

      public List<Index> getIndices()
      Returns:
      search indices that the field mappings will be added onto

    • createModule

      public FieldMappingsProvider createModule()
      Specified by:
      createModule in interface PluginModuleFactory<FieldMappingsProvider>

    • getModule

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

    • enabled

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

    • disabled

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