com.atlassian.jira.plugin.component

Class ComponentModuleDescriptor

java.lang.Object

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

com.atlassian.jira.plugin.component.ComponentModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class ComponentModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

This JIRA-based ComponentModuleDescriptor manages plugins1 components. Plugins2 components live in the framework module descriptor com.atlassian.plugin.osgi.factory.descriptor.ComponentModuleDescriptor.

Plugins 1 components don't have to include an interface, will be put into our PicoContainer, and can replace core JIRA components.

Plugins 2 components have to include an interface because they are managed by the Spring dependency manager, and CANNOT replace core JIRA components.

See Also:

com.atlassian.plugin.osgi.factory.descriptor.ComponentModuleDescriptor

Field Summary

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	disabled()
void	enabled()
Void	getModule()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
void	registerComponent(ComponentContainer componentContainer) Registers this module's component with the given container.
void	registerComponent(ComponentManager componentManager) Registers this module's component with the component manager.
void	unregisterComponent(ComponentManager componentManager) Unregisters this module's component from the ComponentManager.

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

assertModuleClassImplements, checkPermissions, destroy, 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

getDisplayName

Constructor Detail

ComponentModuleDescriptor

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

Method Detail

init

public void init(@Nonnull
                 com.atlassian.plugin.Plugin plugin,
                 @Nonnull
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<Void>

Overrides:

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

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

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

getModule

public Void getModule()

Specified by:

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

Specified by:

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

registerComponent

public void registerComponent(@Nonnull
                              ComponentContainer componentContainer)

Registers this module's component with the given container.

Parameters:

componentContainer - the container

Since:

7.7

registerComponent

public void registerComponent(ComponentManager componentManager)

Registers this module's component with the component manager.

Parameters:

componentManager - the component manager

Since:

7.7

unregisterComponent

public void unregisterComponent(ComponentManager componentManager)

Unregisters this module's component from the ComponentManager.

Parameters:

componentManager - the component manager

Since:

7.7