Package jetbrains.buildServer.serverSide.agentTypes

Class DeadAgentType

java.lang.Object

jetbrains.buildServer.serverSide.agentTypes.DeadAgentType

All Implemented Interfaces:

AgentDescription, AgentType

public class DeadAgentType
extends Object
implements AgentType

This agent type is used for creating an instance of BuildAgent when there is no real agent type.

Since:

9.0

Author:

Leonid Bushuev from JetBrains

Field Summary

Fields

Modifier and Type	Field	Description
static DeadAgentType	INSTANCE

Method Summary

Modifier and Type	Method	Description
int	getAgentPoolId()
int	getAgentTypeId()
AgentTypeKey	getAgentTypeKey()
Map<String,String>	getAvailableParameters()	Returns map of parameters available on the agent.
String	getAvailableParameterValue(String parameterName)	Returns value of a single available parameter.
Set<String>	getAvailableRunTypeIds()	Returns set of runner types available on the agent
List<RunType>	getAvailableRunTypes()	Returns list of runners available on the agent
List<String>	getAvailableVcsPlugins()
Map<String,String>	getBuildParameters()	Returns map of build parameters that will be added to the build parameters when build is started on the agent.
Map<String,String>	getConfigurationParameters()	Returns map of configuration parameters that are defined on the build agent.
int	getCpuBenchmarkIndex()	Returns this agent CPU benchmark index.
int	getCpuCount()	Returns the number of CPUs of this agent
Map<String,String>	getDefinedParameters()	Returns map of parameters explicitly defined in the agent configuration file.
String	getOperatingSystemName()	Returns name of the operating system where the agent is currently running.
AgentTypePolicy	getPolicy()
boolean	isCaseInsensitiveEnvironment()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final DeadAgentType INSTANCE

Method Detail

getAvailableRunTypes

@NotNull
public List<RunType> getAvailableRunTypes()

Description copied from interface: AgentDescription

Returns list of runners available on the agent

Specified by:

getAvailableRunTypes in interface AgentDescription

Returns:

list of runners ordered by display name

getAvailableRunTypeIds

@NotNull
public Set<String> getAvailableRunTypeIds()

Description copied from interface: AgentDescription

Returns set of runner types available on the agent

Specified by:

getAvailableRunTypeIds in interface AgentDescription

Returns:

set of runner types

getAvailableVcsPlugins

@NotNull
public List<String> getAvailableVcsPlugins()

Specified by:

getAvailableVcsPlugins in interface AgentDescription

getOperatingSystemName

@NotNull
public String getOperatingSystemName()

Description copied from interface: AgentDescription

Returns name of the operating system where the agent is currently running.

Specified by:

getOperatingSystemName in interface AgentDescription

Returns:

name of the operating system where the agent is currently running.

getCpuBenchmarkIndex

public int getCpuBenchmarkIndex()

Description copied from interface: AgentDescription

Returns this agent CPU benchmark index. The higher this value the more powerful agent CPU.

Specified by:

getCpuBenchmarkIndex in interface AgentDescription

Returns:

CPU index or -1 if index is not available

getCpuCount

public int getCpuCount()

Description copied from interface: AgentDescription

Returns the number of CPUs of this agent

Specified by:

getCpuCount in interface AgentDescription

Returns:

number of CPUs or -1 if count is not available

getAvailableParameters

@NotNull
public Map<String,String> getAvailableParameters()

Description copied from interface: AgentDescription

Returns map of parameters available on the agent. These parameters include environment variables defined for the agent process as well as parameters defined in the agent configuration file.

Specified by:

getAvailableParameters in interface AgentDescription

Returns:

see above

getAvailableParameterValue

@Nullable
public String getAvailableParameterValue(@NotNull
                                         String parameterName)

Description copied from interface: AgentDescription

Returns value of a single available parameter. This is equivalent to {@link #getAvailableParameters().get(name)} but can work faster.

Specified by:

getAvailableParameterValue in interface AgentDescription

Parameters:

parameterName - name of the parameter

Returns:

see above

getDefinedParameters

@NotNull
public Map<String,String> getDefinedParameters()

Description copied from interface: AgentDescription

Returns map of parameters explicitly defined in the agent configuration file.

Specified by:

getDefinedParameters in interface AgentDescription

Returns:

see above

getConfigurationParameters

@NotNull
public Map<String,String> getConfigurationParameters()

Description copied from interface: AgentDescription

Returns map of configuration parameters that are defined on the build agent. Those parameters may be defined in agent configuration files or may be provided by agent plugins.

Specified by:

getConfigurationParameters in interface AgentDescription

Returns:

map of parameters

getBuildParameters

@NotNull
public Map<String,String> getBuildParameters()

Description copied from interface: AgentDescription

Returns map of build parameters that will be added to the build parameters when build is started on the agent. Keys in the map have prefixes Constants.SYSTEM_PREFIX or Constants.ENV_PREFIX

Specified by:

getBuildParameters in interface AgentDescription

Returns:

map of build parameters.

isCaseInsensitiveEnvironment

public boolean isCaseInsensitiveEnvironment()

Specified by:

isCaseInsensitiveEnvironment in interface AgentDescription

Returns:

true if names of environment variables are case insensitive

getAgentTypeId

public int getAgentTypeId()

Specified by:

getAgentTypeId in interface AgentType

getAgentTypeKey

@NotNull
public AgentTypeKey getAgentTypeKey()

Specified by:

getAgentTypeKey in interface AgentType

getAgentPoolId

public int getAgentPoolId()

Specified by:

getAgentPoolId in interface AgentType

getPolicy

@NotNull
public AgentTypePolicy getPolicy()

Specified by:

getPolicy in interface AgentType