Package jetbrains.buildServer.serverSide.agentless

Class AgentlessBuildParametersProvider

java.lang.Object

jetbrains.buildServer.serverSide.parameters.AbstractBuildParametersProvider

jetbrains.buildServer.serverSide.agentless.AgentlessBuildParametersProvider

All Implemented Interfaces:

BuildStartContextProcessor, BuildParametersProvider, ServerExtension, TeamCityExtension

public class AgentlessBuildParametersProvider
extends AbstractBuildParametersProvider
implements BuildStartContextProcessor

Constructor Summary

Constructors

Constructor	Description
AgentlessBuildParametersProvider()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getParameters(SBuild build, boolean emulationMode)	Returns additional build parameters.
Collection<String>	getParametersAvailableOnAgent(SBuild build)	Returns collection of parameters (names) always available on the agent for the specified build.
void	updateParameters(BuildStartContext context)	This extension point is called before parameters are sent to a build agent.

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

getPrefix

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentlessBuildParametersProvider

public AgentlessBuildParametersProvider()

Method Detail

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

getParametersAvailableOnAgent

@NotNull
public Collection<String> getParametersAvailableOnAgent(@NotNull
                                                        SBuild build)

Description copied from interface: BuildParametersProvider

Returns collection of parameters (names) always available on the agent for the specified build. Because concrete values of these parameters are not known on the server side only names are returned. This collection may not contain parameters returned by BuildParametersProvider.getParameters(jetbrains.buildServer.serverSide.SBuild,boolean). To provide descriptions for the properties ParameterDescriptionProvider

Specified by:

getParametersAvailableOnAgent in interface BuildParametersProvider

Overrides:

getParametersAvailableOnAgent in class AbstractBuildParametersProvider

Parameters:

build - build

Returns:

see above

updateParameters

public void updateParameters(@NotNull
                             BuildStartContext context)

Description copied from interface: BuildStartContextProcessor

This extension point is called before parameters are sent to a build agent. Build context can be used to alter parameters of a build before data is sent to a build agent

Specified by:

updateParameters in interface BuildStartContextProcessor

Parameters:

context - context to update