Package jetbrains.buildServer.vcs

Interface VcsRootsManagerEx

All Superinterfaces:

VcsRootsManager

All Known Subinterfaces:

VcsManagerEx

All Known Implementing Classes:

SecuredVcsManager, VcsManagerImpl, VcsRootsManagerImpl

public interface VcsRootsManagerEx
extends VcsRootsManager

Created 21.08.13 19:27

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Method Summary

Modifier and Type	Method	Description
void	addVcsRootUsageContributor(VcsRootUsagesContributor contributor)
SVcsRootEx	findRootByExternalId(String vcsRootExternalId)	Returns vcs root with specified external id.
SVcsRootEx	findRootById(long id)	returns vcs root with specified id
Set<String>	getAllConfigurationUsages(Collection<Long> vcsRootIds)	Returns all configurations which use the VCS roots specified.
Set<VcsRootUsagesContributor>	getAllVcsRootUsagesContributors()
List<SVcsRoot>	getAttachedRoots(SBuildType buildType)

Methods inherited from interface jetbrains.buildServer.vcs.VcsRootsManager

findRootsByVcsName, findUnusedVcsRootsByScope, findVcsRoots, findVcsRootsByScope, getAllConfigurationUsages, getAllProjectUsages, getAllRegisteredVcsRoots, getAllTemplateUsages, getNumberOfUsagesInConfigurations, getNumberOfUsagesInProjects, isUsedInProjects

Method Detail

getAllConfigurationUsages

@NotNull
Set<String> getAllConfigurationUsages(@NotNull
                                      Collection<Long> vcsRootIds)

Returns all configurations which use the VCS roots specified. Result set can be unmodifiable.

Parameters:

vcsRootIds - ids of vcs roots to search through

Returns:

all root usages (set of build type ids)

Since:

7.1

See Also:

VcsRootsManager.getAllConfigurationUsages(VcsRoot)

findRootById

@Nullable
SVcsRootEx findRootById(long id)

Description copied from interface: VcsRootsManager

returns vcs root with specified id

Specified by:

findRootById in interface VcsRootsManager

Parameters:

id - vcs root id

Returns:

vcs root by id

findRootByExternalId

@Nullable
SVcsRootEx findRootByExternalId(@Nullable
                                String vcsRootExternalId)

Description copied from interface: VcsRootsManager

Returns vcs root with specified external id. Since 8.1 the method also looks up the vcs root by the previous external ids. So the result project can have a different external id after a call. But the later is impossible if there is a vcs root that currently has a externalId.

Specified by:

findRootByExternalId in interface VcsRootsManager

Parameters:

vcsRootExternalId - vcs root external id

Returns:

vcs root by external id

getAttachedRoots

@NotNull
List<SVcsRoot> getAttachedRoots(@NotNull
                                SBuildType buildType)

addVcsRootUsageContributor

void addVcsRootUsageContributor(@NotNull
                                VcsRootUsagesContributor contributor)

getAllVcsRootUsagesContributors

@NotNull
Set<VcsRootUsagesContributor> getAllVcsRootUsagesContributors()

Returns:

all registred extension which can provide additional usages for VCS root

Since:

2022.04