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

Class AbstractVcsTaskExporter

java.lang.Object

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

All Implemented Interfaces:

TaskDefinitionExporter

Direct Known Subclasses:

VcsBranchTaskExporter, VcsCheckoutTaskExporter, VcsCommitTaskExporter, VcsPushTaskExporter, VcsTagTaskExporter

public abstract class AbstractVcsTaskExporter
extends Object
implements TaskDefinitionExporter

Abstract exporter for all VCS-related tasks.

Field Summary

Fields

Modifier and Type	Field and Description
protected RepositoryDefinitionManager	repositoryDefinitionManager
protected VcsRepositoryManager	vcsRepositoryManager

Constructor Summary

Constructors

Constructor and Description
AbstractVcsTaskExporter()

Method Summary

Modifier and Type	Method and Description
protected Map<String,String>	baseVcsTaskToConfiguration(TaskContainer taskContainer, com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties) Implementation of TaskDefinitionExporter.toTaskConfiguration(TaskContainer, TaskProperties) for exporters of BaseVcsTaskProperties.
protected <P extends com.atlassian.bamboo.specs.model.task.BaseVcsTaskProperties,B extends com.atlassian.bamboo.specs.builders.task.BaseVcsTask<B,P>> B	baseVcsTaskToSpecsEntity(TaskDefinition taskDefinition, B specsEntity) Implementation of TaskDefinitionExporter.toSpecsEntity(TaskDefinition) for exporters of BaseVcsTaskProperties.
protected List<com.atlassian.bamboo.specs.api.validators.common.ValidationProblem>	baseVcsTaskValidate(TaskValidationContext taskValidationContext, com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties) Implementation of TaskDefinitionExporter.validate(TaskValidationContext, TaskProperties) for exporters of BaseVcsTaskProperties.
protected com.atlassian.bamboo.specs.api.builders.repository.VcsRepositoryIdentifier	getNonDefaultRepositoryRef(String repositoryString) Get a repository reference Specs entity for a non-default repository.
protected com.atlassian.bamboo.specs.api.builders.repository.VcsRepositoryIdentifier	getNonDefaultRepositoryRef(String repositorySelector, Map<String,String> configuration) Get a Specs repository reference for a non-default repository.
protected String	getRepositoryIdString(com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryIdentifierProperties repository, TaskContainer taskContainer) Get database ID of a repository based on the passed identifier and task container.
protected List<? extends VcsRepositoryData>	getRepositoryListForTaskContainer(TaskContainer taskContainer)
protected <T> T	getTypedTaskProperties(com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties, Class<T> expectedClass) Get task properties as an instance of the given class if possible.
protected abstract com.atlassian.bamboo.specs.api.validators.common.ValidationContext	getValidationContext() Get validation context for this task type.
protected boolean	isDefaultRepositoryRef(String repositoryString) Whether the given repository identifier points to a default repository of a plan.
protected boolean	isDefaultRepositoryRef(String repositorySelector, Map<String,String> configuration) Whether the given repository identifier points to a default repository of a plan.
protected abstract boolean	isRepositoryTypeSupported(VcsRepositoryModuleDescriptor moduleDescriptor) Returns true if the given repository type is supported by this task type.

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, toSpecsEntity, toTaskConfiguration, toTaskConfiguration, validate

Field Detail

vcsRepositoryManager

@Autowired
protected VcsRepositoryManager vcsRepositoryManager

repositoryDefinitionManager

@Autowired
protected RepositoryDefinitionManager repositoryDefinitionManager

Constructor Detail

AbstractVcsTaskExporter

public AbstractVcsTaskExporter()

Method Detail

getValidationContext

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

Get validation context for this task type.

isRepositoryTypeSupported

protected abstract boolean isRepositoryTypeSupported(@NotNull
                                                     VcsRepositoryModuleDescriptor moduleDescriptor)

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

isDefaultRepositoryRef

protected boolean isDefaultRepositoryRef(@NotNull
                                         String repositorySelector,
                                         @NotNull
                                         Map<String,String> configuration)

Whether the given repository identifier points to a default repository of a plan.

Parameters:

repositorySelector - key to select repository identifier from the configuration

configuration - task configuration

Returns:

true if the repository identifier points to a default plan's repository

isDefaultRepositoryRef

protected boolean isDefaultRepositoryRef(@NotNull
                                         String repositoryString)

Whether the given repository identifier points to a default repository of a plan.

Parameters:

repositoryString - repository identifier string from the task configuration

Returns:

true if the repository identifier points to a default plan's repository

getNonDefaultRepositoryRef

@NotNull
protected com.atlassian.bamboo.specs.api.builders.repository.VcsRepositoryIdentifier getNonDefaultRepositoryRef(@NotNull
                                                                                                                         String repositorySelector,
                                                                                                                         @NotNull
                                                                                                                         Map<String,String> configuration)

Get a Specs repository reference for a non-default repository.

Parameters:

repositorySelector - key to select repository identifier from the configuration

configuration - task configuration

Returns:

VCS repository identifier

Throws:

IllegalArgumentException - if the repository selector points to a default repository

IllegalStateException - if the repository does not exist

getNonDefaultRepositoryRef

@NotNull
protected com.atlassian.bamboo.specs.api.builders.repository.VcsRepositoryIdentifier getNonDefaultRepositoryRef(@NotNull
                                                                                                                         String repositoryString)

Get a repository reference Specs entity for a non-default repository.

Parameters:

repositoryString - repository identifier string from the task configuration

Returns:

VCS repository identifier

Throws:

IllegalArgumentException - if the repository selector points to a default repository

IllegalStateException - if the repository does not exist

getRepositoryIdString

@NotNull
protected String getRepositoryIdString(@NotNull
                                                com.atlassian.bamboo.specs.api.model.repository.VcsRepositoryIdentifierProperties repository,
                                                @NotNull
                                                TaskContainer taskContainer)

Get database ID of a repository based on the passed identifier and task container.

Parameters:

repository - Specs repository identifier

taskContainer - task container

Returns:

ID of the repository as String

Throws:

IllegalArgumentException - if repository can't be found

baseVcsTaskToConfiguration

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

Implementation of TaskDefinitionExporter.toTaskConfiguration(TaskContainer, TaskProperties) for exporters of BaseVcsTaskProperties.

baseVcsTaskToSpecsEntity

@NotNull
protected <P extends com.atlassian.bamboo.specs.model.task.BaseVcsTaskProperties,B extends com.atlassian.bamboo.specs.builders.task.BaseVcsTask<B,P>> B baseVcsTaskToSpecsEntity(@NotNull
                                                                                                                                                                                          TaskDefinition taskDefinition,
                                                                                                                                                                                          @NotNull
                                                                                                                                                                                          B specsEntity)

Implementation of TaskDefinitionExporter.toSpecsEntity(TaskDefinition) for exporters of BaseVcsTaskProperties.

baseVcsTaskValidate

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

Implementation of TaskDefinitionExporter.validate(TaskValidationContext, TaskProperties) for exporters of BaseVcsTaskProperties.

getTypedTaskProperties

@NotNull
protected <T> T getTypedTaskProperties(@NotNull
                                                com.atlassian.bamboo.specs.api.model.task.TaskProperties taskProperties,
                                                @NotNull
                                                Class<T> expectedClass)

Get task properties as an instance of the given class if possible.

Parameters:

taskProperties - generic task properties, not yet typed properly

expectedClass - expected class of the task properties

Returns:

typed task properties

Throws:

IllegalStateException - if the task properties are of an incorrect, unsupported type

getRepositoryListForTaskContainer

@NotNull
protected List<? extends VcsRepositoryData> getRepositoryListForTaskContainer(@NotNull
                                                                                       TaskContainer taskContainer)