Package jetbrains.buildServer.vcs

Interface VcsRoot

All Superinterfaces:

Loggable

All Known Subinterfaces:

LVcsRoot, LVcsRootInstance, LVcsRootInstanceEx, SVcsRoot, SVcsRootEx, VcsRootInstance, VcsRootInstanceEx

All Known Implementing Classes:

DeletedVcsRoot, InaccessibleVcsRoot, MockSVcsRoot, SecuredVcsRoot, SVcsRootImpl, VcsRootImpl, VcsRootInstanceImpl, VcsRootInstanceWithParent, VcsServiceRoot

public interface VcsRoot
extends Loggable

Contains configuration settings of a configured version control root. VCS root settings are stored as a set of name value pairs (called properties). Names starting with "teamcity:" prefix are reserved for TeamCity internal usages. Names starting with SECURE_PROPERTY_PREFIX indicate that value of this property contains secure information, such properties are persisted in scrambled form.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SECURE_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
String	getExternalId()
long	getId()	returns root internal id
String	getName()	returns descriptive name of the vcs root
Map<String,String>	getProperties()	Returns mapping from a property name to its value
String	getProperty(String propertyName)	Provides specified property value
String	getProperty(String propertyName, String defaultValue)	Provides specified property value or default value if property is not defined
String	getVcsName()	Returns name of the corresponding version control.

Methods inherited from interface jetbrains.buildServer.log.Loggable

describe

Field Detail

SECURE_PROPERTY_PREFIX

@NonNls
static final String SECURE_PROPERTY_PREFIX

See Also:

Constant Field Values

Method Detail

getId

long getId()

returns root internal id

Returns:

see above

getName

@NotNull
String getName()

returns descriptive name of the vcs root

Returns:

see above

getVcsName

@NotNull
String getVcsName()

Returns name of the corresponding version control.

Returns:

name of the corresponding version control

getProperties

@NotNull
Map<String,String> getProperties()

Returns mapping from a property name to its value

Returns:

map of all defined properties

getProperty

@Nullable
String getProperty(@NotNull
                   String propertyName)

Provides specified property value

Parameters:

propertyName - name of the property whose value is requested

Returns:

value of a specified property

getProperty

@Nullable
@Contract("_,null->null;_,!null->!null")
String getProperty(@NotNull
                   String propertyName,
                   @Nullable
                   String defaultValue)

Provides specified property value or default value if property is not defined

Parameters:

propertyName - name of the property whose value is requested

defaultValue - default value which is returned if property value was not specified explicitly

Returns:

- value of a specified property or 'defaultValue' if it is not defined

getExternalId

@NotNull
String getExternalId()

Returns:

External VCS Root ID in VCS services and on build agent. If unset (in tests, for instance), empty string is returned.

Since:

2021.2