com.atlassian.jira.plugin.navigation
Class FooterModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
          com.atlassian.jira.plugin.navigation.FooterModuleDescriptor

All Implemented Interfaces:

OrderableModuleDescriptor, com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced

public class FooterModuleDescriptor
extends JiraResourcedModuleDescriptor
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

plugin, resources, singleton

Constructor Summary

FooterModuleDescriptor(JiraAuthenticationContext authenticationContext, ApplicationProperties applicationProperties)

Method Summary

protected Map	createVelocityParams(javax.servlet.http.HttpServletRequest request, Map startingParams)
String	getFooterHtml(javax.servlet.http.HttpServletRequest request, Map startingParams) This method will setup the params related to the license information and render the html for the footer.
Object	getModule()
int	getOrder()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

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

assertResourceExists, createVelocityParams, getAuthenticationContext, getDescription, getHtml, getHtml, getI18nBean, getI18nLocations, 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, 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,
                              ApplicationProperties applicationProperties)

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

Overrides:

init in class JiraResourcedModuleDescriptor

Throws:

com.atlassian.plugin.PluginParseException

getModule

public Object getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

getOrder

public int getOrder()

Specified by:

getOrder in interface OrderableModuleDescriptor

getFooterHtml

public String getFooterHtml(javax.servlet.http.HttpServletRequest request,
                            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 Map createVelocityParams(javax.servlet.http.HttpServletRequest request,
                                   Map startingParams)