com.atlassian.bamboo.task

Interface TaskManager

All Known Implementing Classes:

TaskManagerImpl

@PublicApi
public interface TaskManager

Since:

3.1

Method Summary

Modifier and Type	Method and Description
void	calculateRequirementsForTaskDefinition(Job job, TaskDefinition taskDefinition) Attempts to add Requirements to the specified Buildable if the TaskConfigurator is an implementor of BuildTaskRequirementSupport If requirements are already present for the specified TaskDefinition they will be removed and recalculated
void	calculateRequirementsForTaskDefinition(RequirementSet requirementSet, TaskDefinition taskDefinition, Supplier<Set<Requirement>> requirementSupplier) Deprecated. since 6.4 use calculateRequirementsForTaskDefinition(RequirementSet, TaskDefinition, Supplier, boolean) instead
void	calculateRequirementsForTaskDefinition(RequirementSet requirementSet, TaskDefinition taskDefinition, Supplier<Set<Requirement>> requirementSupplier, boolean dockerPipelinesEnabled) Attempts to add Requirements to the specified RequirementSet.
List<TaskModuleDescriptor>	getAvailableBuildTaskDescriptors()
List<TaskModuleDescriptor>	getAvailableDeploymentTaskDescriptors()
List<TaskModuleDescriptor>	getAvailableTaskDescriptors()
Set<String>	getCapabilitiesWithExecutables(Set<String> executableType) Returns a set of capabilities that have executable types defined for them in the system.
Map<String,String>	getExecutableLabelTypeMap() Returns a map of currently available "configured" executables - uniquely identified by a label.
TaskModuleDescriptor	getTaskDescriptor(String pluginKey) Get the task type descriptor matching a particular plugin key.
Collection<Requirement>	getTasksRequirements(Job job) Return Requirements for all tasks of Buildable if the TaskConfigurator is an implementor of BuildTaskRequirementSupport
void	recalculateRequirementsForJob(Job job, boolean dockerPipelinesEnabled) Recalculates requirements for job with given docker pipelines flag.
void	removeRequirementsForTaskDefinition(Buildable buildable, TaskDefinition taskDefinition) Removes all the Requirements that belong to the TaskDefinition
void	removeRequirementsForTaskDefinition(RequirementSet requirementSet, TaskDefinition taskDefinition) Removes all the Requirements that belong to the TaskDefinition
boolean	taskProducesTestResults(TaskDefinition taskDefinition) Return true iff task defined in TaskDefinition is configured to produce test results.
void	updateRepositoryIdsInTask(TaskDefinition taskDefinition, Map<Long,Long> repositoryIdChanges) Updates task configurations affected by repository edition.
void	updateWorkingDirSelectors(ImmutableBuildable job, BuildDefinition buildDefinition, Map<Long,Long> repositoryIdsChanges) Calculates id of the repository that defines working directory after repository or task edition.

Method Detail

getAvailableTaskDescriptors

@NotNull
List<TaskModuleDescriptor> getAvailableTaskDescriptors()

Returns:

Provides a list of available tasks types. Returns both Build Tasks and DeploymentTasks

getAvailableBuildTaskDescriptors

@NotNull
List<TaskModuleDescriptor> getAvailableBuildTaskDescriptors()

Returns:

Provides a list of available build task types.

Since:

5.0

getAvailableDeploymentTaskDescriptors

@NotNull
List<TaskModuleDescriptor> getAvailableDeploymentTaskDescriptors()

Returns:

Provides a list of available deployment task types.

Since:

5.0

getTaskDescriptor

@Nullable
TaskModuleDescriptor getTaskDescriptor(@Nullable
                                                 String pluginKey)

Get the task type descriptor matching a particular plugin key.

Parameters:

pluginKey - - key to match

Returns:

TaskModuleDescriptor matching the given key if it exists. Null if the plugin can not be found.

calculateRequirementsForTaskDefinition

void calculateRequirementsForTaskDefinition(@NotNull
                                            Job job,
                                            @NotNull
                                            TaskDefinition taskDefinition)

Attempts to add Requirements to the specified Buildable if the TaskConfigurator is an implementor of BuildTaskRequirementSupport If requirements are already present for the specified TaskDefinition they will be removed and recalculated

Parameters:

job -

taskDefinition -

calculateRequirementsForTaskDefinition

@Deprecated
void calculateRequirementsForTaskDefinition(@NotNull
                                                        RequirementSet requirementSet,
                                                        @NotNull
                                                        TaskDefinition taskDefinition,
                                                        Supplier<Set<Requirement>> requirementSupplier)

Deprecated. since 6.4 use calculateRequirementsForTaskDefinition(RequirementSet, TaskDefinition, Supplier, boolean) instead

Attempts to add Requirements to the specified RequirementSet. How to get the requirements from the task Definition is determined by the supplier. If requirements are already present for the specified TaskDefinition they will be removed and recalculated

Parameters:

requirementSet - to add requirements update requirements in

taskDefinition - to calculate requirements from

calculateRequirementsForTaskDefinition

void calculateRequirementsForTaskDefinition(@NotNull
                                            RequirementSet requirementSet,
                                            @NotNull
                                            TaskDefinition taskDefinition,
                                            Supplier<Set<Requirement>> requirementSupplier,
                                            boolean dockerPipelinesEnabled)

Attempts to add Requirements to the specified RequirementSet. How to get the requirements from the task Definition is determined by the supplier. If requirements are already present for the specified TaskDefinition they will be removed and recalculated. If docker pipelines is enabled than requirements from requirementSupplier won't be added to RequirementSet, instead of this docker requirement will be added.

Parameters:

requirementSet - to add requirements update requirements in

taskDefinition - to calculate requirements from

dockerPipelinesEnabled - flag for docker pipelines

removeRequirementsForTaskDefinition

void removeRequirementsForTaskDefinition(@NotNull
                                         Buildable buildable,
                                         @NotNull
                                         TaskDefinition taskDefinition)

Removes all the Requirements that belong to the TaskDefinition

Parameters:

buildable - to remove requirements from

taskDefinition - that was removed

removeRequirementsForTaskDefinition

void removeRequirementsForTaskDefinition(@NotNull
                                         RequirementSet requirementSet,
                                         @NotNull
                                         TaskDefinition taskDefinition)

Removes all the Requirements that belong to the TaskDefinition

Parameters:

requirementSet - to remove requirements from

taskDefinition - that was removed

getTasksRequirements

@NotNull
Collection<Requirement> getTasksRequirements(@NotNull
                                                      Job job)

Return Requirements for all tasks of Buildable if the TaskConfigurator is an implementor of BuildTaskRequirementSupport

Parameters:

job@throws - IllegalStateException

Returns:

requirements

taskProducesTestResults

boolean taskProducesTestResults(@NotNull
                                TaskDefinition taskDefinition)

Return true iff task defined in TaskDefinition is configured to produce test results.

Parameters:

taskDefinition -

Returns:

producesTestResults

getExecutableLabelTypeMap

Map<String,String> getExecutableLabelTypeMap()

Returns a map of currently available "configured" executables - uniquely identified by a label.

Maps label -> taskExecutableType.getExecutableKey().

The executables are backed by available capabilities system wide, filtered by executables which are actually activated in the plugin system.

Returns:

executableTypeLabelMaps

updateRepositoryIdsInTask

void updateRepositoryIdsInTask(@NotNull
                               TaskDefinition taskDefinition,
                               @NotNull
                               Map<Long,Long> repositoryIdChanges)

Updates task configurations affected by repository edition.

Parameters:

taskDefinition -

repositoryIdChanges - mapping between old and new repositories ids

Since:

4.3

updateWorkingDirSelectors

void updateWorkingDirSelectors(@NotNull
                               ImmutableBuildable job,
                               @NotNull
                               BuildDefinition buildDefinition,
                               @NotNull
                               Map<Long,Long> repositoryIdsChanges)

Calculates id of the repository that defines working directory after repository or task edition.

Parameters:

job - affected job

buildDefinition -

repositoryIdsChanges - mapping between old and new repositories ids

getCapabilitiesWithExecutables

Set<String> getCapabilitiesWithExecutables(@NotNull
                                           Set<String> executableType)

Returns a set of capabilities that have executable types defined for them in the system.

recalculateRequirementsForJob

void recalculateRequirementsForJob(Job job,
                                   boolean dockerPipelinesEnabled)

Recalculates requirements for job with given docker pipelines flag.

Parameters:

job -

dockerPipelinesEnabled -

Since:

6.4