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>, java.io.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

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

CustomTool(java.lang.String name, java.lang.String home, java.util.List properties, java.lang.String exportedPaths)

Method Summary

CustomTool	forEnvironment(hudson.EnvVars environment)
CustomTool	forNode(hudson.model.Node node, hudson.model.TaskListener log)
java.lang.String	getExportedPaths()
protected java.util.List<java.lang.String>	getPaths(hudson.model.Node node) Finds the directories to add to the path, for the given node.

Methods inherited from class hudson.tools.ToolInstallation

all, getHome, getName, getProperties, 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(java.lang.String name,
                                       java.lang.String home,
                                       java.util.List properties,
                                       java.lang.String exportedPaths)

Method Detail

getExportedPaths

public java.lang.String getExportedPaths()

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 java.io.IOException,
                          java.lang.InterruptedException

Specified by:

forNode in interface hudson.slaves.NodeSpecific<CustomTool>

Throws:

java.io.IOException

java.lang.InterruptedException

getPaths

protected java.util.List<java.lang.String> getPaths(hudson.model.Node node)
                                             throws java.io.IOException,
                                                    java.lang.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:

java.io.IOException

java.lang.InterruptedException