Class XmlPluginAllowlistModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<XmlPluginAllowlistProvider>
com.atlassian.jira.security.serialization.XmlPluginAllowlistModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<XmlPluginAllowlistProvider>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class XmlPluginAllowlistModuleDescriptor extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<XmlPluginAllowlistProvider>
Allows extension of the allowlist for xml -> java object deserialization. In atlassian-plugin.xml file, it should look like this: <xml-plugin-allowlist key="myModuleKey" class="com.my.company.MyXmlPluginAllowlistProvider"/> 'key' should be a unique string. 'class' should provide an implementation of com.atlassian.jira.security.serialization.XmlPluginAllowlistProvider.
Since:
9.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     

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

    key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources
  • Constructor Summary

    Constructors
    Constructor
    Description
    XmlPluginAllowlistModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
     
    void
    init(com.atlassian.plugin.Plugin plugin, com.atlassian.plugin.module.Element element)
     

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

    assertModuleClassImplements, checkPermissions, destroy, disabled, 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
  • Field Details

  • Constructor Details

    • XmlPluginAllowlistModuleDescriptor

      public XmlPluginAllowlistModuleDescriptor(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)
      Specified by:
      init in interface com.atlassian.plugin.ModuleDescriptor<XmlPluginAllowlistProvider>
      Overrides:
      init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<XmlPluginAllowlistProvider>
    • enabled

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

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