com.atlassian.bamboo.plugins.vcs.task.export

Class VcsCheckoutTaskExporter

java.lang.Object

com.atlassian.bamboo.task.export.AbstractRepositoryAwareTaskExporter

com.atlassian.bamboo.plugins.vcs.task.export.AbstractVcsTaskExporter

com.atlassian.bamboo.plugins.vcs.task.export.VcsCheckoutTaskExporter

All Implemented Interfaces:

TaskDefinitionExporter

public class VcsCheckoutTaskExporter
extends AbstractVcsTaskExporter
implements TaskDefinitionExporter

Field Summary

Fields inherited from class com.atlassian.bamboo.plugins.vcs.task.export.AbstractVcsTaskExporter

vcsRepositoryManager

Fields inherited from class com.atlassian.bamboo.task.export.AbstractRepositoryAwareTaskExporter

repositoryDefinitionManager

Constructor Summary

Constructors

Constructor and Description
VcsCheckoutTaskExporter(@NotNull RepositoryDefinitionManager repositoryDefinitionManager, @NotNull VcsRepositoryManager vcsRepositoryManager, @NotNull BambooPermissionManager bambooPermissionManager)

Method Summary

Modifier and Type	Method and Description
@Nullable com.atlassian.bamboo.specs.builders.task.VcsCheckoutTask	fromYaml(@NotNull Node node, @NotNull TaskValidationContext context) Parse YAML node to Task Specs builder.
protected @NotNull com.atlassian.bamboo.specs.api.validators.common.ValidationContext	getValidationContext() Get validation context for this task type.
protected boolean	isRepositoryTypeSupported(@NotNull VcsRepositoryModuleDescriptor moduleDescriptor) Returns true if the given repository type is supported by this task type.
@NotNull com.atlassian.bamboo.specs.api.builders.task.Task	toSpecsEntity(@NotNull TaskDefinition taskDefinition) Create Bamboo Specs object representing this task.
@NotNull Map<String,String>	toTaskConfiguration(@NotNull TaskContainer taskContainer, @NotNull com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties) Converts properties to Bamboo task configuration.
@Nullable Node	toYaml(@NotNull com.atlassian.bamboo.specs.api.model.task.TaskProperties genericTaskProperties) Convert task definition to YAML node.
@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.

Methods inherited from class com.atlassian.bamboo.plugins.vcs.task.export.AbstractVcsTaskExporter

baseVcsTaskToConfiguration, baseVcsTaskToSpecsEntity, baseVcsTaskValidate, getTypedTaskProperties, isDefaultRepositoryRef

Methods inherited from class com.atlassian.bamboo.task.export.AbstractRepositoryAwareTaskExporter

getNonDefaultRepositoryRef, getNonDefaultRepositoryRef, getRepositoryIdString, getRepositoryListForTaskContainer, isDefaultRepositoryRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.task.export.TaskDefinitionExporter

toSpecsEntity, toTaskConfiguration, toTaskConfiguration

Constructor Detail

VcsCheckoutTaskExporter

@Inject
public VcsCheckoutTaskExporter(@NotNull
                                       @NotNull RepositoryDefinitionManager repositoryDefinitionManager,
                                       @NotNull
                                       @NotNull VcsRepositoryManager vcsRepositoryManager,
                                       @NotNull
                                       @NotNull BambooPermissionManager bambooPermissionManager)

Method Detail

getValidationContext

@NotNull
protected @NotNull com.atlassian.bamboo.specs.api.validators.common.ValidationContext getValidationContext()

Description copied from class: AbstractVcsTaskExporter

Get validation context for this task type.

Specified by:

getValidationContext in class AbstractVcsTaskExporter

isRepositoryTypeSupported

protected boolean isRepositoryTypeSupported(@NotNull
                                            @NotNull VcsRepositoryModuleDescriptor moduleDescriptor)

Description copied from class: AbstractVcsTaskExporter

Returns true if the given repository type is supported by this task type.

Specified by:

isRepositoryTypeSupported in class AbstractVcsTaskExporter

toSpecsEntity

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

Description copied from interface: TaskDefinitionExporter

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.

Specified by:

toSpecsEntity in interface TaskDefinitionExporter

toTaskConfiguration

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

Description copied from interface: TaskDefinitionExporter

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.

Specified by:

toTaskConfiguration in interface TaskDefinitionExporter

Parameters:

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

taskProperties - the current task

Returns:

task configuration

validate

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

Description copied from interface: TaskDefinitionExporter

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.

Specified by:

validate in interface TaskDefinitionExporter

toYaml

@Nullable
public @Nullable Node toYaml(@NotNull
                                       @NotNull com.atlassian.bamboo.specs.api.model.task.TaskProperties genericTaskProperties)

Description copied from interface: TaskDefinitionExporter

Convert task definition to YAML node. Bamboo might modify returned node to add information about task conditions or other general task settings. To make it compatible with future versions returned value should be StringNode or MapNode (String, Map). Structure MapNode (String, String) can't be enriched with additional elements and cause runtime failures for some cases.

Specified by:

toYaml in interface TaskDefinitionExporter

Returns:

YAML representation of the task.

fromYaml

@Nullable
public @Nullable com.atlassian.bamboo.specs.builders.task.VcsCheckoutTask fromYaml(@NotNull
                                                                                             @NotNull Node node,
                                                                                             @NotNull
                                                                                             @NotNull TaskValidationContext context)

Description copied from interface: TaskDefinitionExporter

Parse YAML node to Task Specs builder.

Specified by:

fromYaml in interface TaskDefinitionExporter

Parameters:

node - YAML node from user input. In general case it's same node generated by TaskDefinitionExporter.toYaml(TaskProperties) method, but in some cases it might contain additional general task elements, like conditions. These elements should be ignored by method implementation and will be handled by Bamboo code. In such case MapNode handler should be implemented even if TaskDefinitionExporter.toYaml(TaskProperties) produces StringNode.

context - task validation context