com.atlassian.bamboo.task

Interface TaskConfiguratorHelper

All Known Implementing Classes:

TaskConfiguratorHelperImpl

@PublicApi
public interface TaskConfiguratorHelper

Bucket of TaskConfigurator helper methods

Method Summary

Modifier and Type	Method and Description
void	addJdkRequirement(Set<Requirement> requirements, TaskDefinition taskDefinition, String cfgJdkLabel) Add JDK requirement if JDK was defined in task configuration
void	addSystemRequirementFromConfiguration(Set<Requirement> requirements, TaskDefinition taskDefinition, String cfgKey, String requirementPrefix) Add Executable requirement if Executable was defined in task configuration
Requirement	createRequirementFromConfiguration(TaskDefinition taskDefinition, String cfgKey) Creates a new Executable requirement if Executable was defined in task configuration
Optional<TaskDefinition>	extractTaskDefinition(ActionParametersMap params) Get the task definition for the task defined in the parameter map.
com.atlassian.fugue.Option<TaskDefinition>	getTaskDefinition(ActionParametersMap params) Deprecated. since 6.2 use extractTaskDefinition(ActionParametersMap)
List<TaskDefinition>	getTaskDefinitions(ActionParametersMap params) Get all the task definitions for the job or environment defined in the parameter map.
void	populateContextWithConfiguration(Map<String,Object> context, TaskDefinition taskDefinition, Iterable<String> keys) Populate Freemarker context with selected data from task configuration.
void	populateTaskConfigMapWithActionParameters(Map<String,String> config, ActionParametersMap params, Iterable<String> keys) Populate task configuration with selected data from action parameters.
void	validateBuilderLabel(ActionParametersMap params, ErrorCollection errorCollection) Validate builder definition in action parameters
void	validateJdk(ActionParametersMap params, ErrorCollection errorCollection) Validate JDK definition in action parameters
void	validateTestResultsFilePattern(ActionParametersMap params, ErrorCollection errorCollection) Validate test results file pattern in action parameters
void	validateTestResultsFilePatternIfCustomPatternSelected(ActionParametersMap params, ErrorCollection errorCollection, String cfgTestResultsFilePatternOptionCustom) Validate test results file pattern in action parameters when manual pattern is enabled by an option

Method Detail

populateContextWithConfiguration

void populateContextWithConfiguration(@NotNull
                                      Map<String,Object> context,
                                      @NotNull
                                      TaskDefinition taskDefinition,
                                      @NotNull
                                      Iterable<String> keys)

Populate Freemarker context with selected data from task configuration.

Parameters:

context - Freemarker context

taskDefinition - source of task configuration

keys - keys for which values has to be copied

populateTaskConfigMapWithActionParameters

void populateTaskConfigMapWithActionParameters(@NotNull
                                               Map<String,String> config,
                                               @NotNull
                                               ActionParametersMap params,
                                               @NotNull
                                               Iterable<String> keys)

Populate task configuration with selected data from action parameters.

Parameters:

config - task configuration

params - action parameters

keys - keys for which values has to be copied

addJdkRequirement

void addJdkRequirement(@NotNull
                       Set<Requirement> requirements,
                       @NotNull
                       TaskDefinition taskDefinition,
                       @NotNull
                       String cfgJdkLabel)

Add JDK requirement if JDK was defined in task configuration

Parameters:

requirements - requirements to be modified

taskDefinition - task definition

cfgJdkLabel - name of configuration key that specifies JDK label

addSystemRequirementFromConfiguration

void addSystemRequirementFromConfiguration(@NotNull
                                           Set<Requirement> requirements,
                                           @NotNull
                                           TaskDefinition taskDefinition,
                                           @NotNull
                                           String cfgKey,
                                           @NotNull
                                           String requirementPrefix)

Add Executable requirement if Executable was defined in task configuration

Parameters:

requirements - requirements to be modified

taskDefinition - task definition

cfgKey - name of configuration key that specifies label of system requirement to be added

requirementPrefix - prefix of the system requirement

createRequirementFromConfiguration

@Nullable
Requirement createRequirementFromConfiguration(@NotNull
                                                         TaskDefinition taskDefinition,
                                                         @NotNull
                                                         String cfgKey)

Creates a new Executable requirement if Executable was defined in task configuration

Parameters:

taskDefinition - task definition

cfgKey - name of configuration key that specifies the system requirement

validateJdk

void validateJdk(@NotNull
                 ActionParametersMap params,
                 @NotNull
                 ErrorCollection errorCollection)

Validate JDK definition in action parameters

Parameters:

params - action parameters

errorCollection - target for adding validation errors

validateBuilderLabel

void validateBuilderLabel(@NotNull
                          ActionParametersMap params,
                          @NotNull
                          ErrorCollection errorCollection)

Validate builder definition in action parameters

Parameters:

params - action parameters

errorCollection - target for adding validation errors

validateTestResultsFilePattern

void validateTestResultsFilePattern(@NotNull
                                    ActionParametersMap params,
                                    @NotNull
                                    ErrorCollection errorCollection)

Validate test results file pattern in action parameters

Parameters:

params - action parameters

errorCollection - target for adding validation errors

validateTestResultsFilePatternIfCustomPatternSelected

void validateTestResultsFilePatternIfCustomPatternSelected(@NotNull
                                                           ActionParametersMap params,
                                                           @NotNull
                                                           ErrorCollection errorCollection,
                                                           @NotNull
                                                           String cfgTestResultsFilePatternOptionCustom)

Validate test results file pattern in action parameters when manual pattern is enabled by an option

Parameters:

params - action parameters

errorCollection - target for adding validation errors

cfgTestResultsFilePatternOptionCustom - value of an option that enables test results file pattern

getTaskDefinition

@Deprecated
 @NotNull
com.atlassian.fugue.Option<TaskDefinition> getTaskDefinition(@NotNull
                                                                                   ActionParametersMap params)

Deprecated. since 6.2 use extractTaskDefinition(ActionParametersMap)

Get the task definition for the task defined in the parameter map. This method works for tasks defined in either build or deployment plans.

Parameters:

params - The parameter map from the task.

Returns:

An Option containing the existing task definition or empty if this is a new task.

Throws:

IllegalArgumentException - if the parameter map does not represent a build or deployment task, or if it represents both a build and deployment plan.

extractTaskDefinition

@NotNull
Optional<TaskDefinition> extractTaskDefinition(@NotNull
                                                        ActionParametersMap params)

Get the task definition for the task defined in the parameter map. This method works for tasks defined in either build or deployment plans.

Parameters:

params - The parameter map from the task.

Returns:

An Option containing the existing task definition or empty if this is a new task.

Throws:

IllegalArgumentException - if the parameter map does not represent a build or deployment task, or if it represents both a build and deployment plan.

getTaskDefinitions

@NotNull
List<TaskDefinition> getTaskDefinitions(ActionParametersMap params)

Get all the task definitions for the job or environment defined in the parameter map.

Parameters:

params - The parameter map from a task in the job or environment.

Returns:

A List of TaskDefinitions for all the tasks in the job or environment.

Throws:

IllegalArgumentException - if the parameter map does not represent a build or deployment task, or if it represents both a build and deployment plan.