com.rackspace.jenkins_nodepool

Class NodePoolJDKInstaller

java.lang.Object

hudson.tools.ToolInstaller

com.rackspace.jenkins_nodepool.NodePoolJDKInstaller

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tools.ToolInstaller>

Direct Known Subclasses:

NodePoolDebianOpenJDKInstaller, NodePoolJDKScriptInstaller

public abstract class NodePoolJDKInstaller
extends hudson.tools.ToolInstaller

An abstract base class for NodePool JDK installers. This class includes a few convenience methods and abstract method declarations for implementing classes to perform installations.

Generally, the `FilePath performInstallation(Node node, TaskListener tl, Connection connection)` method provides the installation implementation logic which leverages the connection to invoke required java installation commands on the remote NodePool slave instance.

Earlier implementations of derived classes include an Ubuntu OpenJDK installer and a more generic script installer which accepts an arbitrary script to run the installation (e.g. apt-get install openjdk-8-jre-headless -y).

Nested Class Summary

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

hudson.tools.ToolInstaller.ToolInstallerEntry, hudson.tools.ToolInstaller.ToolInstallerList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.tools.ToolInstaller

tool

Constructor Summary

Constructors

Constructor and Description
NodePoolJDKInstaller()
NodePoolJDKInstaller(String label) Creates a new NodePool JDK installer.

Method Summary

Modifier and Type	Method and Description
protected int	executeCommand(hudson.model.TaskListener log, hudson.Launcher launcher, String... commands) A simple wrapper method for launching a set of commands.
protected int	executeCommand(hudson.model.TaskListener log, hudson.Launcher launcher, String workingDir, String... commands) A simple wrapper method for launching a set of commands.
protected void	fine(hudson.model.TaskListener listener, String msg) Logs the specified message as Level.FINE to both the logger and the task listener.
String	getInstallWorkingDir() Returns the installation working directory for the installer (typically: /tmp).
abstract String	getJavaHome() Returns the Java home folder associated with this installation (value set by the implementation class).
protected static String	getTimestamp() Returns the formatted current time stamp.
protected void	info(hudson.model.TaskListener listener, String msg) Logs the specified message as Level.FINE to both the logger and the task listener.
boolean	isJavaInstalled(hudson.Launcher launcher, hudson.model.TaskListener tl) Routine to run a remote command to determine if java is installed (e.g.
protected void	log(Level lvl, hudson.model.TaskListener listener, String msg) Logs the specified message to both the logger and the task listener.
abstract hudson.FilePath	performInstallation(hudson.model.Node node, hudson.model.TaskListener tl, com.trilead.ssh2.Connection connection) Ensure that the configured tool is really installed.
hudson.FilePath	performInstallation(hudson.tools.ToolInstallation tool, hudson.model.Node node, hudson.model.TaskListener tl) Ensure that the configured tool is really installed.
void	setInstallWorkingDir(String installWorkingDir) Sets the installation working directory for the installer.
protected void	warn(hudson.model.TaskListener listener, String msg) Logs the specified message as Level.FINE to both the logger and the task listener.

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

NodePoolJDKInstaller

public NodePoolJDKInstaller()

NodePoolJDKInstaller

public NodePoolJDKInstaller(String label)

Creates a new NodePool JDK installer.

Parameters:

label - the label associated with this installer

Method Detail

getInstallWorkingDir

public String getInstallWorkingDir()

Returns the installation working directory for the installer (typically: /tmp).

Returns:

the installation working directory

setInstallWorkingDir

public void setInstallWorkingDir(String installWorkingDir)
                          throws IllegalArgumentException

Sets the installation working directory for the installer. The Default is typically: /tmp.

Parameters:

installWorkingDir - the installation working directory.

Throws:

IllegalArgumentException - if installWorkingDir is null or empty

getJavaHome

public abstract String getJavaHome()

Returns the Java home folder associated with this installation (value set by the implementation class).

Returns:

the Java home folder associated with this installation

performInstallation

public hudson.FilePath performInstallation(hudson.tools.ToolInstallation tool,
                                           hudson.model.Node node,
                                           hudson.model.TaskListener tl)
                                    throws IOException,
                                           InterruptedException

Ensure that the configured tool is really installed. If it is already installed, do nothing.

Specified by:

performInstallation in class hudson.tools.ToolInstaller

Parameters:

tool - the tool being installed

node - the computer on which to install the tool

tl - any status messages produced by the installation go here

Returns:

the (directory) path at which the tool can be found

Throws:

IOException - if the installation fails

InterruptedException - if communication with a agent is interrupted

performInstallation

public abstract hudson.FilePath performInstallation(hudson.model.Node node,
                                                    hudson.model.TaskListener tl,
                                                    com.trilead.ssh2.Connection connection)
                                             throws IOException,
                                                    InterruptedException

Ensure that the configured tool is really installed. If it is already installed, do nothing.

Parameters:

node - the computer on which to install the tool

tl - any status messages produced by the installation go here

connection - the connection object

Returns:

the (directory) path at which the tool can be found

Throws:

IOException - if the installation fails

InterruptedException - if communication with a agent is interrupted

isJavaInstalled

public boolean isJavaInstalled(hudson.Launcher launcher,
                               hudson.model.TaskListener tl)
                        throws IOException,
                               InterruptedException

Routine to run a remote command to determine if java is installed (e.g. java -version).

Parameters:

launcher - the launcher

tl - the task listener

Returns:

true if the command was successful, false otherwise

Throws:

IOException - if an error occurs while launching and running the java version command

InterruptedException - if communication with a agent is interrupted

getTimestamp

protected static String getTimestamp()

Returns the formatted current time stamp.

Returns:

the formatted current time stamp.

log

protected void log(Level lvl,
                   hudson.model.TaskListener listener,
                   String msg)

Logs the specified message to both the logger and the task listener.

Parameters:

lvl - the log level

listener - the task listener

msg - the message to log

fine

protected void fine(hudson.model.TaskListener listener,
                    String msg)

Logs the specified message as Level.FINE to both the logger and the task listener.

Parameters:

listener - the task listener

msg - the message to log

info

protected void info(hudson.model.TaskListener listener,
                    String msg)

Logs the specified message as Level.FINE to both the logger and the task listener.

Parameters:

listener - the task listener

msg - the message to log

warn

protected void warn(hudson.model.TaskListener listener,
                    String msg)

Logs the specified message as Level.FINE to both the logger and the task listener.

Parameters:

listener - the task listener

msg - the message to log

executeCommand

protected int executeCommand(hudson.model.TaskListener log,
                             hudson.Launcher launcher,
                             String... commands)
                      throws IOException,
                             InterruptedException

A simple wrapper method for launching a set of commands. This method leverages the Java tmpdir property for the working directory of the command (handy for running simple commands).

Parameters:

log - the task listener

launcher - the launcher

commands - one or more commands (as a vararg)

Returns:

the exit code from the command(s)

Throws:

IOException - if an error occurs while launching and running the command

InterruptedException - if an error occurs while launching and running the command

executeCommand

protected int executeCommand(hudson.model.TaskListener log,
                             hudson.Launcher launcher,
                             String workingDir,
                             String... commands)
                      throws IOException,
                             InterruptedException

A simple wrapper method for launching a set of commands. This method leverages the Java tmpdir property for the working directory of the command (handy for running simple commands).

Parameters:

log - the task listener

launcher - the launcher

workingDir - the working directory when running the command

commands - one or more commands (as a vararg)

Returns:

the exit code from the command(s)

Throws:

IOException - if an error occurs while launching and running the command

InterruptedException - if an error occurs while launching and running the command