Package com.atlassian.confluence.plugin.descriptor

Class StrutsModuleDescriptor

  • All Implemented Interfaces:
    com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
    Direct Known Subclasses:
    XWorkModuleDescriptor
    public class StrutsModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor
    A plugin module from which a Struts ConfigurationProvider is constructed, it can provide actions and results to add to Confluence's web UI layer. Actions should extend ConfluenceActionSupport.
    See Also:
    ConfluenceActionSupport, Struts module documentation

    • Field Summary

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

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

    • Constructor Summary

      Constructors 
      Constructor Description
      StrutsModuleDescriptor​(com.atlassian.plugin.module.ModuleFactory moduleFactory, com.atlassian.event.api.EventPublisher eventPublisher, com.opensymphony.xwork2.config.ConfigurationManager configurationManager, MultipartUploadConfigurator multipartUploadConfigurator, OgnlAllowListConfigurator ognlAllowListConfigurator)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void disabled()  
      void enabled()  
      Object getModule()  
      void init​(@NonNull com.atlassian.plugin.Plugin plugin, @NonNull org.dom4j.Element element)  
      static Set<Pattern> parseChildrenPatterns​(org.dom4j.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, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

      • Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

        getDisplayName, init

    • Constructor Detail

      • StrutsModuleDescriptor

        public StrutsModuleDescriptor​(com.atlassian.plugin.module.ModuleFactory moduleFactory,
                              com.atlassian.event.api.EventPublisher eventPublisher,
                              com.opensymphony.xwork2.config.ConfigurationManager configurationManager,
                              MultipartUploadConfigurator multipartUploadConfigurator,
                              OgnlAllowListConfigurator ognlAllowListConfigurator)

    • Method Detail

      • init

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

      • parseChildrenPatterns

        public static Set<Pattern> parseChildrenPatterns​(org.dom4j.Element element)

      • enabled

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

      • disabled

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

      • getModule

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