com.atlassian.application.host.plugin

Class DefaultApplicationMetaDataModuleDescriptor

java.lang.Object

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

com.atlassian.application.host.plugin.DefaultApplicationMetaDataModuleDescriptor

All Implemented Interfaces:

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

public final class DefaultApplicationMetaDataModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<PluginApplicationMetaData>
implements ApplicationMetaDataModuleDescriptor

A plugin point to define PluginApplicationMetaData. For example:

 
  <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>
      <productHelpServerSpaceURI>help-space-010</productHelpServerSpaceURI>
      <productHelpCloudSpaceURI>HELPCLOUDSPACE</productHelpCloudSpaceURI>
      <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>
  </application>
 
 

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

Since:

v1.0

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
DefaultApplicationMetaDataModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory) Create a new module descriptor.

Method Summary

Modifier and Type	Method and Description
ApplicationKey	getApplicationKey() Returns the ApplicationKey this module defines.
PluginApplicationMetaData	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

DefaultApplicationMetaDataModuleDescriptor

public DefaultApplicationMetaDataModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Create a new module descriptor.

Parameters:

moduleFactory - the factory used to create modules. Not used in this class.

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

Overrides:

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

Throws:

com.atlassian.plugin.PluginParseException

getModule

public PluginApplicationMetaData getModule()

Specified by:

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

Specified by:

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

getApplicationKey

public ApplicationKey getApplicationKey()

Description copied from interface: ApplicationMetaDataModuleDescriptor

Returns the ApplicationKey this module defines.

Specified by:

getApplicationKey in interface ApplicationMetaDataModuleDescriptor

Returns:

the ApplicationKey this module defines.