Package jetbrains.buildServer.pipeline.impl

Class PipelineParametersProvider

java.lang.Object

jetbrains.buildServer.serverSide.parameters.AbstractBuildParametersProvider

jetbrains.buildServer.pipeline.impl.PipelineParametersProvider

All Implemented Interfaces:

BuildsCleanupExtension, BuildParametersProvider, ServerExtension, TeamCityExtension

@Component
public class PipelineParametersProvider
extends AbstractBuildParametersProvider
implements BuildsCleanupExtension

Used for Pipelines. Similar to DependencyParametersProvider. Used to resolve parameters from dependeny Jobs.

See Also:

DependencyParametersProvider

Field Summary

Fields

Modifier and Type	Field	Description
static String	JOB_REFERENCE_PREFIX

Constructor Summary

Constructors

Constructor	Description
PipelineParametersProvider()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getParameters(SBuild build, boolean emulationMode)	Returns additional build parameters.
String	getPrefix()

Methods inherited from class jetbrains.buildServer.serverSide.parameters.AbstractBuildParametersProvider

getParametersAvailableOnAgent

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.buildServer.serverSide.cleanup.BuildsCleanupExtension

cleanupBuildsData, getCleanupBuildsDataConcurrencyLevel, getDisplayName, prepareBuildsData

Field Detail

JOB_REFERENCE_PREFIX

public static final String JOB_REFERENCE_PREFIX

See Also:

Constant Field Values

Constructor Detail

PipelineParametersProvider

public PipelineParametersProvider()

Method Detail

getPrefix

@NotNull
public String getPrefix()

Specified by:

getPrefix in interface BuildParametersProvider

Overrides:

getPrefix in class AbstractBuildParametersProvider

Returns:

a common prefix used for all parameter names generated by this provider, returns empty string if there is no common prefix

getParameters

@NotNull
public Map<String,String> getParameters(@NotNull
                                              SBuild build,
                                              boolean emulationMode)

Description copied from interface: BuildParametersProvider

Returns additional build parameters.

Specified by:

getParameters in interface BuildParametersProvider

Overrides:

getParameters in class AbstractBuildParametersProvider

Parameters:

build - the build for which parameters should be added

emulationMode - if true then parameters are calculated in the emulation mode and provided build is a mock build. There are two cases when emulationMode is true:

• when a build for which we need to compute parameters is still in the queue
• when parameters should be calculated in a context of a build configuration when there is no build at all

in both of these cases a mock build will be passed to the getParameters() method, however in the first case the method BuildPromotionOwner.getBuildPromotion() will return an instance of a BuildPromotion which is in the queue (BuildPromotion.getQueuedBuild() will return a not null object), while in the second case a mock of BuildPromotion without any associated queued or started builds will be returned

Returns:

the map of the parameter name - parameter value pairs To provide descriptions for the properties ParameterDescriptionProvider