com.atlassian.bamboo.task
Interface TaskConfigurator

All Known Subinterfaces:

RepositoryAwareDeploymentTaskConfigurator, RepositoryAwareTaskConfigurator, TaskTestResultsSupport

All Known Implementing Classes:

AbstractMavenBuildTaskConfigurator, AbstractRepositoryAwareTaskConfigurator, AbstractShellCommandTaskConfigurator, AbstractTaskConfigurator, AntBuildTaskConfigurator, ArtifactDownloaderTaskConfigurator, CommandBuildTaskConfigurator, GrailsTaskConfigurator, InjectVariablesTaskConfigurator, Maven1BuildTaskConfigurator, Maven2BuildTaskConfigurator, Maven3BuildTaskConfigurator, MavenDependenciesProcessorTaskConfigurator, PhpUnitBuildTaskConfigurator, ScriptBuildTaskConfigurator, TestNGTestResultsParserTaskConfigurator, TestResultsParserTaskConfigurator, VcsBranchingTaskConfigurator, VcsCheckoutTaskConfigurator, VcsTaggingTaskConfigurator

@PublicApi
public interface TaskConfigurator

Implement this class if you want the user to be able to configure your task.

Since:

3.1

See Also:

TaskDefinition

Method Summary

Map<String,String>	generateTaskConfigMap(ActionParametersMap params, TaskDefinition previousTaskDefinition) Convert the params from the ui into a config map to be stored in the database for the taskDefinition.
void	populateContextForCreate(Map<String,Object> context) Provide any required context to be used when rendering the freemarker template for creating a task definition.
void	populateContextForEdit(Map<String,Object> context, TaskDefinition taskDefinition) Provide any required context to be used when rendering the freemarker template for view editing a task definition
void	populateContextForView(Map<String,Object> context, TaskDefinition taskDefinition) Provide any required context to be used when rendering the freemarker template for viewing a task definition
void	validate(ActionParametersMap params, ErrorCollection errorCollection) Validate the params submitted from the UI for this task definition

Method Detail

populateContextForView

void populateContextForView(@NotNull
                            Map<String,Object> context,
                            @NotNull
                            TaskDefinition taskDefinition)

Provide any required context to be used when rendering the freemarker template for viewing a task definition

Parameters:

context - map to put your context in.

taskDefinition - existing task definition

populateContextForEdit

void populateContextForEdit(@NotNull
                            Map<String,Object> context,
                            @NotNull
                            TaskDefinition taskDefinition)

Provide any required context to be used when rendering the freemarker template for view editing a task definition

Parameters:

context - map to put your context in.

taskDefinition - existing task definition

populateContextForCreate

void populateContextForCreate(@NotNull
                              Map<String,Object> context)

Provide any required context to be used when rendering the freemarker template for creating a task definition. Allows you to add any default values for initial creation

Parameters:

context - map to put your context in.

validate

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

Validate the params submitted from the UI for this task definition

Parameters:

params - - request paramaters

errorCollection - - collection to put any errors in.

generateTaskConfigMap

@NotNull
Map<String,String> generateTaskConfigMap(@NotNull
                                                 ActionParametersMap params,
                                                 @Nullable
                                                 TaskDefinition previousTaskDefinition)

Convert the params from the ui into a config map to be stored in the database for the taskDefinition. Can assume validation has occured in the #validate method

Parameters:

params - - request paramaters

previousTaskDefinition - - the previous immutable TaskDefinition before saving or null if Task is being created

Returns:

the configuration map to be stored in the database