com.cloudbees.jenkins.plugins.customtools

Class CustomTool

java.lang.Object

hudson.model.AbstractDescribableImpl<ToolInstallation>

hudson.tools.ToolInstallation

com.cloudbees.jenkins.plugins.customtools.CustomTool

All Implemented Interfaces:

ExtensionPoint, Describable<ToolInstallation>, EnvironmentSpecific<CustomTool>, NodeSpecific<CustomTool>, Serializable

public class CustomTool
extends ToolInstallation
implements NodeSpecific<CustomTool>, EnvironmentSpecific<CustomTool>

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

Author:

rcampbell, Oleg Nenashev

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

ToolInstallation.ToolConverter

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
CustomTool(String name, String home, List<? extends ToolProperty<?>> properties, String exportedPaths, LabelSpecifics[] labelSpecifics, ToolVersionConfig toolVersion, String additionalVariables)

Method Summary

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

Methods inherited from class hudson.tools.ToolInstallation

all, buildEnvVars, getName, getProperties, readResolve, toString, 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, wait, wait, wait

Constructor Detail

CustomTool

@DataBoundConstructor
public CustomTool(@Nonnull
                                         String name,
                                         @CheckForNull
                                         String home,
                                         @CheckForNull
                                         List<? extends ToolProperty<?>> properties,
                                         @CheckForNull
                                         String exportedPaths,
                                         @CheckForNull
                                         LabelSpecifics[] labelSpecifics,
                                         @CheckForNull
                                         ToolVersionConfig toolVersion,
                                         @CheckForNull
                                         String additionalVariables)

Method Detail

getExportedPaths

@CheckForNull
public String getExportedPaths()

getToolVersion

@CheckForNull
public ToolVersionConfig getToolVersion()

Gets the tool version configuration.

Returns:

Tool version configuration or null if it is not configured.

hasVersions

public boolean hasVersions()

getHome

@CheckForNull
public String getHome()

Overrides:

getHome in class ToolInstallation

correctHome

public void correctHome(@Nonnull
                        PathsList pathList)

getLabelSpecifics

@Nonnull
public LabelSpecifics[] getLabelSpecifics()

hasAdditionalVariables

public boolean hasAdditionalVariables()

Check if the tool has additional environment variables set.

Returns:

true when the tool injects additional environment variables.

getAdditionalVariables

@CheckForNull
public String getAdditionalVariables()

forEnvironment

public CustomTool forEnvironment(EnvVars environment)

Specified by:

forEnvironment in interface EnvironmentSpecific<CustomTool>

forNode

@Nonnull
public CustomTool forNode(Node node,
                                    TaskListener log)
                             throws IOException,
                                    InterruptedException

Specified by:

forNode in interface NodeSpecific<CustomTool>

Throws:

IOException

InterruptedException

forBuildProperties

@Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public CustomTool forBuildProperties(Map<JobPropertyDescriptor,JobProperty> properties)

Deprecated.

check

public void check()
           throws CustomToolException

Checks the tool consistency.

Throws:

CustomToolException - Validation error

getAppliedSpecifics

@Nonnull
public List<LabelSpecifics> getAppliedSpecifics(@Nonnull
                                                          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

@Nonnull
protected PathsList getPaths(@Nonnull
                                       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 - Operation error

InterruptedException - Operation has been interrupted