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.StateAware

public class FooterModuleDescriptorImpl
extends AbstractJiraModuleDescriptor<PluggableFooter>
implements FooterModuleDescriptor

Module descriptor for footer modules.

Since:

v3.12

Field Summary

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

RESOURCE_TYPE_I18N

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

moduleClass, moduleClassName, plugin, resources, singleton

Constructor Summary

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

Method Summary

protected Map	createVelocityParams(javax.servlet.http.HttpServletRequest request, Map startingParams)
void	enabled()
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.
int	getOrder()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.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

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

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

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

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

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

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Constructor Detail

FooterModuleDescriptorImpl

public FooterModuleDescriptorImpl(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 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 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.

createVelocityParams

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