com.atlassian.bamboo.task.export

Interface TaskDefinitionExporter

All Known Implementing Classes:

AbstractRepositoryAwareTaskExporter, AbstractVcsTaskExporter, AntTaskExporter, ArtifactDownloaderTaskExporter, CleanWorkingDirectoryTaskExporter, CommandTaskExporter, DefaultTaskDefinitionExporter, DumpVariablesTaskExporter, InjectVariablesTaskExporter, JUnitParserTaskExporter, MavenDependenciesProcessorTaskExporter, MavenTaskExporter, ScriptTaskExporter, TestNGParserTaskExporter, TestParserTaskExporter, VcsBranchTaskExporter, VcsCheckoutTaskExporter, VcsCommitTaskExporter, VcsPushTaskExporter, VcsTagTaskExporter, WarningsTaskExporter

public interface TaskDefinitionExporter

Method Summary

Modifier and Type	Method and Description
default com.atlassian.bamboo.specs.api.builders.task.Task	toSpecsEntity(TaskContainer taskContainer, TaskDefinition taskDefinition) Create Bamboo Specs object representing this task.
com.atlassian.bamboo.specs.api.builders.task.Task	toSpecsEntity(TaskDefinition taskDefinition) Create Bamboo Specs object representing this task.
default Map<String,String>	toTaskConfiguration(TaskContainer taskContainer, List<TaskDefinition> precedingTasks, com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties) Converts properties to Bamboo task configuration.
Map<String,String>	toTaskConfiguration(TaskContainer taskContainer, com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties) Converts properties to Bamboo task configuration.
List<com.atlassian.bamboo.specs.api.validators.common.ValidationProblem>	validate(TaskValidationContext taskValidationContext, com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties) Validates task properties in context of enclosing plan or deployment properties.

Method Detail

toTaskConfiguration

@NotNull
Map<String,String> toTaskConfiguration(@NotNull
                                                TaskContainer taskContainer,
                                                @NotNull
                                                com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties)

Converts properties to Bamboo task configuration. Can use all Bamboo server side services and can access DB if necessary. Should throw a runtime exception if conversion fails.

Parameters:

taskContainer - current task container (a job or an environment for instance)

taskProperties - the current task

Returns:

task configuration

toTaskConfiguration

@NotNull
default Map<String,String> toTaskConfiguration(@NotNull
                                                        TaskContainer taskContainer,
                                                        @NotNull
                                                        List<TaskDefinition> precedingTasks,
                                                        @NotNull
                                                        com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties)

Converts properties to Bamboo task configuration. Can use all Bamboo server side services and can access DB if necessary. Should throw a runtime exception if conversion fails.

Parameters:

taskContainer - current task container (a job or an environment for instance)

precedingTasks - list of tasks declared before the current one

taskProperties - the current task

Returns:

task configuration

Since:

6.1.0

toSpecsEntity

@NotNull
com.atlassian.bamboo.specs.api.builders.task.Task toSpecsEntity(@NotNull
                                                                         TaskDefinition taskDefinition)

Create Bamboo Specs object representing this task. Implementors don't need to handle common task properties like e.g. enabled/disabled, but must task specific configuration.

toSpecsEntity

@NotNull
default com.atlassian.bamboo.specs.api.builders.task.Task toSpecsEntity(@NotNull
                                                                                 TaskContainer taskContainer,
                                                                                 @NotNull
                                                                                 TaskDefinition taskDefinition)

Create Bamboo Specs object representing this task. Implementors don't need to handle common task properties like e.g. enabled/disabled, but must task specific configuration.

Since:

6.1

validate

@NotNull
List<com.atlassian.bamboo.specs.api.validators.common.ValidationProblem> validate(@NotNull
                                                                                           TaskValidationContext taskValidationContext,
                                                                                           @NotNull
                                                                                           com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties)

Validates task properties in context of enclosing plan or deployment properties. Should check for any inconsistencies between task definition and the rest of plan or deployment content, as it is provided in the validation context. Returns list of validation errors or empty if everything is ok. Should check RSS permissions if necessary.