com.atlassian.jira.plugin.webwork

Interface AutowireCapableWebworkActionRegistry

All Known Implementing Classes:

DefaultAutowireCapableWebworkActionRegistry

public interface AutowireCapableWebworkActionRegistry

Registry to link all webwork actions defined in plugins2 osgi bundles to their plugin. This is necessary since when the action gets instantiated in the JiraActionFactory it needs to be auto-wired via the plugin.

Since:

v4.0

Method Summary

Modifier and Type	Method and Description
boolean	containsAction(String action) Checks if the registry contains an entry for a particular action.
com.atlassian.plugin.module.ContainerManagedPlugin	getPlugin(String action) Gets the Plugin registered for a particular action.
void	registerAction(String action, com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor) Register the action class (simple class name) to its Plugin.
void	unregisterPluginModule(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor) Unregister all actions for a plugin.

Method Detail

registerAction

void registerAction(String action,
                    com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)

Register the action class (simple class name) to its Plugin.

Parameters:

action - The action class

moduleDescriptor - The plugin module in which the action lives.

unregisterPluginModule

void unregisterPluginModule(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)

Unregister all actions for a plugin. This should be called whenver a webwork module is disabled.

Parameters:

moduleDescriptor - The plugin module which will be unregistered

getPlugin

com.atlassian.plugin.module.ContainerManagedPlugin getPlugin(String action)

Gets the Plugin registered for a particular action. Will return Null if none is registered.

Parameters:

action - The action class being instantiated

Returns:

The Plugin in which the action lives

containsAction

boolean containsAction(String action)

Checks if the registry contains an entry for a particular action.

Parameters:

action - The action class to check for

Returns:

true if a plugin is registered for this action.