com.atlassian.jira.plugin.navigation
Class FooterModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor<PluggableFooter>
          com.atlassian.jira.plugin.navigation.FooterModuleDescriptor

All Implemented Interfaces:

OrderableModuleDescriptor, com.atlassian.plugin.ModuleDescriptor<PluggableFooter>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class FooterModuleDescriptor
extends JiraResourcedModuleDescriptor<PluggableFooter>
implements OrderableModuleDescriptor

Module descriptor for footer modules.

Since:

v3.12

Field Summary

Fields inherited from class com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

RESOURCE_TYPE_I18N

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

moduleClassName, plugin, resources, singleton

Constructor Summary

FooterModuleDescriptor(JiraAuthenticationContext authenticationContext, JiraLicenseService jiraLicenseService, BuildUtilsInfo buildUtilsInfo, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

protected java.util.Map	createVelocityParams(javax.servlet.http.HttpServletRequest request, java.util.Map startingParams)
void	enabled()
java.lang.String	getFooterHtml(javax.servlet.http.HttpServletRequest request, java.util.Map 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, org.dom4j.Element element)

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

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

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

assertModuleClassImplements, destroy, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FooterModuleDescriptor

public FooterModuleDescriptor(JiraAuthenticationContext authenticationContext,
                              JiraLicenseService jiraLicenseService,
                              BuildUtilsInfo buildUtilsInfo,
                              com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<PluggableFooter>

Overrides:

init in class JiraResourcedModuleDescriptor<PluggableFooter>

Throws:

com.atlassian.plugin.PluginParseException

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<PluggableFooter>

getOrder

public int getOrder()

Specified by:

getOrder in interface OrderableModuleDescriptor

getFooterHtml

public java.lang.String getFooterHtml(javax.servlet.http.HttpServletRequest request,
                                      java.util.Map startingParams)

This method will setup the params related to the license information and render the html for the footer.

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.

createVelocityParams

protected java.util.Map createVelocityParams(javax.servlet.http.HttpServletRequest request,
                                             java.util.Map startingParams)