com.atlassian.jira.plugin
Class ConfigurableModuleDescriptor<T>

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor<T>
          com.atlassian.jira.plugin.ConfigurableModuleDescriptor<T>

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<T>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

Direct Known Subclasses:

PortletModuleDescriptor, ReportModuleDescriptor, RpcModuleDescriptor

public abstract class ConfigurableModuleDescriptor<T>
extends JiraResourcedModuleDescriptor<T>

A JiraResourcedModuleDescriptor that is able to be configured using an ObjectConfiguration.

Field Summary

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

RESOURCE_TYPE_I18N

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

moduleClassName, plugin, resources, singleton

Constructor Summary

ConfigurableModuleDescriptor(JiraAuthenticationContext authenticationContext)

Method Summary

void	disabled()
void	enabled()
ObjectConfiguration	getObjectConfiguration(Map params)
protected ObjectDescriptor	getObjectDescriptor()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

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

assertResourceExists, createModule, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getI18nLocations, getModule, 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, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurableModuleDescriptor

public ConfigurableModuleDescriptor(JiraAuthenticationContext authenticationContext)

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

Overrides:

init in class JiraResourcedModuleDescriptor<T>

Throws:

com.atlassian.plugin.PluginParseException

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class JiraResourcedModuleDescriptor<T>

getObjectDescriptor

protected ObjectDescriptor getObjectDescriptor()

getObjectConfiguration

public ObjectConfiguration getObjectConfiguration(Map params)
                                           throws ObjectConfigurationException

Throws:

ObjectConfigurationException