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

Class VcsCommitTaskExporter

java.lang.Object

com.atlassian.bamboo.task.export.AbstractRepositoryAwareTaskExporter

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

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

All Implemented Interfaces:

TaskDefinitionExporter

public class VcsCommitTaskExporter
extends AbstractVcsTaskExporter

Field Summary

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

projectManager, vcsRepositoryManager

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

repositoryDefinitionManager

Constructor Summary

Constructors

Constructor	Description
VcsCommitTaskExporter(@NotNull RepositoryDefinitionManager repositoryDefinitionManager, @NotNull VcsRepositoryManager vcsRepositoryManager, @NotNull ProjectManager projectManager)

Method Summary

Modifier and Type	Method	Description
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.builders.task.VcsCommitTask	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.
@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

fromYaml, toSpecsEntity, toTaskConfiguration, toTaskConfiguration, toYaml

Constructor Details

VcsCommitTaskExporter

@Inject
public VcsCommitTaskExporter(@NotNull
 @NotNull RepositoryDefinitionManager repositoryDefinitionManager,
 @NotNull
 @NotNull VcsRepositoryManager vcsRepositoryManager,
 @NotNull
 @NotNull ProjectManager projectManager)

Method Details

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

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.

Parameters:

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

taskProperties - the current task

Returns:

task configuration

toSpecsEntity

@NotNull
public @NotNull com.atlassian.bamboo.specs.builders.task.VcsCommitTask 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.

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.