Package com.codebarrel.jira.plugin.automation.module.legacy

Class AutomationActionModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.plugin.automation.core.Action>
com.codebarrel.jira.plugin.automation.module.legacy.AutomationActionModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<com.atlassian.plugin.automation.core.Action>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, Comparable<AutomationActionModuleDescriptor>
public class AutomationActionModuleDescriptor extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.plugin.automation.core.Action> implements Comparable<AutomationActionModuleDescriptor>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PROJECT_SAFE_PARAM
     

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

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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(AutomationActionModuleDescriptor otherDescriptor)
     
    com.atlassian.plugin.automation.core.Action
    getModule()
     
    boolean
    isProjectSafe()
    This allows this rule component to be added in project specific rules in the project admin section Pluggable components should only allow this if the rule component is safe to be used by project administrators and cannot be used by them to escalate their permissions.
    protected void
    validate(com.atlassian.plugin.module.Element element)
     

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

    assertModuleClassImplements, checkPermissions, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, init, 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

  • Field Details

  • Constructor Details

    • AutomationActionModuleDescriptor

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

  • Method Details

    • validate

      protected void validate(com.atlassian.plugin.module.Element element)
      Overrides:
      validate in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.plugin.automation.core.Action>

    • getModule

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

    • compareTo

      public int compareTo(AutomationActionModuleDescriptor otherDescriptor)
      Specified by:
      compareTo in interface Comparable<AutomationActionModuleDescriptor>

    • isProjectSafe

      public boolean isProjectSafe()
      This allows this rule component to be added in project specific rules in the project admin section Pluggable components should only allow this if the rule component is safe to be used by project administrators and cannot be used by them to escalate their permissions. This generally means:
      • Don't use velocity rendering (velocity allows access to any underlying objects and methods which could be used to get around permission checks)
      • Perform appropriate permission checks in your server-side validation if your rule action can perform actions that now all users should be able to do.

      Return false by default.

      Returns:
      true if this module can show up in project admin