com.atlassian.bamboo.vcs.configuration.service

Interface VcsRepositoryConfigurationService

All Known Implementing Classes:

VcsRepositoryConfigurationServiceImpl

public interface VcsRepositoryConfigurationService

Since:

5.14

Field Summary

Fields

Modifier and Type	Field and Description
static String	LEGACY_VCS_PLUGINS_USED_BANDANA_KEY

Method Summary

Modifier and Type	Method and Description
ErrorCollection	configureRssDetection(long repositoryId, PartialVcsRepositoryData vcsRepositoryData, boolean isEnabled) Sets detection of Bamboo Specs for repository and saves new config.
PartialVcsRepositoryData	convertToNewRepositoryConfiguration(PartialVcsRepositoryData vcsRepositoryData) Deprecated. since 5.14 should be used for backward compatibility and upgrade task only
PartialVcsRepositoryData	createLinkedRepository(PartialVcsRepositoryData newVcsConfiguration, com.atlassian.user.User user, RepositoryConfigurationService.LinkedRepositoryAccess accessOption) Creates new linked repository.
PartialVcsRepositoryData	createPlanRepository(Plan plan, PartialVcsRepositoryData newVcsConfiguration) Creates "plan local" repository and adds it to a plan.
void	deleteLinkedRepository(long repositoryId) Removes linked repository.
void	deleteRepository(Plan plan, long repositoryId, Long replacementRepositoryId) Removes repository definition from a plan
PartialVcsRepositoryData	editLinkedRepository(long repositoryId, PartialVcsRepositoryData newVcsConfiguration) Edits existing linked repository
PartialVcsRepositoryData	editRepository(Plan plan, long repositoryId, PartialVcsRepositoryData newVcsConfiguration) Edits existing "plan local" repository.
Map<ImmutableJob,List<TaskDefinition>>	getRelevantJobsForRepositoryIdChange(ImmutablePlan plan, long repositoryId) Deprecated. since 5.14
PartialVcsRepositoryData	linkRepositoryToPlan(Plan plan, long selectedRepositoryId) Connects a linked repository to a plan by creating a new repository that inherits all the data from the linked repository and adding it to the plan.
PartialVcsRepositoryData	mergeLinkedRepository(PartialVcsRepositoryData vcsRepositoryData) Merges the state of the given linked repository into the database.
void	mergePlanRepositories(Plan plan, List<PartialVcsRepositoryData> vcsRepositoryDataList) Merges the state of the given plan repositories into the database.
void	moveRepository(Plan plan, long repositoryId, long beforePosition, long afterPosition) Changes position of repository in the repository list.
PartialVcsRepositoryData	replaceRepositoryInPlan(Plan plan, VcsRepositoryData parentRepository, PartialVcsRepositoryData oldRepository, PartialVcsRepositoryData newRepository) Replaces uses of a repository with another one.
void	setParentOfPlanRepository(ImmutablePlan plan, long repositoryId, long parentRepositoryId) Creates or changes parent-child relationship for a plan repository.
void	shareRepository(Plan plan, PartialVcsRepositoryData repositoryData, String repositoryName, String userDescription, com.atlassian.user.User user) Converts existing Plan repository to Linked repository.
void	validateLinkedRepository(PartialVcsRepositoryData vcsRepositoryData) Validate linked repository before saving it in database.
boolean	validateLinkedRepositoryName(String repositoryName, BambooIdProvider vcsRepositoryData) Checks if name of a linked repository is unique.
void	validatePlanRepository(Plan plan, PartialVcsRepositoryData vcsRepositoryData) Validate plan repository before saving it in database.
boolean	validateRepositoryName(ImmutablePlan immutablePlan, String repositoryName, BambooIdProvider repositoryDefinition) Checks if provided name for repository is unique in the Plan
boolean	validateRestartableStatus(ResultsSummary resultSummary) Checks that repositories referenced by a result still exists in Bamboo db.

Field Detail

LEGACY_VCS_PLUGINS_USED_BANDANA_KEY

static final String LEGACY_VCS_PLUGINS_USED_BANDANA_KEY

See Also:

Constant Field Values

Method Detail

createLinkedRepository

@NotNull
PartialVcsRepositoryData createLinkedRepository(@NotNull
                                                         PartialVcsRepositoryData newVcsConfiguration,
                                                         @NotNull
                                                         com.atlassian.user.User user,
                                                         @NotNull
                                                         RepositoryConfigurationService.LinkedRepositoryAccess accessOption)

Creates new linked repository.

Parameters:

newVcsConfiguration -

user -

accessOption -

Returns:

editLinkedRepository

@NotNull
PartialVcsRepositoryData editLinkedRepository(long repositoryId,
                                                       @NotNull
                                                       PartialVcsRepositoryData newVcsConfiguration)

Edits existing linked repository

Parameters:

repositoryId -

newVcsConfiguration -

Returns:

validateLinkedRepositoryName

boolean validateLinkedRepositoryName(@NotNull
                                     String repositoryName,
                                     @Nullable
                                     BambooIdProvider vcsRepositoryData)

Checks if name of a linked repository is unique.

Parameters:

repositoryName -

vcsRepositoryData -

Returns:

validateRepositoryName

boolean validateRepositoryName(@NotNull
                               ImmutablePlan immutablePlan,
                               @NotNull
                               String repositoryName,
                               @Nullable
                               BambooIdProvider repositoryDefinition)

Checks if provided name for repository is unique in the Plan

linkRepositoryToPlan

@NotNull
PartialVcsRepositoryData linkRepositoryToPlan(@NotNull
                                                       Plan plan,
                                                       long selectedRepositoryId)

Connects a linked repository to a plan by creating a new repository that inherits all the data from the linked repository and adding it to the plan.

Parameters:

plan -

selectedRepositoryId -

Returns:

createPlanRepository

@NotNull
PartialVcsRepositoryData createPlanRepository(@NotNull
                                                       Plan plan,
                                                       @NotNull
                                                       PartialVcsRepositoryData newVcsConfiguration)

Creates "plan local" repository and adds it to a plan.

Parameters:

plan -

newVcsConfiguration -

Returns:

editRepository

@NotNull
PartialVcsRepositoryData editRepository(@NotNull
                                                 Plan plan,
                                                 long repositoryId,
                                                 @NotNull
                                                 PartialVcsRepositoryData newVcsConfiguration)

Edits existing "plan local" repository.

Parameters:

plan -

repositoryId -

newVcsConfiguration -

Returns:

deleteRepository

void deleteRepository(@NotNull
                      Plan plan,
                      long repositoryId,
                      @Nullable
                      Long replacementRepositoryId)

Removes repository definition from a plan

Parameters:

plan -

repositoryId -

replacementRepositoryId - repository id to replace removed one in tasks depending on it

deleteLinkedRepository

void deleteLinkedRepository(long repositoryId)

Removes linked repository.

Parameters:

repositoryId -

moveRepository

void moveRepository(@NotNull
                    Plan plan,
                    long repositoryId,
                    long beforePosition,
                    long afterPosition)

Changes position of repository in the repository list. Important for setting default repository

Parameters:

plan -

repositoryId - the RepositoryDefinition to move

beforePosition - position of the RepositoryDefinition that will be before the moving Repository, -1 if the beginning of the list

afterPosition - position of the RepositoryDefinition that will be after the moving Repository, -1 if the end of the list

shareRepository

void shareRepository(@NotNull
                     Plan plan,
                     @NotNull
                     PartialVcsRepositoryData repositoryData,
                     @NotNull
                     String repositoryName,
                     @Nullable
                     String userDescription,
                     @NotNull
                     com.atlassian.user.User user)

Converts existing Plan repository to Linked repository.

Parameters:

plan - plan that owns the repository

repositoryData - repository to share

repositoryName - new name of the repository

userDescription - of the repository

Since:

5.14

setParentOfPlanRepository

void setParentOfPlanRepository(@NotNull
                               ImmutablePlan plan,
                               long repositoryId,
                               long parentRepositoryId)

Creates or changes parent-child relationship for a plan repository.

Parameters:

plan -

repositoryId -

parentRepositoryId -

replaceRepositoryInPlan

PartialVcsRepositoryData replaceRepositoryInPlan(@NotNull
                                                 Plan plan,
                                                 @NotNull
                                                 VcsRepositoryData parentRepository,
                                                 @NotNull
                                                 PartialVcsRepositoryData oldRepository,
                                                 @NotNull
                                                 PartialVcsRepositoryData newRepository)

Replaces uses of a repository with another one.

Parameters:

plan -

parentRepository -

oldRepository -

newRepository -

Returns:

validateRestartableStatus

boolean validateRestartableStatus(@NotNull
                                  ResultsSummary resultSummary)

Checks that repositories referenced by a result still exists in Bamboo db.

Parameters:

resultSummary -

Returns:

getRelevantJobsForRepositoryIdChange

@Deprecated
Map<ImmutableJob,List<TaskDefinition>> getRelevantJobsForRepositoryIdChange(@NotNull
                                                                                        ImmutablePlan plan,
                                                                                        long repositoryId)

Deprecated. since 5.14

Gets list of jobs using a repository.

Parameters:

plan -

repositoryId -

convertToNewRepositoryConfiguration

@Deprecated
PartialVcsRepositoryData convertToNewRepositoryConfiguration(@NotNull
                                                                         PartialVcsRepositoryData vcsRepositoryData)

Deprecated. since 5.14 should be used for backward compatibility and upgrade task only

If repository data represents a repository implemented in the old system and appropriate new plugin exists, the data is converted to the new plugin. Otherwise, original data is returned.

Parameters:

vcsRepositoryData -

Returns:

validateLinkedRepository

void validateLinkedRepository(@NotNull
                              PartialVcsRepositoryData vcsRepositoryData)
                       throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Validate linked repository before saving it in database.

Parameters:

vcsRepositoryData - imported linked repository

Throws:

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

mergeLinkedRepository

PartialVcsRepositoryData mergeLinkedRepository(@NotNull
                                               PartialVcsRepositoryData vcsRepositoryData)
                                        throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Merges the state of the given linked repository into the database.

This service will attempt to merge the entity based on ImmutableEntityWithOid.getOid(), and if there's no match, based on DescriptionProvider.getName(). If an existing entity is found, then it will be updated. Otherwise, a new database entity will be created. It's assumed that this method is used in specs import only as it's sending analytic event.

Parameters:

vcsRepositoryData - imported linked repository

Returns:

an object after persisting to the database - either the newly created or updated database object

Throws:

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

validatePlanRepository

void validatePlanRepository(@NotNull
                            Plan plan,
                            @NotNull
                            PartialVcsRepositoryData vcsRepositoryData)
                     throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Validate plan repository before saving it in database.

Parameters:

plan -

vcsRepositoryData - imported plan repository

Throws:

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

mergePlanRepositories

void mergePlanRepositories(@NotNull
                           Plan plan,
                           @NotNull
                           List<PartialVcsRepositoryData> vcsRepositoryDataList)
                    throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Merges the state of the given plan repositories into the database.

This service will attempt to merge the entities based on ImmutableEntityWithOid.getOid(), and if there's no match, based on PartialVcsRepositoryData.getParentId()}. If an existing entity is found, then it will be updated. Otherwise, a new database entity will be created. All other repositories in plan will be removed.

Parameters:

plan -

vcsRepositoryDataList - list of imported plan repositories

Throws:

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

configureRssDetection

@NotNull
ErrorCollection configureRssDetection(long repositoryId,
                                               PartialVcsRepositoryData vcsRepositoryData,
                                               boolean isEnabled)

Sets detection of Bamboo Specs for repository and saves new config. Validates if repository supports RSS.

Parameters:

repositoryId - id of repository

vcsRepositoryData - repository configuration, remains unchanged

isEnabled - true if Specs detection should be enabled, false otherwise

Returns:

a list of errors.