Package com.atlassian.confluence.plugin.descriptor

Class PermissionOverrideExtensionDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<PermissionOverrideExtension>
com.atlassian.confluence.plugin.descriptor.PermissionOverrideExtensionDescriptor
All Implemented Interfaces:
PluginModuleFactory<PermissionOverrideExtension>, com.atlassian.plugin.ModuleDescriptor<PermissionOverrideExtension>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, com.atlassian.plugin.web.api.descriptors.WeightedDescriptor
@ExperimentalApi public final class PermissionOverrideExtensionDescriptor extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<PermissionOverrideExtension> implements com.atlassian.plugin.web.api.descriptors.WeightedDescriptor, PluginModuleFactory<PermissionOverrideExtension>
A module descriptor that allows the adding of a PermissionOverrideExtension into Confluence. To register the override add the following code block to your atlassian-plugin.xml 
 
  <permission-override-extension key="myPermissionOverride" class="com.mycompany.mypackage.MyPermissionOverride" weight="1"/>
Since:
9.2.6

  • Field Summary

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

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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    PermissionOverrideExtension
    createModule()
     
    void
    disabled()
     
    void
    enabled()
     
    PermissionOverrideExtension
    getModule()
     
    int
    getWeight()
     
    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, 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

  • Constructor Details

    • PermissionOverrideExtensionDescriptor

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

    • createModule

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

    • getModule

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

    • enabled

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

    • disabled

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

    • getWeight

      public int getWeight()
      Specified by:
      getWeight in interface com.atlassian.plugin.web.api.descriptors.WeightedDescriptor