Package jetbrains.buildServer.agent.impl

Class AgentBuildSettingsImpl

java.lang.Object

jetbrains.buildServer.agent.impl.AgentBuildSettingsImpl

All Implemented Interfaces:

AgentBuildSettings, AgentBuildSettingsEx

public class AgentBuildSettingsImpl
extends Object
implements AgentBuildSettingsEx

Author:

Eugene Petrenko Created: 04.06.2010 13:51:06

Constructor Summary

Constructors

Constructor	Description
AgentBuildSettingsImpl(AgentBuild agentBuild, BuildAgentConfiguration configuration, BuildProgressLogger logger, BuildParametersMapsFactory mapsFactory, PasswordReplacer passwordReplacer)

Method Summary

Modifier and Type	Method	Description
void	cleanParameters()
String	getAccessCode()	Returns build access code used to download artifacts
String	getAccessUser()	Get user name to be used to execute authenticated requests on behalf of build to TeamCity server.
BuildAgentConfiguration	getAgentConfiguration()	Build agent configuration of the build agent.
File	getAgentTempDirectory()	Returns temporary directory which has the same lifecycle as build temporary directory.
List<ArtifactDependencyInfo>	getArtifactDependencies()	Returns artifact dependencies
Map<String,String>	getArtifactStorageSettings()
String	getBuildCurrentVersion(VcsRoot vcsRoot)	Returns current version of the specified VCS root
long	getBuildId()	Returns id of the build
BuildProgressLogger	getBuildLogger()	Returns logger which can be used to log messages to the build log on server.
String	getBuildPreviousVersion(VcsRoot vcsRoot)	Returns previous version of the specified VCS root
List<BuildRunnerSettings>	getBuildRunners()
File	getBuildTempDirectory()	Returns build temporary directory.
String	getBuildTypeExternalId()	Returns external build configuration id
String	getBuildTypeId()	Returns internal build configuration id
String	getBuildTypeName()	Returns name of build configuration (on the moment of build starting)
<T> T	getBuildTypeOptionValue(Option<T> option)	Returns value of the specified build configuration option
AgentBuild.CheckoutType	getCheckoutType()	Returns Checkout Type that was sent by server in the settings of the build.
long	getCleanCheckoutEnforcedBuildId()
File	getDefaultCheckoutDirectory()	Deprecated.
long	getExecutionTimeoutMinutes()	Returns build execution timeout in minutes, 0 indicates that there is no limit
FullCheckoutFlag	getFullCheckoutFlag()
String	getOwnerNodeId()
Map<String,String>	getParametersSpecMap()	Returns a map of parameters spec strings.
PasswordReplacer	getPasswordReplacer()
List<VcsChangeInfo>	getPersonalVcsChanges()	Returns list of changed files modified in personal changelist (if build is non personal returns empty list)
String	getProjectName()	Returns name of the project (on the moment of build starting)
String	getUnresolvedArtifactPaths()
String	getUnresolvedBuildCheckoutDirectory()
Collection<BuildFeatureInfo>	getUnresolvedBuildFeatures()
Map<String,String>	getUnresolvedBuildParameters()
Map<String,String>	getUnresolvedConfigParameters()
List<BuildRunnerData>	getUnresolvedRunnersSettings()
Map<String,String>	getUnresolvedServerParameters()
Collection<String>	getUserDefinedReferences()
Collection<String>	getUserParameterNames()
List<VcsChangeInfo>	getVcsChanges()	Returns list of changed files in this build (excluding files modified in personal changelist if build is personal)
List<VcsRootEntry>	getVcsRootEntries()	Returns VCS root entries associated with this build, i.e.
String	getVcsSettingsHashForCheckoutMode(AgentCheckoutMode agentCheckoutMode)	Returns vcs settings hash for the specified checkout mode, see AgentRunningBuild.getEffectiveCheckoutMode() This hash is used as a default checkout directory name if explicit checkout directory is not defined.
boolean	isCheckoutOnAgent()	Returns true if AgentBuildSettings.getCheckoutType() returns AgentBuild.CheckoutType.ON_AGENT Since 10.0, this method may return false even if checkout will be performed on Agent.
boolean	isCheckoutOnServer()	Returns true if AgentBuildSettings.getCheckoutType() returns AgentBuild.CheckoutType.ON_SERVER Since 10.0, this method may return false even if checkout will be performed on Server.
boolean	isCleanBuild()	Returns true if files should be cleaned before build
boolean	isCustomCheckoutDirectory()	Returns true if custom checkout directory is specified.
boolean	isPersonal()	Returns true if build is personal
boolean	isPersonalPatchAvailable()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgentBuildSettingsImpl

public AgentBuildSettingsImpl(@NotNull
                              AgentBuild agentBuild,
                              @NotNull
                              BuildAgentConfiguration configuration,
                              @NotNull
                              BuildProgressLogger logger,
                              @NotNull
                              BuildParametersMapsFactory mapsFactory,
                              @NotNull
                              PasswordReplacer passwordReplacer)

Method Detail

getBuildId

public final long getBuildId()

Description copied from interface: AgentBuildSettings

Returns id of the build

Specified by:

getBuildId in interface AgentBuildSettings

Returns:

build id

isCleanBuild

public final boolean isCleanBuild()

Description copied from interface: AgentBuildSettings

Returns true if files should be cleaned before build

Specified by:

isCleanBuild in interface AgentBuildSettings

Returns:

see above

isPersonal

public final boolean isPersonal()

Description copied from interface: AgentBuildSettings

Returns true if build is personal

Specified by:

isPersonal in interface AgentBuildSettings

Returns:

see above

isPersonalPatchAvailable

public final boolean isPersonalPatchAvailable()

Specified by:

isPersonalPatchAvailable in interface AgentBuildSettings

Returns:

true if this personal build has personal patch.

isCheckoutOnAgent

public final boolean isCheckoutOnAgent()

Description copied from interface: AgentBuildSettings

Returns true if AgentBuildSettings.getCheckoutType() returns AgentBuild.CheckoutType.ON_AGENT Since 10.0, this method may return false even if checkout will be performed on Agent. It is possible if checkout type setting is set to AUTO and is resolved to the Agent-Side checkout.

Specified by:

isCheckoutOnAgent in interface AgentBuildSettings

See Also:

AgentBuildSettings.getCheckoutType()

isCheckoutOnServer

public final boolean isCheckoutOnServer()

Description copied from interface: AgentBuildSettings

Returns true if AgentBuildSettings.getCheckoutType() returns AgentBuild.CheckoutType.ON_SERVER Since 10.0, this method may return false even if checkout will be performed on Server. It is possible if checkout type setting is set to AUTO and is resolved to the Server-Side checkout.

Specified by:

isCheckoutOnServer in interface AgentBuildSettings

See Also:

AgentBuildSettings.getCheckoutType()

getCheckoutType

@NotNull
public AgentBuild.CheckoutType getCheckoutType()

Description copied from interface: AgentBuildSettings

Returns Checkout Type that was sent by server in the settings of the build.

Specified by:

getCheckoutType in interface AgentBuildSettings

See Also:

AgentRunningBuild.getEffectiveCheckoutMode()

getExecutionTimeoutMinutes

public final long getExecutionTimeoutMinutes()

Description copied from interface: AgentBuildSettings

Returns build execution timeout in minutes, 0 indicates that there is no limit

Specified by:

getExecutionTimeoutMinutes in interface AgentBuildSettings

Returns:

build execution timeout

getPasswordReplacer

@NotNull
public PasswordReplacer getPasswordReplacer()

Specified by:

getPasswordReplacer in interface AgentBuildSettingsEx

Returns:

instance of PasswordReplacer which can be used to replace passwords known to current build in different logs or files

getArtifactDependencies

@NotNull
public final List<ArtifactDependencyInfo> getArtifactDependencies()

Description copied from interface: AgentBuildSettings

Returns artifact dependencies

Specified by:

getArtifactDependencies in interface AgentBuildSettings

Returns:

artifact dependencies

getAccessUser

@NotNull
public String getAccessUser()

Description copied from interface: AgentBuildSettings

Get user name to be used to execute authenticated requests on behalf of build to TeamCity server. For password see AgentBuildSettings.getAccessCode()

Specified by:

getAccessUser in interface AgentBuildSettings

Returns:

user name

See Also:

AgentBuildSettings.getAccessCode()

getAccessCode

@NotNull
public final String getAccessCode()

Description copied from interface: AgentBuildSettings

Returns build access code used to download artifacts

Specified by:

getAccessCode in interface AgentBuildSettings

Returns:

build access code

See Also:

AgentBuildSettings.getAccessUser()

getVcsRootEntries

@NotNull
public final List<VcsRootEntry> getVcsRootEntries()

Description copied from interface: AgentBuildSettings

Returns VCS root entries associated with this build, i.e. build configuration VCS root entries on the moment of build starting.

Specified by:

getVcsRootEntries in interface AgentBuildSettings

Returns:

see above

getBuildCurrentVersion

public final String getBuildCurrentVersion(@NotNull
                                           VcsRoot vcsRoot)

Description copied from interface: AgentBuildSettings

Returns current version of the specified VCS root

Specified by:

getBuildCurrentVersion in interface AgentBuildSettings

Parameters:

vcsRoot - VCS root

Returns:

see above

getBuildPreviousVersion

public final String getBuildPreviousVersion(@NotNull
                                            VcsRoot vcsRoot)

Description copied from interface: AgentBuildSettings

Returns previous version of the specified VCS root

Specified by:

getBuildPreviousVersion in interface AgentBuildSettings

Parameters:

vcsRoot - VCS root

Returns:

see above

getBuildTypeId

@NotNull
public final String getBuildTypeId()

Description copied from interface: AgentBuildSettings

Returns internal build configuration id

Specified by:

getBuildTypeId in interface AgentBuildSettings

Returns:

internal build configuration id

getBuildTypeExternalId

@NotNull
public String getBuildTypeExternalId()

Description copied from interface: AgentBuildSettings

Returns external build configuration id

Specified by:

getBuildTypeExternalId in interface AgentBuildSettings

Returns:

external build configuration id

isCustomCheckoutDirectory

public final boolean isCustomCheckoutDirectory()

Description copied from interface: AgentBuildSettings

Returns true if custom checkout directory is specified.

Specified by:

isCustomCheckoutDirectory in interface AgentBuildSettings

Returns:

true if custom checkout directory is specified

getVcsChanges

@NotNull
public final List<VcsChangeInfo> getVcsChanges()

Description copied from interface: AgentBuildSettings

Returns list of changed files in this build (excluding files modified in personal changelist if build is personal)

Specified by:

getVcsChanges in interface AgentBuildSettings

Returns:

list of changed files in this build (excluding personal changes)

getPersonalVcsChanges

@NotNull
public final List<VcsChangeInfo> getPersonalVcsChanges()

Description copied from interface: AgentBuildSettings

Returns list of changed files modified in personal changelist (if build is non personal returns empty list)

Specified by:

getPersonalVcsChanges in interface AgentBuildSettings

Returns:

list of changed files modified in personal changelist

getBuildTempDirectory

@NotNull
public final File getBuildTempDirectory()

Description copied from interface: AgentBuildSettings

Returns build temporary directory.

Before TeamCity 2023.05: it was cleaned before the build is started (after AgentLifeCycleListener.buildStarted(AgentRunningBuild), but before AgentLifeCycleListener.preparationFinished(AgentRunningBuild))

Since TeamCity 2023.05: it is created and cleaned before AgentLifeCycleListener.buildStarted(AgentRunningBuild) event

It is intended to be set as temporary folder for running build process. In general build process may do whatever it need with this directory contents. Consider using AgentBuildSettings.getAgentTempDirectory() to store temporary files that are created by any build running code on the build agent.

Specified by:

getBuildTempDirectory in interface AgentBuildSettings

Returns:

build temp dir

getAgentTempDirectory

@NotNull
public final File getAgentTempDirectory()

Description copied from interface: AgentBuildSettings

Returns temporary directory which has the same lifecycle as build temporary directory.

Before TeamCity 2023.05: it was cleaned before the build is started (after AgentLifeCycleListener.buildStarted(AgentRunningBuild), but before AgentLifeCycleListener.preparationFinished(AgentRunningBuild))

Since TeamCity 2023.05: it is created and cleaned before AgentLifeCycleListener.buildStarted(AgentRunningBuild) event

This directory is intended to be used to store any build-related files generated by the agent plugins. This folder is not intended to be used as build process temp directory.

Specified by:

getAgentTempDirectory in interface AgentBuildSettings

Returns:

see above

getBuildLogger

@NotNull
public final BuildProgressLogger getBuildLogger()

Description copied from interface: AgentBuildSettings

Returns logger which can be used to log messages to the build log on server.

Specified by:

getBuildLogger in interface AgentBuildSettings

Returns:

logger for various build messages

getAgentConfiguration

@NotNull
public final BuildAgentConfiguration getAgentConfiguration()

Description copied from interface: AgentBuildSettings

Build agent configuration of the build agent.

Specified by:

getAgentConfiguration in interface AgentBuildSettings

Returns:

build agent configuration of the build agent

getBuildTypeOptionValue

public final <T> T getBuildTypeOptionValue(@NotNull
                                           Option<T> option)

Description copied from interface: AgentBuildSettings

Returns value of the specified build configuration option

Specified by:

getBuildTypeOptionValue in interface AgentBuildSettings

Type Parameters:

T - type of the value

Parameters:

option - build configuration option

Returns:

value

getProjectName

public final String getProjectName()

Description copied from interface: AgentBuildSettings

Returns name of the project (on the moment of build starting)

Specified by:

getProjectName in interface AgentBuildSettings

Returns:

name of the project

getBuildTypeName

public final String getBuildTypeName()

Description copied from interface: AgentBuildSettings

Returns name of build configuration (on the moment of build starting)

Specified by:

getBuildTypeName in interface AgentBuildSettings

Returns:

name of build configuration

getUnresolvedBuildCheckoutDirectory

@NotNull
public String getUnresolvedBuildCheckoutDirectory()

Specified by:

getUnresolvedBuildCheckoutDirectory in interface AgentBuildSettingsEx

cleanParameters

public void cleanParameters()

Specified by:

cleanParameters in interface AgentBuildSettingsEx

getOwnerNodeId

@Nullable
public String getOwnerNodeId()

Specified by:

getOwnerNodeId in interface AgentBuildSettingsEx

getDefaultCheckoutDirectory

@Deprecated
@NotNull
public File getDefaultCheckoutDirectory()

Deprecated.

Specified by:

getDefaultCheckoutDirectory in interface AgentBuildSettings

Returns:

default checkout directory which will be used if custom checkout directory is not specified.

getUnresolvedArtifactPaths

public String getUnresolvedArtifactPaths()

Specified by:

getUnresolvedArtifactPaths in interface AgentBuildSettingsEx

getUnresolvedServerParameters

@NotNull
public Map<String,String> getUnresolvedServerParameters()

Specified by:

getUnresolvedServerParameters in interface AgentBuildSettingsEx

getUnresolvedBuildParameters

@NotNull
public Map<String,String> getUnresolvedBuildParameters()

Specified by:

getUnresolvedBuildParameters in interface AgentBuildSettingsEx

getUnresolvedConfigParameters

@NotNull
public Map<String,String> getUnresolvedConfigParameters()

Specified by:

getUnresolvedConfigParameters in interface AgentBuildSettingsEx

Returns:

server provided configuration parameters

getUnresolvedRunnersSettings

@NotNull
public List<BuildRunnerData> getUnresolvedRunnersSettings()

Specified by:

getUnresolvedRunnersSettings in interface AgentBuildSettingsEx

getUserParameterNames

@NotNull
public Collection<String> getUserParameterNames()

Specified by:

getUserParameterNames in interface AgentBuildSettingsEx

getUserDefinedReferences

@NotNull
public Collection<String> getUserDefinedReferences()

Specified by:

getUserDefinedReferences in interface AgentBuildSettingsEx

getFullCheckoutFlag

@NotNull
public FullCheckoutFlag getFullCheckoutFlag()

Specified by:

getFullCheckoutFlag in interface AgentBuildSettingsEx

getUnresolvedBuildFeatures

@NotNull
public Collection<BuildFeatureInfo> getUnresolvedBuildFeatures()

Specified by:

getUnresolvedBuildFeatures in interface AgentBuildSettingsEx

getVcsSettingsHashForCheckoutMode

@NotNull
public String getVcsSettingsHashForCheckoutMode(AgentCheckoutMode agentCheckoutMode)

Description copied from interface: AgentBuildSettings

Returns vcs settings hash for the specified checkout mode, see AgentRunningBuild.getEffectiveCheckoutMode() This hash is used as a default checkout directory name if explicit checkout directory is not defined.

Specified by:

getVcsSettingsHashForCheckoutMode in interface AgentBuildSettings

Parameters:

agentCheckoutMode - how checkout will be performed

getBuildRunners

@NotNull
public List<BuildRunnerSettings> getBuildRunners()

Specified by:

getBuildRunners in interface AgentBuildSettings

Returns:

list of build runners settings associated with this build

getParametersSpecMap

@NotNull
public Map<String,String> getParametersSpecMap()

Description copied from interface: AgentBuildSettingsEx

Returns a map of parameters spec strings. ParametersUtil could be used to create ControlDescription instance from a string. Specs should not change during the build. The map contain only those parameter keys which have a spec.

Specified by:

getParametersSpecMap in interface AgentBuildSettingsEx

getArtifactStorageSettings

@NotNull
public Map<String,String> getArtifactStorageSettings()

Specified by:

getArtifactStorageSettings in interface AgentBuildSettingsEx

getCleanCheckoutEnforcedBuildId

public long getCleanCheckoutEnforcedBuildId()

Specified by:

getCleanCheckoutEnforcedBuildId in interface AgentBuildSettingsEx