jetbrains.buildServer.serverSide.parameters

Interface BuildParametersProvider

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

AbstractBuildParametersProvider

@UserImplemented(adapterClass=AbstractBuildParametersProvider.class)
public interface BuildParametersProvider
extends ServerExtension

This extension allows to add additional parameters available for a build. These parameters can be system properties, environment variables or configuration parameters. Configuration parameters provided by this extension can then be used in references. System properties and environment variables will be passed to an agent and then to a build. It is recommended to extend AbstractBuildParametersProvider rather then implement this interface directly. To provide descriptions for the properties ParameterDescriptionProvider

Since:

5.0

Author:

Yegor.Yarko

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getParameters(SBuild build, boolean emulationMode) Returns additional build parameters.
java.util.Collection<java.lang.String>	getParametersAvailableOnAgent(SBuild build) Returns collection of parameters (names) always available on the agent for the specified build.

Method Detail

getParameters

@NotNull
java.util.Map<java.lang.String,java.lang.String> getParameters(@NotNull
                                                                        SBuild build,
                                                                        boolean emulationMode)

Returns additional build parameters.

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. For example, emulation mode is used to show parameters available for a build configuration in the web UI.

Returns:

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

getParametersAvailableOnAgent

@NotNull
java.util.Collection<java.lang.String> getParametersAvailableOnAgent(@NotNull
                                                                              SBuild build)

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 getParameters(jetbrains.buildServer.serverSide.SBuild,boolean). To provide descriptions for the properties ParameterDescriptionProvider

Parameters:

build - build

Returns:

see above

Since:

5.0