com.atlassian.bamboo.task
Interface TaskConfiguratorHelper

All Known Implementing Classes:

TaskConfiguratorHelperImpl

public interface TaskConfiguratorHelper

Bucket of TaskConfigurator helper methods

Method Summary

void	addJdkRequirement(java.util.Set<Requirement> requirements, TaskDefinition taskDefinition, java.lang.String cfgJdkLabel) Add JDK requirement if JDK was defined in task configuration
void	addSystemRequirementFromConfiguration(java.util.Set<Requirement> requirements, TaskDefinition taskDefinition, java.lang.String cfgKey, java.lang.String requirementPrefix) Add Executable requirement if Executable was defined in task configuration
void	populateContextWithConfiguration(java.util.Map<java.lang.String,java.lang.Object> context, TaskDefinition taskDefinition, java.lang.Iterable<java.lang.String> keys) Populate Freemarker context with selected data from task configuration.
void	populateTaskConfigMapWithActionParameters(java.util.Map<java.lang.String,java.lang.String> config, ActionParametersMap params, java.lang.Iterable<java.lang.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, java.lang.String cfgTestResultsFilePatternOptionCustom) Validate test results file pattern in action parameters when manual pattern is enabled by an option

Method Detail

populateContextWithConfiguration

void populateContextWithConfiguration(@NotNull
                                      java.util.Map<java.lang.String,java.lang.Object> context,
                                      @NotNull
                                      TaskDefinition taskDefinition,
                                      @NotNull
                                      java.lang.Iterable<java.lang.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
                                               java.util.Map<java.lang.String,java.lang.String> config,
                                               @NotNull
                                               ActionParametersMap params,
                                               @NotNull
                                               java.lang.Iterable<java.lang.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
                       java.util.Set<Requirement> requirements,
                       @NotNull
                       TaskDefinition taskDefinition,
                       @NotNull
                       java.lang.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
                                           java.util.Set<Requirement> requirements,
                                           @NotNull
                                           TaskDefinition taskDefinition,
                                           @NotNull
                                           java.lang.String cfgKey,
                                           @NotNull
                                           java.lang.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

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
                                                           java.lang.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