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

Modifier and Type	Field and Description
static String	LICENSE_MESSAGE_ERROR
static String	LICENSE_MESSAGE_INFO

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

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

Constructor Summary

Constructors

Constructor and Description

FooterModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, JiraLicenseService jiraLicenseService, BuildUtilsInfo buildUtilsInfo, com.atlassian.plugin.module.ModuleFactory moduleFactory, GlobalPermissionManager permissionManager, ApplicationProperties applicationProperties, ClusterManager clusterManager, JiraLicenseManager licenseManager, ApplicationRoleManager applicationRoleManager)

Method Summary

Modifier and Type	Method and Description
protected Map<String,?>	createVelocityParams(javax.servlet.http.HttpServletRequest request, Map<String,?> startingParams)
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, 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, writeHtml

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

assertModuleClassImplements, checkPermissions, destroy, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isEnabled, 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, writeHtml

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

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

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Field Detail

LICENSE_MESSAGE_INFO

public static final String LICENSE_MESSAGE_INFO

See Also:

Constant Field Values

LICENSE_MESSAGE_ERROR

public static final String LICENSE_MESSAGE_ERROR

See Also:

Constant Field Values

Constructor Detail

FooterModuleDescriptorImpl

public FooterModuleDescriptorImpl(JiraAuthenticationContext authenticationContext,
                                  JiraLicenseService jiraLicenseService,
                                  BuildUtilsInfo buildUtilsInfo,
                                  com.atlassian.plugin.module.ModuleFactory moduleFactory,
                                  GlobalPermissionManager permissionManager,
                                  ApplicationProperties applicationProperties,
                                  ClusterManager clusterManager,
                                  JiraLicenseManager licenseManager,
                                  ApplicationRoleManager applicationRoleManager)

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

createVelocityParams

protected Map<String,?> createVelocityParams(javax.servlet.http.HttpServletRequest request,
                                             Map<String,?> startingParams)