Package jetbrains.buildServer.vcs

Interface VcsRootInstanceEx

All Superinterfaces:

Loggable, LVcsRoot, LVcsRootInstance, LVcsRootInstanceEx, VcsRoot, VcsRootInstance

All Known Implementing Classes:

VcsRootInstanceImpl, VcsRootInstanceWithParent

public interface VcsRootInstanceEx
extends LVcsRootInstanceEx, VcsRootInstance

Represents instance of VCS root which can be used for changes collecting. VCS root instance settings have all parameters resolved.

Field Summary

Fields inherited from interface jetbrains.buildServer.vcs.VcsRoot

SECURE_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
void	addCollectChangesProgress(String progressMessage)
List<String>	getCollectChangesProgress()
String	getDefaultBranchName()	For DAG based VCS roots returns default branch name if it is known.
RepositoryState	getLastUsedState()
VcsDurationMetrics	getMetrics()	TC collects timing for the last checking for changes operations to show it on Vcs Status tab
VcsRootStatus	getPreviousStatus()
Set<String>	getVcsBranchesContainingModId(long modId)
VcsRootInstanceContext	getVcsRootInstanceContext()
boolean	isConnectedDAGsTraversingEnabled()
boolean	isSubrepo()
String	mapPath(String fileName, CheckoutRules checkoutRules)
void	resetPollingStateCache()	Resets internal polling state cache so that next access to it's fields fetched them from the database
boolean	sameParameters(Map<String,String> paramsForComparison)
void	setPollingMode(boolean pollingMode)
boolean	shouldStoreParentRevisions()
<R> R	withConnectedDAG(Predicate<VcsRootInstance> vcsRootPredicate, Function<DAG<Long>,R> function)	Calls provided function with a DAG which potentially can have VCS modifications belonging to different VCS root instances.

Methods inherited from interface jetbrains.buildServer.log.Loggable

describe

Methods inherited from interface jetbrains.buildServer.vcs.LVcsRoot

getDescription, getVcsDisplayName

Methods inherited from interface jetbrains.buildServer.vcs.LVcsRootInstance

findService, getCheckoutPropertiesHash, getParentId, getService, getService, getStatus, getVersionDisplayName, isCurrentVersionExpensive

Methods inherited from interface jetbrains.buildServer.vcs.LVcsRootInstanceEx

compareAndSetStatus, getCurrentState, getLastFinishChangesCollectingTime, getLastRequestor, getVcsSupportCore, isChangesCollectingLockObtained, isPollingMode, setExplicitModificationCheckInterval, setStatus, startChangesCollectingInLock, tryLockChangesCollecting, tryLockChangesCollecting, unlockChangesCollecting

Methods inherited from interface jetbrains.buildServer.vcs.VcsRoot

getExternalId, getId, getName, getProperties, getProperty, getProperty, getVcsName

Methods inherited from interface jetbrains.buildServer.vcs.VcsRootInstance

findModificationById, findModificationByVersion, findModificationIdByVersion, getCurrentRevision, getDag, getEffectiveModificationCheckInterval, getLastUsedRevision, getParent, getUsages, isDagBased, isPollingMode

Method Detail

isSubrepo

boolean isSubrepo()

Returns:

true if this root is a subrepository of some other root

getPreviousStatus

@NotNull
VcsRootStatus getPreviousStatus()

getVcsBranchesContainingModId

@NotNull
Set<String> getVcsBranchesContainingModId(long modId)

addCollectChangesProgress

void addCollectChangesProgress(@NotNull
                               String progressMessage)

getCollectChangesProgress

@NotNull
List<String> getCollectChangesProgress()

getLastUsedState

@NotNull
RepositoryState getLastUsedState()

Specified by:

getLastUsedState in interface LVcsRootInstanceEx

getDefaultBranchName

@Nullable
String getDefaultBranchName()

For DAG based VCS roots returns default branch name if it is known. The default branch name is known if the last used repository state is not empty.

Returns:

see above

mapPath

@Nullable
String mapPath(@NotNull
               String fileName,
               @NotNull
               CheckoutRules checkoutRules)

Parameters:

fileName - name of file from personal build which includes repository identity and relative path within repository, see PersonalSupportBatchService.mapPath(Collection, String, boolean)

Returns:

first matched mapped path within given VcsRootInstance with given checkoutRules

Since:

10.0

setPollingMode

void setPollingMode(boolean pollingMode)

sameParameters

boolean sameParameters(@NotNull
                       Map<String,String> paramsForComparison)

Parameters:

paramsForComparison -

Returns:

true if this VCS root instance has the same set of parameters as the passed map

getMetrics

VcsDurationMetrics getMetrics()

TC collects timing for the last checking for changes operations to show it on Vcs Status tab

Since:

2018.1.1

resetPollingStateCache

void resetPollingStateCache()

Resets internal polling state cache so that next access to it's fields fetched them from the database

shouldStoreParentRevisions

boolean shouldStoreParentRevisions()

Returns:

true if parent revisions should be stored into the database when a newly detected VCS commit is persisted

getVcsRootInstanceContext

@NotNull
VcsRootInstanceContext getVcsRootInstanceContext()

withConnectedDAG

<R> R withConnectedDAG(@NotNull
                       Predicate<VcsRootInstance> vcsRootPredicate,
                       @NotNull
                       Function<DAG<Long>,R> function)

Calls provided function with a DAG which potentially can have VCS modifications belonging to different VCS root instances. The VCS root instances which can be used to connect DAGs should be accepted by the specified filter. The value returned by the function is also the result of this method.

Parameters:

vcsRootPredicate -

Returns:

Since:

2024.12

isConnectedDAGsTraversingEnabled

boolean isConnectedDAGsTraversingEnabled()