Package io.jenkins.plugins.extratoolinstallers.installers

Class IsAlreadyOnPath

java.lang.Object

hudson.tools.ToolInstaller

io.jenkins.plugins.extratoolinstallers.installers.IsAlreadyOnPath

All Implemented Interfaces:

ExtensionPoint, Describable<ToolInstaller>

public class IsAlreadyOnPath
extends ToolInstaller

A ToolInstaller that locates an existing tool on the agent, or fails.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IsAlreadyOnPath.DescriptorImpl	Descriptor for IsAlreadyOnPath.

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

ToolInstaller.ToolInstallerEntry, ToolInstaller.ToolInstallerList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.tools.ToolInstaller

tool

Constructor Summary

Constructors

Constructor	Description
IsAlreadyOnPath(String label)	Constructor that sets mandatory fields.

Method Summary

Modifier and Type	Method	Description
String	getExecutableName()	Name of the executable we are to locate.
String	getRelativePath()	Directory of the tool's "home", relative to wherever we found the command on the path.
String[]	getVersionCmd()	Command we run in order to test what version we've got.
String	getVersionCmdString()	See getVersionCmd().
String	getVersionMax()	The maximum version acceptable.
String	getVersionMin()	The minimum version acceptable.
Pattern	getVersionPattern()	The regular expression used to parse the output from running getVersionCmd().
String	getVersionPatternString()	The regular expression used to parse the output from running getVersionCmd().
FilePath	performInstallation(ToolInstallation tool, Node node, TaskListener log)
void	setExecutableName(String executable)	Sets getExecutableName().
void	setRelativePath(String relativePath)	Sets getRelativePath().
void	setVersionCmd(String[] versionCmd)	Sets getVersionCmd().
void	setVersionCmdString(String versionCmdString)	See setVersionCmd(String[]).
void	setVersionMax(String versionMax)	Sets getVersionMax().
void	setVersionMin(String versionMin)	Sets getVersionMin().
void	setVersionPattern(Pattern versionPattern)	Sets getVersionPatternString() and getVersionPattern().
void	setVersionPatternString(String versionPatternString)	Sets getVersionPatternString() and getVersionPattern().

Methods inherited from class hudson.tools.ToolInstaller

appliesTo, getDescriptor, getLabel, preferredLocation, setTool

Methods inherited from class java.lang.Object

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

Constructor Detail

IsAlreadyOnPath

@DataBoundConstructor
public IsAlreadyOnPath(String label)

Constructor that sets mandatory fields.

Parameters:

label - The ToolInstaller.getLabel().

Method Detail

getExecutableName

@CheckForNull
public String getExecutableName()

Name of the executable we are to locate.

Returns:

Name, or null if none has been set.

setExecutableName

@DataBoundSetter
public void setExecutableName(@Nullable
                              String executable)

Sets getExecutableName().

Parameters:

executable - New value.

getRelativePath

@CheckForNull
public String getRelativePath()

Directory of the tool's "home", relative to wherever we found the command on the path.

Returns:

The relative path, or null if none has been set (which means ".").

setRelativePath

@DataBoundSetter
public void setRelativePath(@Nullable
                            String relativePath)

Sets getRelativePath().

Parameters:

relativePath - New value.

getVersionCmd

@CheckForNull
public String[] getVersionCmd()

Command we run in order to test what version we've got.

Returns:

null if not set, else a list where the first element is the command and the remaining elements are arguments for the command.

getVersionCmdString

@NonNull
public String getVersionCmdString()

See getVersionCmd().

Returns:

getVersionCmd() as a multi-line string.

setVersionCmd

public void setVersionCmd(String[] versionCmd)

Sets getVersionCmd().

Parameters:

versionCmd - New value.

setVersionCmdString

@DataBoundSetter
public void setVersionCmdString(String versionCmdString)

See setVersionCmd(String[]).

Parameters:

versionCmdString - New value as multi-line string.

getVersionPattern

public Pattern getVersionPattern()

The regular expression used to parse the output from running getVersionCmd().

Returns:

The regex that was set, or null if not set to a valid value.

setVersionPattern

public void setVersionPattern(Pattern versionPattern)

Sets getVersionPatternString() and getVersionPattern().

Parameters:

versionPattern - New value.

getVersionPatternString

@CheckForNull
public String getVersionPatternString()

The regular expression used to parse the output from running getVersionCmd().

Returns:

The regex that was set, or null if not set.

setVersionPatternString

@DataBoundSetter
public void setVersionPatternString(String versionPatternString)

Sets getVersionPatternString() and getVersionPattern().

Parameters:

versionPatternString - New value.

getVersionMin

@CheckForNull
public String getVersionMin()

The minimum version acceptable.

Returns:

The version that was set, or null if not set.

setVersionMin

@DataBoundSetter
public void setVersionMin(String versionMin)

Sets getVersionMin().

Parameters:

versionMin - New value.

getVersionMax

@CheckForNull
public String getVersionMax()

The maximum version acceptable.

Returns:

The version that was set, or null if not set.

setVersionMax

@DataBoundSetter
public void setVersionMax(String versionMax)

Sets getVersionMax().

Parameters:

versionMax - New value.

performInstallation

public FilePath performInstallation(@NonNull
                                    ToolInstallation tool,
                                    @NonNull
                                    Node node,
                                    @CheckForNull
                                    TaskListener log)
                             throws IOException,
                                    InterruptedException

Specified by:

performInstallation in class ToolInstaller

Throws:

IOException

InterruptedException