Package com.atlassian.confluence.plugin.descriptor

Class FieldMappingsProviderModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
com.atlassian.confluence.plugin.descriptor.AbstractFieldMappingsProviderModuleDescriptor<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 AbstractFieldMappingsProviderModuleDescriptor<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(@NonNull com.atlassian.plugin.Plugin plugin, @NonNull com.atlassian.plugin.module.Element element)
     
    protected void
    validate(com.atlassian.plugin.module.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, satisfiesMinJavaVersion, setBroken, setPlugin, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

    getDisplayName

  • Constructor Details

    • FieldMappingsProviderModuleDescriptor

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

  • Method Details