Package com.atlassian.bamboo.plugin.descriptor

Class TaskModuleDescriptorImpl

java.lang.Object

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

com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor<InternalTaskType>

com.atlassian.bamboo.plugin.descriptor.TaskModuleDescriptorImpl

All Implemented Interfaces:

TaskModuleDescriptor, NameProvider, com.atlassian.plugin.ModuleDescriptor<InternalTaskType>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, Serializable

public final class TaskModuleDescriptorImpl
extends AbstractBambooModuleDescriptor<InternalTaskType>
implements TaskModuleDescriptor, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor

AbstractBambooModuleDescriptor.ClassNameSource, AbstractBambooModuleDescriptor.ModuleAvailability

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PLUGIN_TYPE

Fields inherited from class com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor

CLASS

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

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

Constructor Summary

Constructors

Constructor	Description
TaskModuleDescriptorImpl(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method	Description
void	disabled()
CapabilityDefaultsHelper	getCapabilityDefaultsHelper()	Retrieves the instance responsible for detecting the default Capabilitys of this plugin
@NotNull List<TaskCategory>	getCategories()
@Nullable TaskHelpLink	getHelpLink()	TaskHelpLink objects contain the i18n keys which can be used to find help urls for tasks and their corresponding titles.
@Nullable String	getIcon2xUrl()	URL to a two-times larger version of the icon to be used in the task browser for screens with high resolution.
@Nullable String	getIconUrl()	URL to the icon to be used in the Task browser
@Nullable RuntimeTaskDataProvider	getRuntimeTaskDataProvider()	Optional server side component allowing inject runtime parameters for task
@Nullable TaskBackgroundProcessor	getTaskBackgroundProcessor()	Optional agent side components allowing additional processing happening before and after the build.
@Nullable TaskConfigurator	getTaskConfigurator()	Retrieves the plugin class responsible fo handling user configuration of this plugin.
@NotNull List<TaskExecutableType>	getTaskExecutables()
@NotNull TaskDefinitionExporter	getTaskExporter()	Retrieves the plugin class responsible for exporting of user configuration of this plugin.
void	init(com.atlassian.plugin.Plugin plugin, com.atlassian.plugin.module.Element element)

Methods inherited from class com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor

getElementAsString, getFreeMarkerResourceLocation, getModule, getVelocityResourceLocation, instantiateClass, instantiateSubmodule, isMutable, postInit, preInit, prepareSubModuleConfiguration, prepareSubModuleConfiguration

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

assertModuleClassImplements, checkPermissions, destroy, 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, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

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, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.bamboo.utils.NameProvider

getName

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Field Details

PLUGIN_TYPE

public static final String PLUGIN_TYPE

See Also:

• Constant Field Values

Constructor Details

TaskModuleDescriptorImpl

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

Method Details

init

public void init(com.atlassian.plugin.Plugin plugin,
 com.atlassian.plugin.module.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

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

Overrides:

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

Throws:

com.atlassian.plugin.PluginParseException

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class AbstractBambooModuleDescriptor<InternalTaskType>

getCapabilityDefaultsHelper

public CapabilityDefaultsHelper getCapabilityDefaultsHelper()

Description copied from interface: TaskModuleDescriptor

Retrieves the instance responsible for detecting the default Capabilitys of this plugin

Specified by:

getCapabilityDefaultsHelper in interface TaskModuleDescriptor

Returns:

CapabilityDefaultsHelper for this TaskType

getTaskConfigurator

@Nullable
public @Nullable TaskConfigurator getTaskConfigurator()

Description copied from interface: TaskModuleDescriptor

Retrieves the plugin class responsible fo handling user configuration of this plugin.

Specified by:

getTaskConfigurator in interface TaskModuleDescriptor

Returns:

TaskConfigurator for this TaskType

getCategories

@NotNull
public @NotNull List<TaskCategory> getCategories()

Specified by:

getCategories in interface TaskModuleDescriptor

Returns:

a list of TaskCategorys that this module belongs to

getTaskExecutables

@NotNull
public @NotNull List<TaskExecutableType> getTaskExecutables()

Specified by:

getTaskExecutables in interface TaskModuleDescriptor

Returns:

details for TaskType executable

getIconUrl

@Nullable
public @Nullable String getIconUrl()

Description copied from interface: TaskModuleDescriptor

URL to the icon to be used in the Task browser

Specified by:

getIconUrl in interface TaskModuleDescriptor

Returns:

url to the resource named 'icon' with the type 'download'

getIcon2xUrl

@Nullable
public @Nullable String getIcon2xUrl()

Description copied from interface: TaskModuleDescriptor

URL to a two-times larger version of the icon to be used in the task browser for screens with high resolution.

Specified by:

getIcon2xUrl in interface TaskModuleDescriptor

Returns:

url to the resource named 'icon@2x' with the type 'download'

getHelpLink

@Nullable
public @Nullable TaskHelpLink getHelpLink()

Description copied from interface: TaskModuleDescriptor

TaskHelpLink objects contain the i18n keys which can be used to find help urls for tasks and their corresponding titles.

Specified by:

getHelpLink in interface TaskModuleDescriptor

Returns:

TaskHelpLink object

getRuntimeTaskDataProvider

@Nullable
public @Nullable RuntimeTaskDataProvider getRuntimeTaskDataProvider()

Description copied from interface: TaskModuleDescriptor

Optional server side component allowing inject runtime parameters for task

Specified by:

getRuntimeTaskDataProvider in interface TaskModuleDescriptor

Returns:

getTaskBackgroundProcessor

@Nullable
public @Nullable TaskBackgroundProcessor getTaskBackgroundProcessor()

Description copied from interface: TaskModuleDescriptor

Optional agent side components allowing additional processing happening before and after the build.

Specified by:

getTaskBackgroundProcessor in interface TaskModuleDescriptor

Returns:

getTaskExporter

@NotNull
public @NotNull TaskDefinitionExporter getTaskExporter()

Description copied from interface: TaskModuleDescriptor

Retrieves the plugin class responsible for exporting of user configuration of this plugin.

Specified by:

getTaskExporter in interface TaskModuleDescriptor

Returns:

TaskDefinitionExporter for this ModuleDescriptor