Package jetbrains.buildServer.tools.impl

Class ParameterBasedToolsProvider

java.lang.Object

jetbrains.buildServer.tools.impl.ParameterBasedToolsProvider

All Implemented Interfaces:

ServerExtension, TeamCityExtension, ToolUsagesProvider

public abstract class ParameterBasedToolsProvider
extends Object
implements ToolUsagesProvider

Since:

2019.1

Author:

Maxim Zaytsev (maxim.zaytsev@jetbrains.com)

Constructor Summary

Constructors

Constructor	Description
ParameterBasedToolsProvider(ServerToolManager serverToolManager, DefaultToolFinder defaultToolFinder)

Method Summary

Modifier and Type	Method	Description
abstract String	getParameterName()
List<ToolVersion>	getRequiredTools(SRunningBuild build)	extension is called before starting build on agent.
abstract ToolType	getToolType()
abstract boolean	shouldSkipRunner(SBuildRunnerDescriptor runnerDescriptor)	invoked for each runner in the build.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterBasedToolsProvider

public ParameterBasedToolsProvider(@NotNull
                                   ServerToolManager serverToolManager,
                                   @NotNull
                                   DefaultToolFinder defaultToolFinder)

Method Detail

getParameterName

@NotNull
public abstract String getParameterName()

Returns:

parameter name which contains reference to tool version required by the runner

shouldSkipRunner

public abstract boolean shouldSkipRunner(SBuildRunnerDescriptor runnerDescriptor)

invoked for each runner in the build. Implementation can check the runner type/parameters/etc and return true for skip checking tool usages in current runner

Parameters:

runnerDescriptor - current runner

Returns:

true if tool provider should skip current runner

getToolType

@NotNull
public abstract ToolType getToolType()

Returns:

ToolType handled by implementation

getRequiredTools

public List<ToolVersion> getRequiredTools(@NotNull
                                          SRunningBuild build)

Description copied from interface: ToolUsagesProvider

extension is called before starting build on agent. If plugin uses tools for build the plugin should provide this list of ToolVersion used by the build

Specified by:

getRequiredTools in interface ToolUsagesProvider

Parameters:

build - starting build

Returns:

list of tools used by the build