Package com.atlassian.confluence.plugins.contentproperty.index.config

Class ContentPropertyIndexSchemaModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
com.atlassian.confluence.plugin.descriptor.AbstractFieldMappingsProviderModuleDescriptor<ContentPropertyIndexSchema>
com.atlassian.confluence.plugins.contentproperty.index.config.ContentPropertyIndexSchemaModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<ContentPropertyIndexSchema>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
public final class ContentPropertyIndexSchemaModuleDescriptor extends AbstractFieldMappingsProviderModuleDescriptor<ContentPropertyIndexSchema>
Exposes read content property index schema as a module, bound to an add-on lifecycle. Whenever add-on gets disabled, its index schema won't be accessible via ContentPropertyIndexSchemaManager.
Since:
5.7
See Also:

  • Field Summary

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

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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    disabled()
     
    void
    enabled()
     
    List<Index>
    getIndices()
     
    ContentPropertyIndexSchema
    getModule()
     
    protected String
    getModuleClassName()
     
    void
    init(@NonNull com.atlassian.plugin.Plugin plugin, @NonNull 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, 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

  • Constructor Details

    • ContentPropertyIndexSchemaModuleDescriptor

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

  • Method Details

    • init

      public void init(@NonNull com.atlassian.plugin.Plugin plugin, @NonNull com.atlassian.plugin.module.Element element) throws com.atlassian.plugin.PluginParseException
      Specified by:
      init in interface com.atlassian.plugin.ModuleDescriptor<ContentPropertyIndexSchema>
      Overrides:
      init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<ContentPropertyIndexSchema>
      Throws:
      com.atlassian.plugin.PluginParseException

    • getModule

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

    • disabled

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

    • enabled

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

    • getIndices

      public List<Index> getIndices()
      Specified by:
      getIndices in class AbstractFieldMappingsProviderModuleDescriptor<ContentPropertyIndexSchema>
      Returns:
      List of indexes which the fields should be created in

    • getModuleClassName

      protected String getModuleClassName()
      Overrides:
      getModuleClassName in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<ContentPropertyIndexSchema>