Package hudson.tools

Class AbstractCommandInstaller

java.lang.Object

hudson.tools.ToolInstaller

hudson.tools.AbstractCommandInstaller

All Implemented Interfaces:

ExtensionPoint, Describable<ToolInstaller>

Direct Known Subclasses:

BatchCommandInstaller, CommandInstaller

public abstract class AbstractCommandInstaller
extends ToolInstaller

A generic script-based installer.

Since:

1.549

Author:

Oleg Nenashev

See Also:

• BatchCommandInstaller
• CommandInstaller

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractCommandInstaller.Descriptor<TInstallerClass extends AbstractCommandInstaller>

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

Modifier	Constructor	Description
protected	AbstractCommandInstaller(String label, String command, String toolHome)

Method Summary

Modifier and Type	Method	Description
String	getCommand()
abstract String[]	getCommandCall(FilePath script)	Retrieves a call for remote script caller.
abstract String	getCommandFileExtension()
String	getToolHome()
FilePath	performInstallation(ToolInstallation tool, Node node, TaskListener log)	Ensure that the configured tool is really installed.

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 Details

AbstractCommandInstaller

protected AbstractCommandInstaller(String label,
 String command,
 String toolHome)

Method Details

getCommand

public String getCommand()

getToolHome

public String getToolHome()

getCommandFileExtension

public abstract String getCommandFileExtension()

getCommandCall

public abstract String[] getCommandCall(FilePath script)

Retrieves a call for remote script caller.

performInstallation

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

Description copied from class: ToolInstaller

Ensure that the configured tool is really installed. If it is already installed, do nothing. Called only if ToolInstaller.appliesTo(Node) are true.

Specified by:

performInstallation in class ToolInstaller

Parameters:

tool - the tool being installed

node - the computer on which to install the tool

log - any status messages produced by the installation go here

Returns:

the (directory) path at which the tool can be found, typically coming from ToolInstaller.preferredLocation(hudson.tools.ToolInstallation, hudson.model.Node)

Throws:

IOException - if installation fails

InterruptedException - if communication with a agent is interrupted