Package jetbrains.buildServer.agent.impl.config

Interface AgentContext

All Known Subinterfaces:

AgentContextEx

All Known Implementing Classes:

AgentContextImpl

public interface AgentContext

Since:

6.0

Author:

Eugene Petrenko

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String key, String value)	Adds build wide configuration parameter.
void	addEnvironmentVariable(String key, String value)	Adds all-builds wide environment variable.
void	addSystemProperty(String key, String value)	Adds all-builds wide system property.
BuildParametersMap	getBuildParameters()	Returns build parameters.
Map<String,String>	getConfigurationParameters()	Returns configuration parameters of this build
boolean	removeConfigurationParameter(String key)	Remove build wide configuration parameter.

Method Detail

addSystemProperty

void addSystemProperty(@NotNull
                       String key,
                       @NotNull
                       String value)

Adds all-builds wide system property.

Creates build parameters with Constants.SYSTEM_PREFIX prefix

Modifications will be available for all builds on this agent

Parameters:

key -

value -

Since:

6.0

addEnvironmentVariable

void addEnvironmentVariable(@NotNull
                            String key,
                            @NotNull
                            String value)

Adds all-builds wide environment variable. Creates build parameters with Constants.ENV_PREFIX prefix

Note, on Windows machines environment size can be limited.

Modifications will be available for all builds on this agent

Parameters:

key - name, may be case sensitive or not depending on OS

value - value

Since:

6.0

addConfigurationParameter

void addConfigurationParameter(@NotNull
                               String key,
                               @NotNull
                               String value)

Adds build wide configuration parameter. Modifications will be available for all builds on this agent

Parameters:

key - name

value - value

Since:

6.0

removeConfigurationParameter

boolean removeConfigurationParameter(@NotNull
                                     String key)

Remove build wide configuration parameter.

Parameters:

key - name

Since:

2017.1

getBuildParameters

@NotNull
BuildParametersMap getBuildParameters()

Returns build parameters. Some of values may not be fully resolved.

Returns:

build-wide build parameters

Since:

6.0

getConfigurationParameters

@NotNull
Map<String,String> getConfigurationParameters()

Returns configuration parameters of this build

Returns:

unmodifiable configuration parameters map

Since:

6.0