jetbrains.buildServer.serverSide

Class RunTypeBase

java.lang.Object

jetbrains.buildServer.serverSide.RunTypeBase

Direct Known Subclasses:

RunType, RunTypeExtension, RunTypeWithExtensions

public abstract class RunTypeBase
extends java.lang.Object

Base interface for RunType and RunTypeExtension

Since:

5.1

Constructor Summary

Constructors

Constructor and Description
RunTypeBase()

Method Summary

Modifier and Type	Method and Description
java.lang.String	describeParameters(java.util.Map<java.lang.String,java.lang.String> parameters) This method is used when a short description of runner parameters needs to be shown to a user.
abstract java.util.Map<java.lang.String,java.lang.String>	getDefaultRunnerProperties()
abstract java.lang.String	getEditRunnerParamsJspFilePath()
abstract PropertiesProcessor	getRunnerPropertiesProcessor() Returns properties processor which will be used to validate parameters specified by user.
java.util.List<Requirement>	getRunnerSpecificRequirements(java.util.Map<java.lang.String,java.lang.String> runParameters) Returns specific requirements added by the runner.
abstract java.lang.String	getViewRunnerParamsJspFilePath()
void	processRunnerRequirements(java.util.Map<java.lang.String,java.lang.String> runParameters, java.util.List<Requirement> requirementsList) Process list of requirements and add new requirements to it or delete existing ones.

Methods inherited from class java.lang.Object

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

Constructor Detail

RunTypeBase

public RunTypeBase()

Method Detail

getRunnerPropertiesProcessor

@Nullable
public abstract PropertiesProcessor getRunnerPropertiesProcessor()

Returns properties processor which will be used to validate parameters specified by user.

Returns:

properties processor which operates with parameters specified for the runner.

getEditRunnerParamsJspFilePath

@Nullable
public abstract java.lang.String getEditRunnerParamsJspFilePath()

Returns:

absolute path to a JSP file or controller for editing runner parameters, should not include context path.

See Also:

PluginDescriptor.getPluginResourcesPath(String)

getViewRunnerParamsJspFilePath

@Nullable
public abstract java.lang.String getViewRunnerParamsJspFilePath()

Returns:

absolute path to a JSP file or controller for displaying runner parameters, should not include context path.

See Also:

PluginDescriptor.getPluginResourcesPath(String)

getDefaultRunnerProperties

@Nullable
public abstract java.util.Map<java.lang.String,java.lang.String> getDefaultRunnerProperties()

Returns:

default properties for this runner type

describeParameters

@NotNull
public java.lang.String describeParameters(@NotNull
                                                    java.util.Map<java.lang.String,java.lang.String> parameters)

This method is used when a short description of runner parameters needs to be shown to a user. The description returned by this method must be human readable, and must describe the most important runner settings. Description may have several lines of text separated by newline.

Parameters:

parameters - params to describe

Since:

6.0

getRunnerSpecificRequirements

@NotNull
public java.util.List<Requirement> getRunnerSpecificRequirements(@NotNull
                                                                          java.util.Map<java.lang.String,java.lang.String> runParameters)

Returns specific requirements added by the runner.

Parameters:

runParameters - current configuration parameters.

Returns:

list of requirements.

processRunnerRequirements

public void processRunnerRequirements(@NotNull
                                      java.util.Map<java.lang.String,java.lang.String> runParameters,
                                      @NotNull
                                      java.util.List<Requirement> requirementsList)

Process list of requirements and add new requirements to it or delete existing ones. The method was added to allow Docker support to remove custom requirements produced by other runners in a case when build will be executed in the virtual environment and requirements related to the files on disk are no longer relevant. The default implementation adds requirements from getRunnerSpecificRequirements(Map) to the target list

Parameters:

runParameters - current configuration parameters.

requirementsList - target list to modify

Since:

2018.1