Package com.atlassian.bamboo.task
Interface TaskConfigurator
- All Known Subinterfaces:
RepositoryAwareDeploymentTaskConfigurator
,RepositoryAwareTaskConfigurator
,TaskTestResultsSupport
- All Known Implementing Classes:
AbstractMavenBuildTaskConfigurator
,AbstractRepositoryAwareTaskConfigurator
,AbstractShellCommandTaskConfigurator
,AbstractTaskConfigurator
,AbstractVcsTaskConfigurator
,AntBuildTaskConfigurator
,ArtifactDownloaderTaskConfigurator
,CommandBuildTaskConfigurator
,GrailsTaskConfigurator
,InjectVariablesTaskConfigurator
,Maven1BuildTaskConfigurator
,Maven2BuildTaskConfigurator
,Maven3BuildTaskConfigurator
,MavenDependenciesProcessorTaskConfigurator
,PhpUnitBuildTaskConfigurator
,ScriptBuildTaskConfigurator
,TestNGTestResultsParserTaskConfigurator
,TestResultGeneratorTaskConfigurator
,TestResultsParserTaskConfigurator
,VcsBranchTaskConfigurator
,VcsCheckoutTaskConfigurator
,VcsCommitTaskConfigurator
,VcsPushTaskConfigurator
,VcsTagTaskConfigurator
,WarningsTaskConfigurator
@PublicApi
public interface TaskConfigurator
Implement this class if you want the user to be able to configure your task.
- Since:
- 3.1
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongenerateTaskConfigMap
(@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.void
populateContextForCreate
(@NotNull Map<String, Object> context) Provide any required context to be used when rendering the freemarker template for creating a task definition.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 definitionvoid
validate
(@NotNull ActionParametersMap params, @NotNull ErrorCollection errorCollection) Validate the params submitted from the UI for this task definition
-
Method Details
-
populateContextForEdit
void populateContextForEdit(@NotNull @NotNull Map<String, Object> context, @NotNull @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
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 @NotNull ActionParametersMap params, @NotNull @NotNull ErrorCollection errorCollection) Validate the params submitted from the UI for this task definition- Parameters:
params
- - request paramaterserrorCollection
- - collection to put any errors in.
-
generateTaskConfigMap
@NotNull @NotNull Map<String,String> generateTaskConfigMap(@NotNull @NotNull ActionParametersMap params, @Nullable @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 occurred in the #validate method- Parameters:
params
- - request paramaterspreviousTaskDefinition
- - the previous immutableTaskDefinition
before saving or null if Task is being created- Returns:
- the configuration map to be stored in the database
-