Package jetbrains.buildServer.agent.config

Interface AgentParametersSupplier

All Superinterfaces:

AgentExtension, TeamCityExtension

All Known Implementing Classes:

OsArchBitsDetector

public interface AgentParametersSupplier
extends AgentExtension

Agent parameters supplier. An implementation of this interface should be provided whenever the plugin wants to report some parameters discovered from the environment where the agent is running.

Since:

2022.10

Method Summary

Modifier and Type	Method	Description
default Map<String,String>	getEnvironmentVariables()	Report discovered environment variables.
default Map<String,String>	getParameters()	Report discovered parameters.
default Map<String,String>	getSystemProperties()	Report discovered system properties.

Method Detail

getParameters

default Map<String,String> getParameters()

Report discovered parameters. Allows agent plugins to report parameters.

On the agent's initialization, it will be plugged into the BuildAgentConfiguration

Will be executed before AgentLifeCycleListener.agentStarted(BuildAgent)

Returns:

parameters to be stored. Might include parameters from other clients. Can also be used to report environment variables and system properties, provided they're properly prefixed with Constants.ENV_PREFIX and Constants.SYSTEM_PREFIX, respectively

Since:

2022.10

getEnvironmentVariables

default Map<String,String> getEnvironmentVariables()

Report discovered environment variables. Allows agent plugins to report environment variables.

On the agent's initialization, it will be plugged into the BuildAgentConfiguration

Will be executed before AgentLifeCycleListener.agentStarted(BuildAgent)

Returns:

environment variables to be stored. Might include environment variables from other clients.

Since:

2022.10

getSystemProperties

default Map<String,String> getSystemProperties()

Report discovered system properties. Allows agent plugins to report system properties.

On the agent's initialization, it will be plugged into the BuildAgentConfiguration

Will be executed before AgentLifeCycleListener.agentStarted(BuildAgent)

Returns:

system properties to be stored. Might include system properties from other clients.

Since:

2022.10