com.atlassian.bamboo.configuration.external.helpers

Class TaskDefinitionExportHelper

java.lang.Object

com.atlassian.bamboo.configuration.external.helpers.TaskDefinitionExportHelper

public class TaskDefinitionExportHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
TaskDefinitionExportHelper(TaskManager taskManager)

Method Summary

Modifier and Type	Method and Description
@NotNull TaskDefinitionExporter	getExporter(@NotNull String pluginKey)
TaskDefinitionExporter	getExporter(@NotNull com.atlassian.bamboo.specs.api.model.task.TaskProperties properties)
@NotNull TaskDefinition	importTaskDefinition(long id, @NotNull TaskContainer taskContainer, @NotNull List<TaskDefinition> precedingTasks, @NotNull com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties, @Nullable VcsBranch importedBranch, boolean finalTask) Import the task definition from its properties.
@NotNull TaskDefinition	importTaskDefinition(long id, @NotNull TaskContainer taskContainer, @NotNull com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties, boolean finalTask) Import the task definition from its properties.
@NotNull com.atlassian.bamboo.specs.api.builders.task.Task	toSpecsEntity(TaskContainer taskContainer, TaskDefinition taskDefinition)
void	validateTaskProperties(@NotNull com.atlassian.bamboo.specs.api.model.deployment.DeploymentProperties deploymentProperties, @NotNull RssPermissions rssPermissions)
void	validateTaskProperties(@NotNull com.atlassian.bamboo.specs.api.model.plan.PlanProperties topLevelPlanProperties, @NotNull RssPermissions rssPermissions, @Nullable VcsBranch importedBranch)

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskDefinitionExportHelper

@Autowired
public TaskDefinitionExportHelper(TaskManager taskManager)

Method Detail

toSpecsEntity

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

getExporter

public TaskDefinitionExporter getExporter(@NotNull
                                          @NotNull com.atlassian.bamboo.specs.api.model.task.TaskProperties properties)

getExporter

@NotNull
public @NotNull TaskDefinitionExporter getExporter(@NotNull
                                                            @NotNull String pluginKey)

importTaskDefinition

@NotNull
public @NotNull TaskDefinition importTaskDefinition(long id,
                                                             @NotNull
                                                             @NotNull TaskContainer taskContainer,
                                                             @NotNull
                                                             @NotNull com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties,
                                                             boolean finalTask)
                                                      throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Import the task definition from its properties.

Parameters:

id - an identifier this task shall be assigned with

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

taskProperties - the current task to be imported

finalTask - whether it shall be a final task

Returns:

TaskDefinition

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException - if properties are invalid

importTaskDefinition

@NotNull
public @NotNull TaskDefinition importTaskDefinition(long id,
                                                             @NotNull
                                                             @NotNull TaskContainer taskContainer,
                                                             @NotNull
                                                             @NotNull List<TaskDefinition> precedingTasks,
                                                             @NotNull
                                                             @NotNull com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties,
                                                             @Nullable
                                                             @Nullable VcsBranch importedBranch,
                                                             boolean finalTask)
                                                      throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Import the task definition from its properties.

Parameters:

id - an identifier this task shall be assigned with

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

precedingTasks - lists of tasks which were declared before the current task

taskProperties - the current task to be imported

finalTask - whether it shall be a final task

importedBranch - the current branch if importing a divergent branch, null otherwise

Returns:

TaskDefinition

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException - if properties are invalid

validateTaskProperties

public void validateTaskProperties(@NotNull
                                   @NotNull com.atlassian.bamboo.specs.api.model.plan.PlanProperties topLevelPlanProperties,
                                   @NotNull
                                   @NotNull RssPermissions rssPermissions,
                                   @Nullable
                                   @Nullable VcsBranch importedBranch)
                            throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

validateTaskProperties

public void validateTaskProperties(@NotNull
                                   @NotNull com.atlassian.bamboo.specs.api.model.deployment.DeploymentProperties deploymentProperties,
                                   @NotNull
                                   @NotNull RssPermissions rssPermissions)
                            throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException