Package com.atlassian.bamboo.task

Interface TaskModuleDescriptor

All Superinterfaces:
com.atlassian.plugin.ModuleDescriptor<InternalTaskType>, NameProvider, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware
All Known Implementing Classes:
TaskModuleDescriptorImpl
public interface TaskModuleDescriptor extends com.atlassian.plugin.ModuleDescriptor<InternalTaskType>, NameProvider
Note that this should not be directly used by plugin developers.
Since:
3.1

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable 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.
    default @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()
     
    @Nullable TaskDefinitionExporter
    getTaskExporter()
    Retrieves the plugin class responsible for exporting of user configuration of this plugin.

    Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

    destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, 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

  • Method Details

    • getTaskConfigurator

      @Nullable @Nullable TaskConfigurator getTaskConfigurator()
      Retrieves the plugin class responsible fo handling user configuration of this plugin.
      Returns:
      TaskConfigurator for this TaskType

    • getRuntimeTaskDataProvider

      @Nullable @Nullable RuntimeTaskDataProvider getRuntimeTaskDataProvider()
      Optional server side component allowing inject runtime parameters for task
      Returns:

    • getTaskBackgroundProcessor

      @Nullable @Nullable TaskBackgroundProcessor getTaskBackgroundProcessor()
      Optional agent side components allowing additional processing happening before and after the build.
      Returns:

    • getCapabilityDefaultsHelper

      @Nullable @Nullable CapabilityDefaultsHelper getCapabilityDefaultsHelper()
      Retrieves the instance responsible for detecting the default Capabilitys of this plugin
      Returns:
      CapabilityDefaultsHelper for this TaskType

    • getCategories

      @NotNull @NotNull List<TaskCategory> getCategories()
      Returns:
      a list of TaskCategorys that this module belongs to

    • getTaskExecutables

      @NotNull @NotNull List<TaskExecutableType> getTaskExecutables()
      Returns:
      details for TaskType executable

    • getIconUrl

      @Nullable @Nullable String getIconUrl()
      URL to the icon to be used in the Task browser
      Returns:
      url to the resource named 'icon' with the type 'download'
      Since:
      3.3

    • getIcon2xUrl

      @Nullable default @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.
      Returns:
      url to the resource named 'icon@2x' with the type 'download'
      Since:
      6.7

    • getHelpLink

      @Nullable @Nullable TaskHelpLink getHelpLink()
      TaskHelpLink objects contain the i18n keys which can be used to find help urls for tasks and their corresponding titles.
      Returns:
      TaskHelpLink object
      Since:
      5.2

    • getTaskExporter

      @Nullable @Nullable TaskDefinitionExporter getTaskExporter()
      Retrieves the plugin class responsible for exporting of user configuration of this plugin.
      Returns:
      TaskDefinitionExporter for this ModuleDescriptor
      Since:
      5.14