Package jetbrains.buildServer.serverSide

Class RunTypeBase

    • 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 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 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 Map<String,​String> getDefaultRunnerProperties()
        Returns:
        default properties for this runner type

      • isSecureParameter

        public boolean isSecureParameter​(@NotNull
                                 String parameterName)
        Tells TeamCity whether the parameter with the specified name is secure and whether it's value should be stored in configuration files either in an encrypted form (or as a token). Note that all the parameters with Constants.SECURE_PROPERTY_PREFIX prefix are always considered secure, irregardless of what is returned by this method.
        Returns:
        true if the parameter value should be scrambled
        Since:
        2021.1

      • describeParameters

        @NotNull
public String describeParameters​(@NotNull
                                 Map<String,​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 List<Requirement> getRunnerSpecificRequirements​(@NotNull
                                                       Map<String,​String> runParameters)
        Returns specific requirements added by the runner.
        Parameters:
        runParameters - current configuration parameters.
        Returns:
        list of requirements.

      • processRunnerRequirements

        public void processRunnerRequirements​(@NotNull
                                      Map<String,​String> runParameters,
                                      @NotNull
                                      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

      • getTags

        @NotNull
public Set<String> getTags()
        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.
        Returns:
        tags describing the build runner in the user interface
        Since:
        2022.10

      • getIconUrl

        @Nullable
public String getIconUrl()
        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 the PluginDescriptor.getPluginResourcesPath(String) method. See also: https://plugins.jetbrains.com/docs/teamcity/plugins-packaging.html#Web+Resources+Packaging 
         {@code
        Returns:
        URL of the runner icon
        Since:
        2022.10