Package jetbrains.buildServer.vcs

Interface LVcsRootInstanceEx

All Superinterfaces:

Loggable, LVcsRoot, LVcsRootInstance, VcsRoot

All Known Subinterfaces:

VcsRootInstanceEx

All Known Implementing Classes:

VcsRootInstanceImpl, VcsRootInstanceWithParent

public interface LVcsRootInstanceEx
extends LVcsRootInstance

Created 25.08.13 13:18

Since:

8.1

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Field Summary

Fields inherited from interface jetbrains.buildServer.vcs.VcsRoot

SECURE_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
boolean	compareAndSetStatus(VcsRootStatus prevStatus, VcsRootStatus.Type newStatus)	Sets new status only if current status is the same as prevStatus.
RepositoryState	getCurrentState()
Date	getLastFinishChangesCollectingTime()	Return the time when the last changes collecting was finished (the root status status changed to VcsRootStatus.Type.FINISHED) or null if no changes collecting is finished since server start
OperationRequestor	getLastRequestor()	Return the last requestor for checking for changes operation
RepositoryState	getLastUsedState()
VcsSupportCore	getVcsSupportCore()
boolean	isChangesCollectingLockObtained()
boolean	isPollingMode()
boolean	setExplicitModificationCheckInterval(Integer secondsInterval)
void	setStatus(VcsRootStatus.Type status)
void	startChangesCollectingInLock(OperationRequestor requestor)	Set a requestor for the checking for changes procedure, also sets current VcsRootStatus status to STARTED Requires that VcsRootInstance is locked for changes collecting.
boolean	tryLockChangesCollecting()
boolean	tryLockChangesCollecting(int timeoutMillis)	Try lock changes collecting lock for specified number of seconds
void	unlockChangesCollecting()	Releases changes collection lock and marks VCS Root FINISHED

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.VcsRoot

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

Method Detail

setStatus

void setStatus(@NotNull
               VcsRootStatus.Type status)

compareAndSetStatus

boolean compareAndSetStatus(@NotNull
                            VcsRootStatus prevStatus,
                            @NotNull
                            VcsRootStatus.Type newStatus)

Sets new status only if current status is the same as prevStatus.

Parameters:

prevStatus - previous status

newStatus - new status

Returns:

true if status has been changed to new and false otherwise

startChangesCollectingInLock

void startChangesCollectingInLock(@NotNull
                                  OperationRequestor requestor)

Set a requestor for the checking for changes procedure, also sets current VcsRootStatus status to STARTED Requires that VcsRootInstance is locked for changes collecting.

Parameters:

requestor -

Since:

10.0

getLastRequestor

@NotNull
OperationRequestor getLastRequestor()

Return the last requestor for checking for changes operation

Returns:

setExplicitModificationCheckInterval

boolean setExplicitModificationCheckInterval(@Nullable
                                             Integer secondsInterval)

Parameters:

secondsInterval - new effective modification check interval in seconds, null to fallback to a user-defined value

Returns:

true if the value for the interval has actually been changed

getLastFinishChangesCollectingTime

@Nullable
Date getLastFinishChangesCollectingTime()

Return the time when the last changes collecting was finished (the root status status changed to VcsRootStatus.Type.FINISHED) or null if no changes collecting is finished since server start

Returns:

getVcsSupportCore

@NotNull
VcsSupportCore getVcsSupportCore()

getCurrentState

@NotNull
RepositoryState getCurrentState()
                         throws VcsException

Returns:

current state of this VCS root, should never be empty

Throws:

VcsException

Since:

7.1

getLastUsedState

@NotNull
RepositoryState getLastUsedState()

tryLockChangesCollecting

boolean tryLockChangesCollecting()
                          throws InterruptedException

Returns:

true if changes collection was locked

Throws:

InterruptedException

Since:

8.1

tryLockChangesCollecting

boolean tryLockChangesCollecting(int timeoutMillis)
                          throws InterruptedException

Try lock changes collecting lock for specified number of seconds

Parameters:

timeoutMillis - timeout in milliseconds

Returns:

true if lock was acquired

Throws:

InterruptedException - when thread was interrupted while trying to acquire the lock

unlockChangesCollecting

void unlockChangesCollecting()

Releases changes collection lock and marks VCS Root FINISHED

Since:

8.1

isChangesCollectingLockObtained

boolean isChangesCollectingLockObtained()

isPollingMode

boolean isPollingMode()