com.atlassian.bamboo.task

Class TaskConfiguratorHelperImpl

java.lang.Object

com.atlassian.bamboo.task.TaskConfiguratorHelperImpl

All Implemented Interfaces:

TaskConfiguratorHelper

public class TaskConfiguratorHelperImpl
extends Object
implements TaskConfiguratorHelper

Constructor Summary

Constructors

Constructor and Description
TaskConfiguratorHelperImpl(BuildDefinitionManager buildDefinitionManager, EnvironmentService environmentService, com.opensymphony.xwork2.TextProvider textProvider)

Method Summary

Modifier and Type	Method and Description
void	addJdkRequirement(@NotNull Set<Requirement> requirements, @NotNull TaskDefinition taskDefinition, @NotNull String cfgJdkLabel) Add JDK requirement if JDK was defined in task configuration
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
@Nullable Requirement	createRequirementFromConfiguration(@NotNull TaskDefinition taskDefinition, @NotNull String cfgKey) Creates a new Executable requirement if Executable was defined in task configuration
@NotNull Optional<TaskDefinition>	extractTaskDefinition(@NotNull ActionParametersMap params) Get the task definition for the task defined in the parameter map.
@NotNull Optional<TaskDefinition>	getTaskDefinition(@NotNull ActionParametersMap params) Get the task definition for the task defined in the parameter map.
@NotNull List<TaskDefinition>	getTaskDefinitions(ActionParametersMap params) Get all the task definitions for the job or environment defined in the parameter map.
void	populateContextWithConfiguration(@NotNull Map<String,Object> context, @NotNull TaskDefinition taskDefinition, @NotNull Iterable<String> keys) Populate Freemarker context with selected data from task configuration.
void	populateTaskConfigMapWithActionParameters(@NotNull Map<String,String> config, @NotNull ActionParametersMap params, @NotNull Iterable<String> keys) Populate task configuration with selected data from action parameters.
void	validateBuilderLabel(@NotNull ActionParametersMap params, @NotNull ErrorCollection errorCollection) Validate builder definition in action parameters
void	validateJdk(@NotNull ActionParametersMap params, @NotNull ErrorCollection errorCollection) Validate JDK definition in action parameters
void	validateTestResultsFilePattern(@NotNull ActionParametersMap params, @NotNull ErrorCollection errorCollection) Validate test results file pattern in action parameters
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskConfiguratorHelperImpl

public TaskConfiguratorHelperImpl(BuildDefinitionManager buildDefinitionManager,
                                  EnvironmentService environmentService,
                                  com.opensymphony.xwork2.TextProvider textProvider)

Method Detail

populateContextWithConfiguration

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

Description copied from interface: TaskConfiguratorHelper

Populate Freemarker context with selected data from task configuration.

Specified by:

populateContextWithConfiguration in interface TaskConfiguratorHelper

Parameters:

context - Freemarker context

taskDefinition - source of task configuration

keys - keys for which values has to be copied

populateTaskConfigMapWithActionParameters

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

Description copied from interface: TaskConfiguratorHelper

Populate task configuration with selected data from action parameters.

Specified by:

populateTaskConfigMapWithActionParameters in interface TaskConfiguratorHelper

Parameters:

config - task configuration

params - action parameters

keys - keys for which values has to be copied

addJdkRequirement

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

Description copied from interface: TaskConfiguratorHelper

Add JDK requirement if JDK was defined in task configuration

Specified by:

addJdkRequirement in interface TaskConfiguratorHelper

Parameters:

requirements - requirements to be modified

taskDefinition - task definition

cfgJdkLabel - name of configuration key that specifies JDK label

addSystemRequirementFromConfiguration

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

Description copied from interface: TaskConfiguratorHelper

Add Executable requirement if Executable was defined in task configuration

Specified by:

addSystemRequirementFromConfiguration in interface TaskConfiguratorHelper

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
public @Nullable Requirement createRequirementFromConfiguration(@NotNull
                                                                          @NotNull TaskDefinition taskDefinition,
                                                                          @NotNull
                                                                          @NotNull String cfgKey)

Description copied from interface: TaskConfiguratorHelper

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

Specified by:

createRequirementFromConfiguration in interface TaskConfiguratorHelper

Parameters:

taskDefinition - task definition

cfgKey - name of configuration key that specifies the system requirement

validateJdk

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

Description copied from interface: TaskConfiguratorHelper

Validate JDK definition in action parameters

Specified by:

validateJdk in interface TaskConfiguratorHelper

Parameters:

params - action parameters

errorCollection - target for adding validation errors

validateBuilderLabel

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

Description copied from interface: TaskConfiguratorHelper

Validate builder definition in action parameters

Specified by:

validateBuilderLabel in interface TaskConfiguratorHelper

Parameters:

params - action parameters

errorCollection - target for adding validation errors

validateTestResultsFilePattern

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

Description copied from interface: TaskConfiguratorHelper

Validate test results file pattern in action parameters

Specified by:

validateTestResultsFilePattern in interface TaskConfiguratorHelper

Parameters:

params - action parameters

errorCollection - target for adding validation errors

validateTestResultsFilePatternIfCustomPatternSelected

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

Description copied from interface: TaskConfiguratorHelper

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

Specified by:

validateTestResultsFilePatternIfCustomPatternSelected in interface TaskConfiguratorHelper

Parameters:

params - action parameters

errorCollection - target for adding validation errors

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

getTaskDefinition

@NotNull
public @NotNull Optional<TaskDefinition> getTaskDefinition(@NotNull
                                                                    @NotNull ActionParametersMap params)

Description copied from interface: TaskConfiguratorHelper

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

Specified by:

getTaskDefinition in interface TaskConfiguratorHelper

Parameters:

params - The parameter map from the task.

Returns:

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

extractTaskDefinition

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

Description copied from interface: TaskConfiguratorHelper

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

Specified by:

extractTaskDefinition in interface TaskConfiguratorHelper

Parameters:

params - The parameter map from the task.

Returns:

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

getTaskDefinitions

@NotNull
public @NotNull List<TaskDefinition> getTaskDefinitions(ActionParametersMap params)

Description copied from interface: TaskConfiguratorHelper

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

Specified by:

getTaskDefinitions in interface TaskConfiguratorHelper

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.