com.rackspace.jenkins_nodepool

Class NodePoolSSHLauncher

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.slaves.ComputerLauncher>

hudson.slaves.ComputerLauncher

com.rackspace.jenkins_nodepool.NodePoolSSHLauncher

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.slaves.ComputerLauncher>

public class NodePoolSSHLauncher
extends hudson.slaves.ComputerLauncher

NodePool SSH Launcher class - derived from the SSHLauncher plugin which didn't handle custom JDK installations.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.slaves.ComputerLauncher

LIST

Constructor Summary

Constructors

Constructor and Description

NodePoolSSHLauncher(String host, int port, String credentialsId, String jvmOptions, NodePoolJDKInstaller jdkInstaller, String prefixStartSlaveCmd, String suffixStartSlaveCmd, int launchTimeoutSeconds, Integer maxNumRetries, Integer retryWaitTimeSeconds, hudson.plugins.sshslaves.verifiers.SshHostKeyVerificationStrategy sshHostKeyVerificationStrategy) Constructor SSHLauncher creates a new SSHLauncher instance.

Method Summary

Modifier and Type	Method and Description
com.trilead.ssh2.Connection	getConnection()
com.cloudbees.plugins.credentials.common.StandardUsernameCredentials	getCredentials() Returns this launcher's credentials.
String	getCredentialsId()
String	getHost()
String	getJvmOptions()
int	getLaunchTimeoutSeconds()
int	getMaxNumRetries()
int	getPort()
String	getPrefixStartSlaveCmd()
int	getRetryWaitTimeSeconds()
hudson.plugins.sshslaves.verifiers.SshHostKeyVerificationStrategy	getSshHostKeyVerificationStrategy()
String	getSuffixStartSlaveCmd()
NodePoolJDKInstaller	getToolInstaller()
void	launch(hudson.slaves.SlaveComputer computer, hudson.model.TaskListener tl) Launches the JDK/JRE installer if needed, copies over the Jenkins agent JAR file, and executes the agent.
protected void	openConnection(hudson.model.TaskListener tl, hudson.slaves.SlaveComputer computer)
protected void	reportEnvironment(hudson.model.TaskListener tl, hudson.slaves.SlaveComputer computer)

Methods inherited from class hudson.slaves.ComputerLauncher

afterDisconnect, afterDisconnect, beforeDisconnect, beforeDisconnect, checkJavaVersion, isLaunchSupported, launch

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

NodePoolSSHLauncher

public NodePoolSSHLauncher(String host,
                           int port,
                           String credentialsId,
                           String jvmOptions,
                           NodePoolJDKInstaller jdkInstaller,
                           String prefixStartSlaveCmd,
                           String suffixStartSlaveCmd,
                           int launchTimeoutSeconds,
                           Integer maxNumRetries,
                           Integer retryWaitTimeSeconds,
                           hudson.plugins.sshslaves.verifiers.SshHostKeyVerificationStrategy sshHostKeyVerificationStrategy)

Constructor SSHLauncher creates a new SSHLauncher instance.

Parameters:

host - The host to connect to.

port - The port to connect on.

credentialsId - The credentials to connect as.

jvmOptions - Options passed to the java vm.

jdkInstaller - The jdk installer that will be used.

prefixStartSlaveCmd - This will prefix the start slave command. For instance if you want to execute the command with a different shell.

suffixStartSlaveCmd - This will suffix the start slave command.

launchTimeoutSeconds - Launch timeout in seconds

maxNumRetries - The number of times to retry connection if the SSH connection is refused during initial connect

retryWaitTimeSeconds - The number of seconds to wait between retries

sshHostKeyVerificationStrategy - the ssh host key verification strategy

Method Detail

getToolInstaller

public NodePoolJDKInstaller getToolInstaller()

getHost

public String getHost()

getPort

public int getPort()

getJvmOptions

public String getJvmOptions()

getPrefixStartSlaveCmd

public String getPrefixStartSlaveCmd()

getSuffixStartSlaveCmd

public String getSuffixStartSlaveCmd()

getLaunchTimeoutSeconds

public int getLaunchTimeoutSeconds()

getMaxNumRetries

public int getMaxNumRetries()

getRetryWaitTimeSeconds

public int getRetryWaitTimeSeconds()

getSshHostKeyVerificationStrategy

public hudson.plugins.sshslaves.verifiers.SshHostKeyVerificationStrategy getSshHostKeyVerificationStrategy()

getCredentialsId

public String getCredentialsId()

getConnection

public com.trilead.ssh2.Connection getConnection()

launch

public void launch(hudson.slaves.SlaveComputer computer,
                   hudson.model.TaskListener tl)
            throws InterruptedException

Launches the JDK/JRE installer if needed, copies over the Jenkins agent JAR file, and executes the agent.

Overrides:

launch in class hudson.slaves.ComputerLauncher

Parameters:

computer - the slave computer reference

tl - the task listener

Throws:

InterruptedException - if an error occurs launching

getCredentials

public com.cloudbees.plugins.credentials.common.StandardUsernameCredentials getCredentials()

Returns this launcher's credentials.

Returns:

this launcher's credentials

openConnection

protected void openConnection(hudson.model.TaskListener tl,
                              hudson.slaves.SlaveComputer computer)
                       throws IOException,
                              InterruptedException

Throws:

IOException

InterruptedException

reportEnvironment

protected void reportEnvironment(hudson.model.TaskListener tl,
                                 hudson.slaves.SlaveComputer computer)
                          throws IOException,
                                 InterruptedException

Throws:

IOException

InterruptedException