com.atlassian.jira.application

Class JiraApplicationMetaDataModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.application.host.plugin.PluginApplicationMetaData>

com.atlassian.jira.application.JiraApplicationMetaDataModuleDescriptor

All Implemented Interfaces:

com.atlassian.application.host.plugin.ApplicationMetaDataModuleDescriptor, com.atlassian.plugin.ModuleDescriptor<com.atlassian.application.host.plugin.PluginApplicationMetaData>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class JiraApplicationMetaDataModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.application.host.plugin.PluginApplicationMetaData>
implements com.atlassian.application.host.plugin.ApplicationMetaDataModuleDescriptor

Parses application XML tags and returns JiraPluginApplicationMetaData. The XML for a JIRA application is the same as any other regular application, except that the definition of project types is allowed:

 
  <application key="completeModule" name="ModuleDescriptorName">
      <applicationKey>com.atlassian.jira.platform</applicationKey>
      <applicationName>Test Product</applicationName>
      <applicationDescriptionKey>some.key</applicationDescriptionKey>
      <configURI>/configureMe</configURI>
      <postInstallURI>/postInstall</postInstallURI>
      <postUpdateURI>/postUpdate/actions.do</postUpdateURI>
      <userCountKey>other.key</userCountKey>
      <applicationPlugins>
          <plugin>one</plugin>
          <plugin>two</plugin>
          <plugin>three</plugin>
      </applicationPlugins>
      <utilityPlugins>
          <plugin>two</plugin>
          <plugin>three</plugin>
          <plugin>four</plugin>
      </utilityPlugins>
      <defaultGroup>jira-testers</defaultGroup>
      <projectTypes>
          <projectType>
              <key>type1</key>
              <descriptionI18nKey>projects.of.first.type</descriptionI18nKey>
              <icon>PD94bWwgdmVyc2l (base64 encoded svg)</icon>
              <color>#FFFFFF</color>
          </projectType>
          <projectType>
              <key>type2</key>
              <descriptionKey>projects.of.second.type</descriptionKey>
              <icon>PD94bWwgdmVyc2l (base64 encoded svg)</icon>
              <color>#FFFFFF</color>
          </projectType>
      <projectTypes/>
  </application>
 
 

The applicationKey, applicationName and applicationDescriptionKey attributes are required. All other attributes are optional.

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
JiraApplicationMetaDataModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
com.atlassian.application.api.ApplicationKey	getApplicationKey()
JiraPluginApplicationMetaData	getModule()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

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

assertModuleClassImplements, checkPermissions, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

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

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Constructor Detail

JiraApplicationMetaDataModuleDescriptor

public JiraApplicationMetaDataModuleDescriptor(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<com.atlassian.application.host.plugin.PluginApplicationMetaData>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.application.host.plugin.PluginApplicationMetaData>

Throws:

com.atlassian.plugin.PluginParseException

getModule

public JiraPluginApplicationMetaData getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<com.atlassian.application.host.plugin.PluginApplicationMetaData>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.application.host.plugin.PluginApplicationMetaData>

getApplicationKey

public com.atlassian.application.api.ApplicationKey getApplicationKey()

Specified by:

getApplicationKey in interface com.atlassian.application.host.plugin.ApplicationMetaDataModuleDescriptor