Package jetbrains.buildServer.vcs

Interface VcsManager

All Superinterfaces:

VcsContentManager, VcsRegistry, VcsRootInstancesManager, VcsRootsManager, VcsRootUsernamesManager, VcsServiceFactory, VcsServiceProvider

All Known Subinterfaces:

VcsManagerEx

All Known Implementing Classes:

SecuredVcsManager, VcsManagerImpl

public interface VcsManager
extends VcsRegistry, VcsServiceFactory, VcsRootUsernamesManager, VcsContentManager, VcsRootsManager, VcsRootInstancesManager

A basic starting point for various VCS - related operations, including, but not limited to:

• VcsSupport management (add your VCS support here!)
• Obtain file contents
• Create/Edit VCS root, check its status
• Find committers between particular builds

Author:

Kir

Method Summary

Modifier and Type	Method	Description
SVcsModification	findModificationById(long changeId, boolean isPersonal)	Find and return VCS modification by its id and isPersonal flag.
Collection<SUser>	getModificationUsers(SVcsModification modification)	Deprecated. use SVcsModification.getCommitters()
VcsRootStatus	getStatus(SVcsRoot vcsRoot)	Deprecated. This method should not be used, because it returns questionable data when a VCS Root is parameterized and used in different build configurations
VcsModificationHistory	getVcsHistory()	Deprecated. use spring to autowire VcsModificationHistory
VcsStatusLogger	getVcsStatusProvider()	Deprecated. use spring to autowire VcsStatusProvider

Methods inherited from interface jetbrains.buildServer.vcs.VcsContentManager

getFileContent, getFileContent, getFileContent

Methods inherited from interface jetbrains.buildServer.vcs.VcsRegistry

findVcsByName, findVcsContextByName, getAllVcs, getAllVcsCore

Methods inherited from interface jetbrains.buildServer.vcs.VcsRootInstancesManager

findRootInstanceById, getVcsRootInstance

Methods inherited from interface jetbrains.buildServer.vcs.VcsRootsManager

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

Methods inherited from interface jetbrains.buildServer.vcs.VcsRootUsernamesManager

getUsers, getVcsRootsUsernames, getVcsUsernames

Methods inherited from interface jetbrains.vcs.api.VcsServiceProvider

getGenericService, getVcsService

Method Detail

getVcsHistory

@NotNull
@Deprecated
VcsModificationHistory getVcsHistory()

Deprecated.

use spring to autowire VcsModificationHistory

Returns:

manager for detected VCS changes (i.e. user commits)

getVcsStatusProvider

@NotNull
@Deprecated
VcsStatusLogger getVcsStatusProvider()

Deprecated.

use spring to autowire VcsStatusProvider

Returns a component which can be used to detect/report a status of a version control system root in a particular build configuration.

Returns:

see above

getModificationUsers

@Deprecated
@NotNull
Collection<SUser> getModificationUsers(@NotNull
                                       SVcsModification modification)

Deprecated.

use SVcsModification.getCommitters()

Parameters:

modification - VCS modification

Returns:

collection of users who contributed to the given VCS modification

findModificationById

@Nullable
SVcsModification findModificationById(long changeId,
                                      boolean isPersonal)

Find and return VCS modification by its id and isPersonal flag.

Parameters:

changeId - VCS modification identifier, see VcsModification.getId()

isPersonal - true if the searched modification relates to personal build

Returns:

see above

getStatus

@NotNull
VcsRootStatus getStatus(@NotNull
                        SVcsRoot vcsRoot)

Deprecated.

This method should not be used, because it returns questionable data when a VCS Root is parameterized and used in different build configurations

Provides current status of the given vcs root. Can be
- last checked at
- scheduled for the checking at
- started for checking at

Parameters:

vcsRoot - vcs root to get status for

Returns:

given root status

See Also:

LVcsRootInstance.getStatus()