com.atlassian.bamboo.repository

Interface RepositoryDefinitionManager

@PublicApi
public interface RepositoryDefinitionManager

Interface to handle access to repository data.

Method Summary

Methods

Modifier and Type	Method and Description
List<RepositoryDataEntity>	findRepositoriesByPluginKey(String pluginKey) Given a pluginKey this will get you all of the repositories in Bamboo that were created for that key.
List<RepositoryData>	getGlobalRepositoryDefinitions() Get all Shared repositories current user has permission to use in his plans.
List<RepositoryData>	getGlobalRepositoryDefinitionsUnrestricted() Get all Shared Repositories without permission checking.
List<PlanIdentifier>	getIdentifiersOfPlansUsingRepository(long repositoryId) Get identifiers of Plans referencing a repository.
PlanRepositoryLink	getPlanRepositoryLink(ImmutablePlan plan, long repositoryId) Get persistent representation of a relation between Plan and repository
List<PlanRepositoryLink>	getPlanRepositoryLinks(ImmutablePlan plan) Get persistent representation of relation between Plan and repositories
List<PlanRepositoryLink>	getPlansUsingRepository(long repositoryId)
RepositoryDataEntity	getRepositoryDataEntity(long id) Get persistent representation of a repository
List<RepositoryDefinition>	getRepositoryDefinitionsForPlan(ImmutablePlan plan) Get all repositories attached to a plan ordered by position.
void	removeRepositoriesForPlan(Plan plan) Remove all repositories from Plan that are not global repositories.
void	removeRepositoryFromPlan(PlanRepositoryLink planRepository) Removes relation between repository and plan.
void	removeRepositoryIfUnused(RepositoryDataEntity repositoryDataEntity) Marks repository for deletion if it is referenced by a RepositoryChangeset, removes it otherwise.
void	removeUnusedRepositories() Removes all repositories that has been previously markedForDeletion and are no longer referenced by any RepositoryChangeset
void	savePlanRepositoryLink(PlanRepositoryLink planRepository)
void	savePlanRepositoryLinks(List<PlanRepositoryLink> planRepositories) Saves the collection of plan to repository relations.
long	savePlanRepositoryWithDefinition(PlanRepositoryLink planRepository) Saves plan to repository relation definition with cascade to RepositoryDataEntity
long	saveRepositoryDefinition(RepositoryDataEntity repositoryData) Save repository definition.
void	saveRepositoryDefinitions(Collection<RepositoryDataEntity> repositoriesBeingCreated) Saves all repository definitions in the collection.

Method Detail

getPlanRepositoryLink

@Nullable
PlanRepositoryLink getPlanRepositoryLink(@NotNull
                                                ImmutablePlan plan,
                                                long repositoryId)

Get persistent representation of a relation between Plan and repository

Parameters:

plan -

repositoryId -

getPlanRepositoryLinks

@NotNull
List<PlanRepositoryLink> getPlanRepositoryLinks(@NotNull
                                                      ImmutablePlan plan)

Get persistent representation of relation between Plan and repositories

Parameters:

plan -

getRepositoryDataEntity

@Nullable
RepositoryDataEntity getRepositoryDataEntity(long id)

Get persistent representation of a repository

Parameters:

id -

Returns:

getRepositoryDefinitionsForPlan

@NotNull
List<RepositoryDefinition> getRepositoryDefinitionsForPlan(@NotNull
                                                                 ImmutablePlan plan)

Get all repositories attached to a plan ordered by position.

Parameters:

plan -

Returns:

removeRepositoriesForPlan

void removeRepositoriesForPlan(Plan plan)

Remove all repositories from Plan that are not global repositories.

Parameters:

plan -

saveRepositoryDefinition

long saveRepositoryDefinition(RepositoryDataEntity repositoryData)

Save repository definition.

Parameters:

repositoryData -

Returns:

id of saved definition

saveRepositoryDefinitions

void saveRepositoryDefinitions(@NotNull
                             Collection<RepositoryDataEntity> repositoriesBeingCreated)

Saves all repository definitions in the collection.

Parameters:

repositoriesBeingCreated -

savePlanRepositoryWithDefinition

long savePlanRepositoryWithDefinition(@NotNull
                                    PlanRepositoryLink planRepository)

Saves plan to repository relation definition with cascade to RepositoryDataEntity

Parameters:

planRepository -

Returns:

savePlanRepositoryLink

void savePlanRepositoryLink(@NotNull
                          PlanRepositoryLink planRepository)

savePlanRepositoryLinks

void savePlanRepositoryLinks(@NotNull
                           List<PlanRepositoryLink> planRepositories)

Saves the collection of plan to repository relations.

Parameters:

planRepositories -

removeRepositoryIfUnused

void removeRepositoryIfUnused(RepositoryDataEntity repositoryDataEntity)

Marks repository for deletion if it is referenced by a RepositoryChangeset, removes it otherwise.

Parameters:

repositoryDataEntity -

removeUnusedRepositories

void removeUnusedRepositories()

Removes all repositories that has been previously markedForDeletion and are no longer referenced by any RepositoryChangeset

removeRepositoryFromPlan

void removeRepositoryFromPlan(@NotNull
                            PlanRepositoryLink planRepository)

Removes relation between repository and plan. If the repository is not a global repository, removeRepositoryIfUnused(RepositoryDataEntity) is called.

Parameters:

planRepository -

getGlobalRepositoryDefinitions

List<RepositoryData> getGlobalRepositoryDefinitions()

Get all Shared repositories current user has permission to use in his plans.

Returns:

getGlobalRepositoryDefinitionsUnrestricted

List<RepositoryData> getGlobalRepositoryDefinitionsUnrestricted()

Get all Shared Repositories without permission checking.

Returns:

getPlansUsingRepository

List<PlanRepositoryLink> getPlansUsingRepository(long repositoryId)

getIdentifiersOfPlansUsingRepository

List<PlanIdentifier> getIdentifiersOfPlansUsingRepository(long repositoryId)

Get identifiers of Plans referencing a repository. This is faster than getPlansUsingRepository() and should be preferred for 'view' actions.

Parameters:

repositoryId -

Since:

4.2

findRepositoriesByPluginKey

@NotNull
List<RepositoryDataEntity> findRepositoriesByPluginKey(@NotNull
                                                             String pluginKey)

Given a pluginKey this will get you all of the repositories in Bamboo that were created for that key. Irrespective of whether:

• The plugin module with that plugin key is currently disabled.
• The repository is marked for deletion.
• The repository is marked as global or not.

In short it will get you every single repository that matches the provided plugin key.

Parameters:

pluginKey - The plugin key to search for.

Returns:

All of the repositories that match that plugin key.