com.cloudbees.jenkins.plugins.customtools

Class CustomTool

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.tools.ToolInstallation>

hudson.tools.ToolInstallation

com.cloudbees.jenkins.plugins.customtools.CustomTool

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tools.ToolInstallation>, hudson.model.EnvironmentSpecific<CustomTool>, hudson.slaves.NodeSpecific<CustomTool>, Serializable

public class CustomTool
extends hudson.tools.ToolInstallation
implements hudson.slaves.NodeSpecific<CustomTool>, hudson.model.EnvironmentSpecific<CustomTool>

An arbitrary tool, which can add directories to the build's PATH

Author:

rcampbell

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomTool.DescriptorImpl

Nested classes/interfaces inherited from class hudson.tools.ToolInstallation

hudson.tools.ToolInstallation.ToolConverter

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
CustomTool(String name, String home, List properties, String exportedPaths, LabelSpecifics[] labelSpecifics, ToolVersionConfig toolVersion)

Method Summary

Methods

Modifier and Type	Method and Description
void	check() Checks consistency of the tool.
void	correctHome(PathsList pathList)
CustomTool	forBuildProperties(Map<hudson.model.JobPropertyDescriptor,hudson.model.JobProperty> properties)
CustomTool	forEnvironment(hudson.EnvVars environment)
CustomTool	forNode(hudson.model.Node node, hudson.model.TaskListener log)
List<LabelSpecifics>	getAppliedSpecifics(hudson.model.Node node) Get list of label specifics, which apply to the specified node.
String	getExportedPaths()
String	getHome()
LabelSpecifics[]	getLabelSpecifics()
protected PathsList	getPaths(hudson.model.Node node) Finds the directories to add to the path, for the given node.
ToolVersionConfig	getToolVersion()
boolean	hasVersions()

Methods inherited from class hudson.tools.ToolInstallation

all, buildEnvVars, getName, getProperties, readResolve, translate, translate, translateFor

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomTool

@DataBoundConstructor
public CustomTool(String name,
                               String home,
                               List properties,
                               String exportedPaths,
                               LabelSpecifics[] labelSpecifics,
                               ToolVersionConfig toolVersion)

Method Detail

getExportedPaths

public String getExportedPaths()

getToolVersion

public ToolVersionConfig getToolVersion()

hasVersions

public boolean hasVersions()

getHome

public String getHome()

Overrides:

getHome in class hudson.tools.ToolInstallation

correctHome

public void correctHome(PathsList pathList)

getLabelSpecifics

public LabelSpecifics[] getLabelSpecifics()

forEnvironment

public CustomTool forEnvironment(hudson.EnvVars environment)

Specified by:

forEnvironment in interface hudson.model.EnvironmentSpecific<CustomTool>

forNode

public CustomTool forNode(hudson.model.Node node,
                 hudson.model.TaskListener log)
                   throws IOException,
                          InterruptedException

Specified by:

forNode in interface hudson.slaves.NodeSpecific<CustomTool>

Throws:

IOException

InterruptedException

forBuildProperties

public CustomTool forBuildProperties(Map<hudson.model.JobPropertyDescriptor,hudson.model.JobProperty> properties)

check

public void check()
           throws CustomToolException

Checks consistency of the tool.

Throws:

CustomToolException - Validation error

getAppliedSpecifics

public List<LabelSpecifics> getAppliedSpecifics(hudson.model.Node node)

Get list of label specifics, which apply to the specified node.

Parameters:

node - Node to be checked

Returns:

List of the specifics to be applied

Since:

0.3

getPaths

protected PathsList getPaths(hudson.model.Node node)
                      throws IOException,
                             InterruptedException

Finds the directories to add to the path, for the given node. Uses Ant filesets to expand the patterns in the exportedPaths field.

Parameters:

node - where the tool has been installed

Returns:

a list of directories to add to the $PATH

Throws:

IOException

InterruptedException