Package com.atlassian.jira.plugin.navigation

Class FooterModuleDescriptorImpl

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<PluggableFooter>
com.atlassian.jira.plugin.navigation.FooterModuleDescriptorImpl
All Implemented Interfaces:
JiraResourcedModuleDescriptor<PluggableFooter>, FooterModuleDescriptor, OrderableModuleDescriptor, com.atlassian.plugin.ModuleDescriptor<PluggableFooter>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
@ParametersAreNonnullByDefault public class FooterModuleDescriptorImpl extends AbstractJiraModuleDescriptor<PluggableFooter> implements FooterModuleDescriptor
Module descriptor for footer modules.
Since:
v3.12

  • Field Summary

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

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    FooterModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    enabled()
     
    String
    getFooterHtml(javax.servlet.http.HttpServletRequest request, Map<String,?> startingParams)
    This method will setup the params related to the license information and render the html for the footer.
    int
    getOrder()
     
    void
    init(com.atlassian.plugin.Plugin plugin, com.atlassian.plugin.module.Element element)
     

    Methods inherited from class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor

    assertResourceExists, createModule, createVelocityParams, disabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, getName, getText, getText, isResourceExist, writeHtml

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

    assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, 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.jira.plugin.JiraResourcedModuleDescriptor

    getHtml, getHtml, getI18nBean, writeHtml

    Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

    destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

    Methods inherited from interface com.atlassian.plugin.Resourced

    getResourceDescriptor, getResourceDescriptors, getResourceLocation

    Methods inherited from interface com.atlassian.plugin.ScopeAware

    getScopeKey

  • Constructor Details

    • FooterModuleDescriptorImpl

      public FooterModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)

  • Method Details

    • init

      public void init(com.atlassian.plugin.Plugin plugin, com.atlassian.plugin.module.Element element) throws com.atlassian.plugin.PluginParseException
      Specified by:
      init in interface com.atlassian.plugin.ModuleDescriptor<PluggableFooter>
      Overrides:
      init in class AbstractJiraModuleDescriptor<PluggableFooter>
      Throws:
      com.atlassian.plugin.PluginParseException

    • enabled

      public void enabled()
      Specified by:
      enabled in interface com.atlassian.plugin.StateAware
      Overrides:
      enabled in class AbstractJiraModuleDescriptor<PluggableFooter>

    • getOrder

      public int getOrder()
      Specified by:
      getOrder in interface OrderableModuleDescriptor

    • getFooterHtml

      public String getFooterHtml(javax.servlet.http.HttpServletRequest request, Map<String,?> startingParams)
      This method will setup the params related to the license information and render the html for the footer.
      Specified by:
      getFooterHtml in interface FooterModuleDescriptor
      Parameters:
      request - the servlet request
      startingParams - any parameters that you want to have available in the context when rendering the footer.
      Returns:
      html representing the footer.