Package jetbrains.buildServer.vcs

Interface SVcsRootEx

All Superinterfaces:

Comparable<SVcsRoot>, Loggable, LVcsRoot, SPersistentEntity, SVcsRoot, SVcsRootAccess, SVcsRootUpdate, SVcsRootUsages, VcsRoot

All Known Implementing Classes:

DeletedVcsRoot, InaccessibleVcsRoot, MockSVcsRoot, SecuredVcsRoot, SVcsRootImpl

public interface SVcsRootEx
extends SVcsRoot

Field Summary

Fields inherited from interface jetbrains.buildServer.vcs.VcsRoot

SECURE_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
BranchSpec	getBranchSpec(ValueResolver valueResolver)	Returns branch specification if it is defined in VCS root and can be fully resolved.
EntityId<Long>	getEntityId()
AuditLogAction	getLastConfigModificationAction()
ProjectEx	getProject()
boolean	isAliasExternalId(String extId)
boolean	isBranchSpecDefined(ValueResolver valueResolver)	Returns true if after the properties resolution this VCS root has not empty branch specification
boolean	isEmptyUuid()
void	sendExtIdChangedEvents(ConfigAction cause, String oldExtId, String newExtId)	Sends external id changed event.
void	setExternalId(ConfigAction cause, String externalId, boolean sendEvents)	Same as {SVcsRootUpdate.setExternalId(ConfigAction, String)} but provides control over events processing.
void	unregister()	Removes VCS root from project model but does not removes any configuration files from disk

Methods inherited from interface java.lang.Comparable

compareTo

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.serverSide.SPersistentEntity

createConfigAction, getConfigId, getConfigurationFile, getConfigurationFile, getExternalId, getName, getParent, getReadOnlyReason, getVersion, isReadOnly, isVirtual, markPersisted, persist, persist, remove, schedulePersisting, schedulePersisting, scheduleRemove

Methods inherited from interface jetbrains.buildServer.vcs.SVcsRoot

getModificationCheckInterval, isUseDefaultModificationCheckInterval

Methods inherited from interface jetbrains.buildServer.vcs.SVcsRootAccess

checkAccessibleFrom, checkAccessibleFrom, getAccessibleProjects, isAccessibleFrom, isAccessibleFrom

Methods inherited from interface jetbrains.buildServer.vcs.SVcsRootUpdate

moveToProject, moveToProject, persist, remove, restoreDefaultModificationCheckInterval, setExternalId, setExternalId, setModificationCheckInterval, setName, setProperties, setVcsName

Methods inherited from interface jetbrains.buildServer.vcs.SVcsRootUsages

getNumberOfUsagesInProjects, getScope, getUsages, getUsagesInConfigurations, getUsagesInProjects, isUsedInProjects

Methods inherited from interface jetbrains.buildServer.vcs.VcsRoot

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

Method Detail

getEntityId

@NotNull
EntityId<Long> getEntityId()

getProject

@NotNull
ProjectEx getProject()

Specified by:

getProject in interface SVcsRootUsages

Returns:

project this VCS root belongs to

unregister

void unregister()

Removes VCS root from project model but does not removes any configuration files from disk

getLastConfigModificationAction

@Nullable
AuditLogAction getLastConfigModificationAction()

getBranchSpec

@Nullable
BranchSpec getBranchSpec(@NotNull
                         ValueResolver valueResolver)

Returns branch specification if it is defined in VCS root and can be fully resolved. If branch spec is not defined or cannot be fully resolved returns null.

Parameters:

valueResolver - value resolver to use

Returns:

see above

isBranchSpecDefined

boolean isBranchSpecDefined(@NotNull
                            ValueResolver valueResolver)

Returns true if after the properties resolution this VCS root has not empty branch specification

Parameters:

valueResolver -

Returns:

isEmptyUuid

boolean isEmptyUuid()

Returns:

true if this root has an empty uuid in its config on disk

isAliasExternalId

boolean isAliasExternalId(@NotNull
                          String extId)

Returns:

true if the provided external id is an alias for the current external id of this VCS root

Since:

2021.1

setExternalId

void setExternalId(@NotNull
                   ConfigAction cause,
                   @NotNull
                   String externalId,
                   boolean sendEvents)
            throws DuplicateExternalIdException,
                   InvalidIdentifierException,
                   ObsoleteEntityException,
                   ReadOnlyEntityException

Same as {SVcsRootUpdate.setExternalId(ConfigAction, String)} but provides control over events processing. If parameter sendEvents is false, then no events about changing of the external id will be sent. This mode can be useful if the events will be sent later, for instance, in case of bulk edit ids operation.

Parameters:

cause -

externalId -

sendEvents -

Throws:

DuplicateExternalIdException

InvalidIdentifierException

ObsoleteEntityException

ReadOnlyEntityException

sendExtIdChangedEvents

void sendExtIdChangedEvents(@NotNull
                            ConfigAction cause,
                            @NotNull
                            String oldExtId,
                            @NotNull
                            String newExtId)

Sends external id changed event.

Parameters:

cause -

oldExtId -

newExtId -