Class SimpleRunnerRunType
- java.lang.Object
-
- jetbrains.buildServer.serverSide.RunTypeBase
-
- jetbrains.buildServer.serverSide.RunType
-
- jetbrains.buildServer.runner.simpleRunner.SimpleRunnerRunType
-
- All Implemented Interfaces:
ExecutorModeSupport
,Describable
,RunTypeInfo
public class SimpleRunnerRunType extends RunType
- Author:
- Kir
-
-
Field Summary
-
Fields inherited from class jetbrains.buildServer.serverSide.RunType
RUN_TYPE_NAME_SIZE
-
-
Constructor Summary
Constructors Constructor Description SimpleRunnerRunType(RunTypeRegistry runTypeRegistry, PluginDescriptor pluginDescriptor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.java.util.Map<java.lang.String,java.lang.String>
getDefaultRunnerProperties()
java.lang.String
getDescription()
Returns short description which will be shown in the user interfacejava.lang.String
getDisplayName()
Returns name of this runner to show in UI.java.lang.String
getEditRunnerParamsJspFilePath()
java.lang.String
getIconUrl()
Returns a relative path to an icon of this build runner that is displayed in the Web UI.PropertiesProcessor
getRunnerPropertiesProcessor()
Returns properties processor which will be used to validate parameters specified by user.java.util.Set<java.lang.String>
getTags()
Returns tags describing this runner.java.lang.String
getType()
Returns runner type which should match the BuildRunner.getType.java.lang.String
getViewRunnerParamsJspFilePath()
-
Methods inherited from class jetbrains.buildServer.serverSide.RunTypeBase
getRunnerSpecificRequirements, isSecureParameter, processRunnerRequirements
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface jetbrains.buildServer.serverSide.agentless.ExecutorModeSupport
getSupportType
-
-
-
-
Constructor Detail
-
SimpleRunnerRunType
public SimpleRunnerRunType(@NotNull RunTypeRegistry runTypeRegistry, @NotNull PluginDescriptor pluginDescriptor)
-
-
Method Detail
-
getType
@NotNull public java.lang.String getType()
Description copied from class:RunType
Returns runner type which should match the BuildRunner.getType.- Specified by:
getType
in interfaceRunTypeInfo
- Specified by:
getType
in classRunType
- Returns:
- runner type, will be shown in Runners combobox and should match the BuildRunner.getType
The name is limited by
RunType.RUN_TYPE_NAME_SIZE
.
-
getDisplayName
@NotNull public java.lang.String getDisplayName()
Description copied from class:RunType
Returns name of this runner to show in UI.- Specified by:
getDisplayName
in interfaceDescribable
- Specified by:
getDisplayName
in interfaceRunTypeInfo
- Specified by:
getDisplayName
in classRunType
- Returns:
- see above
-
getDefaultRunnerProperties
@Nullable public java.util.Map<java.lang.String,java.lang.String> getDefaultRunnerProperties()
- Specified by:
getDefaultRunnerProperties
in classRunTypeBase
- Returns:
- default properties for this runner type
-
getDescription
@NotNull public java.lang.String getDescription()
Description copied from class:RunType
Returns short description which will be shown in the user interface- Specified by:
getDescription
in interfaceRunTypeInfo
- Specified by:
getDescription
in classRunType
- Returns:
- see above
-
getEditRunnerParamsJspFilePath
public java.lang.String getEditRunnerParamsJspFilePath()
- Specified by:
getEditRunnerParamsJspFilePath
in classRunTypeBase
- Returns:
- absolute path to a JSP file or controller for editing runner parameters, should not include context path.
- See Also:
PluginDescriptor.getPluginResourcesPath(String)
-
getRunnerPropertiesProcessor
public PropertiesProcessor getRunnerPropertiesProcessor()
Description copied from class:RunTypeBase
Returns properties processor which will be used to validate parameters specified by user.- Specified by:
getRunnerPropertiesProcessor
in classRunTypeBase
- Returns:
- properties processor which operates with parameters specified for the runner.
-
getViewRunnerParamsJspFilePath
public java.lang.String getViewRunnerParamsJspFilePath()
- Specified by:
getViewRunnerParamsJspFilePath
in classRunTypeBase
- Returns:
- absolute path to a JSP file or controller for displaying runner parameters, should not include context path.
- See Also:
PluginDescriptor.getPluginResourcesPath(String)
-
describeParameters
@NotNull public java.lang.String describeParameters(@NotNull java.util.Map<java.lang.String,java.lang.String> parameters)
Description copied from class:RunTypeBase
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.- Overrides:
describeParameters
in classRunTypeBase
- Parameters:
parameters
- params to describe
-
getTags
@NotNull public java.util.Set<java.lang.String> getTags()
Description copied from class:RunTypeBase
Returns tags describing this runner. The tags will be used to simplify searching for a runner supporting some technology or tool. Examples of the tags, are: java, .NET, javascript, and so on.- Overrides:
getTags
in classRunTypeBase
- Returns:
- tags describing the build runner in the user interface
-
getIconUrl
@Nullable public java.lang.String getIconUrl()
Description copied from class:RunTypeBase
Returns a relative path to an icon of this build runner that is displayed in the Web UI. It is recommended to use svg icons because they scale better. The icon file should be placed inside 'buildServerResources' folder of the plugin distribution package and then obtained using thePluginDescriptor.getPluginResourcesPath(String)
method. See also: https://plugins.jetbrains.com/docs/teamcity/plugins-packaging.html#Web+Resources+Packaging{@code
- Overrides:
getIconUrl
in classRunTypeBase
- Returns:
- URL of the runner icon
-
-