Package jetbrains.buildServer.serverSide

Class AbstractBuildSettings

java.lang.Object

jetbrains.buildServer.serverSide.AbstractBuildSettings

All Implemented Interfaces:

BuildSettings, ReadOnlyBuildSettings, ReadOnlyUserParameters

Direct Known Subclasses:

ExtensibleBuildSettings

public abstract class AbstractBuildSettings
extends Object
implements BuildSettings

Provides information about build settings. Read-only.

Since:

7.0

Author:

Leonid.Bushuev

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALLOW_ANY_CHARS_KEY
static Set<String>	ALWAYS_AVAILABLE_PARAMETERS
protected Filter<SArtifactDependency>	ENABLED_ARTIFACT_DEPENDENCIES_FILTER
protected Filter<Requirement>	ENABLED_REQUIREMENTS_FILTER
protected Filter<ParametersDescriptor>	ENABLED_SETTINGS_FILTER
static String	TEAMCITY_INTERNAL_PARAMETER_PREFIX

Constructor Summary

Constructors

Constructor	Description
AbstractBuildSettings()

Method Summary

Modifier and Type	Method	Description
protected void	computeArtifactDependencyDigest(ArtifactDependency dep, MessageDigest md)
static Map<String,SettingDescription>	computeUndefinedParameters(Map<String,SettingDescription> referencedParamsMap, Supplier<ParametersProvider> parametersProviderSupplier)
boolean	equals(Object obj)
SBuildStepsCollection	getAllBuildRunners()
List<SArtifactDependency>	getArtifactDependencies()
String	getArtifactPaths()	Provides with build artifact paths.
Collection<SBuildFeatureDescriptor>	getBuildFeatures()	Returns enabled build features.
Collection<SBuildFeatureDescriptor>	getBuildFeaturesOfType(String featureType)	Returns unresolved enabled build features of specified type
List<Requirement>	getBuildFeaturesRequirements()
String	getBuildNumberPattern()
Collection<? extends SBuildStepDescriptor>	getBuildRunners()	Returns enabled build runners.
String	getCheckoutDirectory()	Returns build checkout directory - if specified explicitly.
BuildTypeDescriptor.CheckoutType	getCheckoutType()	Returns method used by agent to retrieve project sources.
byte[]	getDigest()	Returns digest of settings, i.e.
String	getLabelPattern()
<T> T	getOption(Option<T> option)
ReadOnlyOptionSupport	getOptions()	Build options.
Parameter	getParameter(String paramName)
Map<String,String>	getParameters()	Returns map of build and configuration parameters.
Map<String,String>	getParametersAvailableOnAgents()	The method returns map of parameters which will be available on the agents for the current build.
Collection<Parameter>	getParametersCollection()	Returns build and configuration parameters in single collection.
String	getParameterValue(String paramName)
abstract ReadOnlyBuildTypeSettings	getParentSettings()
Map<String,SettingDescription>	getReferencedParameters()
List<Requirement>	getRequirements()	Get list of explicit requirements for build agents which can run this build configuration.
List<Requirement>	getRunnersRequirements()
Map<String,SettingDescription>	getUndefinedParameters()	Computes all undefined parameters based on current settings.
List<VcsRootEntry>	getVcsRootEntries()	Returns VCS root entries associated with this build, i.e.
int	hashCode()
boolean	isCompositeBuild()
static List<SArtifactDependency>	sortArtifactDependencies(List<SArtifactDependency> unsorted)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.buildServer.serverSide.ReadOnlyBuildSettings

getParametersProvider

Field Detail

TEAMCITY_INTERNAL_PARAMETER_PREFIX

public static final String TEAMCITY_INTERNAL_PARAMETER_PREFIX

See Also:

Constant Field Values

ALLOW_ANY_CHARS_KEY

public static final String ALLOW_ANY_CHARS_KEY

See Also:

Constant Field Values

ALWAYS_AVAILABLE_PARAMETERS

public static final Set<String> ALWAYS_AVAILABLE_PARAMETERS

ENABLED_SETTINGS_FILTER

protected final Filter<ParametersDescriptor> ENABLED_SETTINGS_FILTER

ENABLED_ARTIFACT_DEPENDENCIES_FILTER

protected final Filter<SArtifactDependency> ENABLED_ARTIFACT_DEPENDENCIES_FILTER

ENABLED_REQUIREMENTS_FILTER

protected final Filter<Requirement> ENABLED_REQUIREMENTS_FILTER

Constructor Detail

AbstractBuildSettings

public AbstractBuildSettings()

Method Detail

getVcsRootEntries

@NotNull
public List<VcsRootEntry> getVcsRootEntries()

Description copied from interface: ReadOnlyBuildSettings

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 ReadOnlyBuildSettings

Returns:

see above

getCheckoutType

@NotNull
public BuildTypeDescriptor.CheckoutType getCheckoutType()

Description copied from interface: ReadOnlyBuildSettings

Returns method used by agent to retrieve project sources. CheckoutType.ON_SERVER server creates patch and sends it to agent CheckoutType.ON_AGENT agent checks sources out CheckoutType.MANUAL script does it itself. This method returns actual checkout type, which may differ from the value set by #setCheckoutType(BuildTypeDescriptor.CheckoutType)

Specified by:

getCheckoutType in interface ReadOnlyBuildSettings

Returns:

method to get sources on agent.

getCheckoutDirectory

@Nullable
public String getCheckoutDirectory()

Description copied from interface: ReadOnlyBuildSettings

Returns build checkout directory - if specified explicitly. Returns null if default checkout directory, generated by TeamCity should be used.

Specified by:

getCheckoutDirectory in interface ReadOnlyBuildSettings

Returns:

build checkout directory

getArtifactDependencies

@NotNull
public List<SArtifactDependency> getArtifactDependencies()

Specified by:

getArtifactDependencies in interface ReadOnlyBuildSettings

Returns:

list of artifact dependencies.

getBuildRunners

@NotNull
public Collection<? extends SBuildStepDescriptor> getBuildRunners()

Description copied from interface: ReadOnlyBuildSettings

Returns enabled build runners.

Specified by:

getBuildRunners in interface BuildSettings

Specified by:

getBuildRunners in interface ReadOnlyBuildSettings

Returns:

build runners in the defined order.

getAllBuildRunners

@NotNull
public SBuildStepsCollection getAllBuildRunners()

Specified by:

getAllBuildRunners in interface BuildSettings

Returns:

preprocessed with extensions collection of build runners

getBuildFeatures

@NotNull
public Collection<SBuildFeatureDescriptor> getBuildFeatures()

Description copied from interface: ReadOnlyBuildSettings

Returns enabled build features.

Specified by:

getBuildFeatures in interface ReadOnlyBuildSettings

Returns:

collection of enabled build features.

getParametersAvailableOnAgents

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

Description copied from interface: ReadOnlyBuildSettings

The method returns map of parameters which will be available on the agents for the current build. Note: for some parameters value can be unknown at the moment of the call, so for them empty values will be returned

Specified by:

getParametersAvailableOnAgents in interface ReadOnlyBuildSettings

See Also:

BuildParametersProvider.getParametersAvailableOnAgent(SBuild)

getBuildFeaturesOfType

@NotNull
public Collection<SBuildFeatureDescriptor> getBuildFeaturesOfType(@NotNull
                                                                  String featureType)

Description copied from interface: ReadOnlyBuildSettings

Returns unresolved enabled build features of specified type

Specified by:

getBuildFeaturesOfType in interface ReadOnlyBuildSettings

Parameters:

featureType - feature type of interest

Returns:

see above

getOptions

@NotNull
public ReadOnlyOptionSupport getOptions()

Description copied from interface: BuildSettings

Build options.

Specified by:

getOptions in interface BuildSettings

Returns:

see above

getOption

@NotNull
public <T> T getOption(@NotNull
                       Option<T> option)

Specified by:

getOption in interface ReadOnlyBuildSettings

getParametersCollection

@NotNull
public Collection<Parameter> getParametersCollection()

Description copied from interface: ReadOnlyUserParameters

Returns build and configuration parameters in single collection.

Specified by:

getParametersCollection in interface ReadOnlyUserParameters

Returns:

see above

getParameterValue

@Nullable
public String getParameterValue(@NotNull
                                String paramName)

Specified by:

getParameterValue in interface ReadOnlyUserParameters

Parameters:

paramName - parameter name

Returns:

value of the parameter with given name or null if there is no such parameter

getParameters

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

Description copied from interface: ReadOnlyUserParameters

Returns map of build and configuration parameters.

Specified by:

getParameters in interface ReadOnlyUserParameters

Returns:

build and configuration parameters map

getParameter

@Nullable
public Parameter getParameter(@NotNull
                              String paramName)

Specified by:

getParameter in interface ReadOnlyUserParameters

getRequirements

@NotNull
public List<Requirement> getRequirements()

Description copied from interface: ReadOnlyBuildSettings

Get list of explicit requirements for build agents which can run this build configuration. Explicit requirements are specified by user in Web UI explicitly.

Specified by:

getRequirements in interface ReadOnlyBuildSettings

Returns:

see above

getRunnersRequirements

@NotNull
public List<Requirement> getRunnersRequirements()

Specified by:

getRunnersRequirements in interface ReadOnlyBuildSettings

Returns:

returns list of requirements imposed by runners.

getBuildFeaturesRequirements

@NotNull
public List<Requirement> getBuildFeaturesRequirements()

Specified by:

getBuildFeaturesRequirements in interface ReadOnlyBuildSettings

Returns:

returns list of requirements imposed by build features.

getArtifactPaths

@Nullable
public String getArtifactPaths()

Description copied from interface: ReadOnlyBuildSettings

Provides with build artifact paths. Artifact paths are comma separated paths to build artifacts. Support ant-style wildcards and target directories like *.zip => winFiles,unix/distro.tgz => linuxFiles, where winFiles and linuxFiles are target directories.

Specified by:

getArtifactPaths in interface ReadOnlyBuildSettings

Returns:

build artifact paths

getLabelPattern

@NotNull
public String getLabelPattern()

Specified by:

getLabelPattern in interface ReadOnlyBuildSettings

Returns:

Returns pattern to use for labeling

getUndefinedParameters

@NotNull
public Map<String,SettingDescription> getUndefinedParameters()

Description copied from interface: BuildSettings

Computes all undefined parameters based on current settings. Parameter is undefined if there is a reference to it in any of build settings and available parameters collection does not contain it.

Specified by:

getUndefinedParameters in interface BuildSettings

Returns:

see above

computeUndefinedParameters

@NotNull
public static Map<String,SettingDescription> computeUndefinedParameters(@NotNull
                                                                              Map<String,SettingDescription> referencedParamsMap,
                                                                              @NotNull
                                                                              Supplier<ParametersProvider> parametersProviderSupplier)

getReferencedParameters

@NotNull
public Map<String,SettingDescription> getReferencedParameters()

Specified by:

getReferencedParameters in interface BuildSettings

Returns:

all referenced parameters with description of the place where reference to parameter is specified.

getBuildNumberPattern

@NotNull
public String getBuildNumberPattern()

Specified by:

getBuildNumberPattern in interface ReadOnlyBuildSettings

Returns:

build number pattern

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDigest

@NotNull
public byte[] getDigest()

Description copied from interface: ReadOnlyBuildSettings

Returns digest of settings, i.e. some hash describing the settings state. If hashes are different then settings are considered different too.

Specified by:

getDigest in interface ReadOnlyBuildSettings

Returns:

see above

computeArtifactDependencyDigest

protected void computeArtifactDependencyDigest(@NotNull
                                               ArtifactDependency dep,
                                               @NotNull
                                               MessageDigest md)

sortArtifactDependencies

@NotNull
public static List<SArtifactDependency> sortArtifactDependencies(@NotNull
                                                                 List<SArtifactDependency> unsorted)

getParentSettings

@NotNull
public abstract ReadOnlyBuildTypeSettings getParentSettings()

Specified by:

getParentSettings in interface BuildSettings

Returns:

original build type settings used as base object for this build settings instance.

isCompositeBuild

public boolean isCompositeBuild()

Specified by:

isCompositeBuild in interface ReadOnlyBuildSettings

Returns:

true if these settings represent a composite build