com.atlassian.bamboo.deployments.environments

Interface RepositoryAwareDeploymentTaskConfigurator

All Superinterfaces:

DeploymentTaskRequirementSupport, TaskConfigurator

All Known Implementing Classes:

AbstractRepositoryAwareTaskConfigurator, AbstractVcsTaskConfigurator, VcsBranchTaskConfigurator, VcsCheckoutTaskConfigurator, VcsCommitTaskConfigurator, VcsPushTaskConfigurator, VcsTagTaskConfigurator

@PublicApi
public interface RepositoryAwareDeploymentTaskConfigurator
extends TaskConfigurator, DeploymentTaskRequirementSupport

Interface declaring that Task configured with this TaskConfigurator references RepositoryDefinitions.

Method Summary

Modifier and Type	Method and Description
@NotNull List<PlanRepositoryDefinition>	getPlanRepositoriesUsedByTask(@NotNull TaskDefinition taskDefinition, @NotNull InternalEnvironment environment)
default @NotNull List<RepositoryDefinition>	getRepositoriesUsedByTask(@NotNull TaskDefinition taskDefinition, @NotNull Environment environment) Deprecated. since 7.0 use getPlanRepositoriesUsedByTask(TaskDefinition, InternalEnvironment) instead.
void	handleRepositoryIdChanged(@NotNull TaskDefinition taskDefinition, @NotNull Map<Long,Long> repositoryIdChanges) Action taken if repository id changed, i.e.

Methods inherited from interface com.atlassian.bamboo.task.TaskConfigurator

generateTaskConfigMap, populateContextForCreate, populateContextForEdit, validate

Methods inherited from interface com.atlassian.bamboo.deployments.environments.DeploymentTaskRequirementSupport

calculateRequirements

Method Detail

getRepositoriesUsedByTask

@Deprecated
 @NotNull
default @NotNull List<RepositoryDefinition> getRepositoriesUsedByTask(@NotNull
                                                                                            @NotNull TaskDefinition taskDefinition,
                                                                                            @NotNull
                                                                                            @NotNull Environment environment)

Deprecated. since 7.0 use getPlanRepositoriesUsedByTask(TaskDefinition, InternalEnvironment) instead.

Not used by Bamboo and doesn't need to be implemented.

Parameters:

taskDefinition - definition of a Task

environment -

Returns:

list of RepositoryDefinition referenced by the Task

getPlanRepositoriesUsedByTask

@NotNull
@NotNull List<PlanRepositoryDefinition> getPlanRepositoriesUsedByTask(@NotNull
                                                                               @NotNull TaskDefinition taskDefinition,
                                                                               @NotNull
                                                                               @NotNull InternalEnvironment environment)

Parameters:

taskDefinition - definition of a Task

environment -

Returns:

list of PlanRepositoryDefinition referenced by the Task

handleRepositoryIdChanged

void handleRepositoryIdChanged(@NotNull
                               @NotNull TaskDefinition taskDefinition,
                               @NotNull
                               @NotNull Map<Long,Long> repositoryIdChanges)

Action taken if repository id changed, i.e. after repository is edited. Typically it should replace old repository identifiers with corresponding new id.

Parameters:

taskDefinition - definition of a Task

repositoryIdChanges - mapping between old and new repository identifiers