hudson.plugins.sshslaves
クラス SSHLauncher

java.lang.Object
  hudson.model.AbstractDescribableImpl<hudson.slaves.ComputerLauncher>
      hudson.slaves.ComputerLauncher
          hudson.plugins.sshslaves.SSHLauncher

すべての実装されたインタフェース:

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

public class SSHLauncher
extends hudson.slaves.ComputerLauncher

A computer launcher that tries to start a linux slave by opening an SSH connection and trying to find java.

入れ子のクラスの概要

static class	SSHLauncher.DefaultJavaProvider
static class	SSHLauncher.DefaultJDKInstaller 推奨されていません。 Subtype of JDKInstaller causes JENKINS-10641.
static class	SSHLauncher.DescriptorImpl

インタフェース hudson.ExtensionPoint から継承された入れ子のクラス/インタフェース

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

フィールドの概要

String	javaPath Field javaPath.
String	prefixStartSlaveCmd Field prefixStartSlaveCmd.
String	suffixStartSlaveCmd Field suffixStartSlaveCmd.

クラス hudson.slaves.ComputerLauncher から継承されたフィールド

LIST

コンストラクタの概要

SSHLauncher(String host, int port, String username, String password, String privatekey, String jvmOptions)

SSHLauncher(String host, int port, String username, String password, String privatekey, String jvmOptions, String javaPath, hudson.tools.JDKInstaller jdkInstaller, String prefixStartSlaveCmd, String suffixStartSlaveCmd)
Constructor SSHLauncher creates a new SSHLauncher instance.

SSHLauncher(String host, int port, String username, String password, String privatekey, String jvmOptions, String javaPath, String prefixStartSlaveCmd, String suffixStartSlaveCmd)
Constructor SSHLauncher creates a new SSHLauncher instance.

メソッドの概要

void	afterDisconnect(hudson.slaves.SlaveComputer slaveComputer, hudson.model.TaskListener listener)
protected String	checkJavaVersion(PrintStream logger, String javaCommand, BufferedReader r, StringWriter output) Given the output of "java -version" in r, determine if this version of Java is supported.
com.trilead.ssh2.Connection	getConnection()
String	getHost() Getter for property 'host'.
String	getJavaPath() Gets the optionnal java command to use to launch the slave JVM.
String	getJvmOptions() Gets the JVM Options used to launch the slave JVM.
String	getPassword() Getter for property 'password'.
int	getPort() Getter for property 'port'.
String	getPrefixStartSlaveCmd()
String	getPrivatekey() Getter for property 'privatekey'.
String	getSuffixStartSlaveCmd()
protected String	getTimestamp() Gets the formatted current time stamp.
String	getUsername() Getter for property 'username'.
boolean	isLaunchSupported()
void	launch(hudson.slaves.SlaveComputer computer, hudson.model.TaskListener listener)
protected void	openConnection(hudson.model.TaskListener listener)
protected void	reportEnvironment(hudson.model.TaskListener listener)
protected String	resolveJava(hudson.slaves.SlaveComputer computer, hudson.model.TaskListener listener) return javaPath if specified in the configuration.

クラス hudson.slaves.ComputerLauncher から継承されたメソッド

afterDisconnect, beforeDisconnect, beforeDisconnect, launch

クラス hudson.model.AbstractDescribableImpl から継承されたメソッド

getDescriptor

クラス java.lang.Object から継承されたメソッド

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

フィールドの詳細

javaPath

public final String javaPath

Field javaPath.

prefixStartSlaveCmd

public final String prefixStartSlaveCmd

Field prefixStartSlaveCmd.

suffixStartSlaveCmd

public final String suffixStartSlaveCmd

Field suffixStartSlaveCmd.

コンストラクタの詳細

SSHLauncher

@DataBoundConstructor
public SSHLauncher(String host,
                                        int port,
                                        String username,
                                        String password,
                                        String privatekey,
                                        String jvmOptions,
                                        String javaPath,
                                        String prefixStartSlaveCmd,
                                        String suffixStartSlaveCmd)

Constructor SSHLauncher creates a new SSHLauncher instance.

パラメータ:

host - The host to connect to.

port - The port to connect on.

username - The username to connect as.

password - The password to connect with.

privatekey - The ssh privatekey to connect with.

jvmOptions - Options passed to the java vm.

javaPath - Path to the host jdk installation. If null the jdk will be auto detected or installed by the JDKInstaller.

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.

SSHLauncher

public SSHLauncher(String host,
                   int port,
                   String username,
                   String password,
                   String privatekey,
                   String jvmOptions,
                   String javaPath,
                   hudson.tools.JDKInstaller jdkInstaller,
                   String prefixStartSlaveCmd,
                   String suffixStartSlaveCmd)

Constructor SSHLauncher creates a new SSHLauncher instance.

パラメータ:

host - The host to connect to.

port - The port to connect on.

username - The username to connect as.

password - The password to connect with.

privatekey - The ssh privatekey to connect with.

jvmOptions - Options passed to the java vm.

javaPath - Path to the host jdk installation. If null the jdk will be auto detected or installed by the JDKInstaller.

jdkInstaller - The jdk installer that will be used if no java vm is found on the specified host. If null the SSHLauncher.DefaultJDKInstaller 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.

SSHLauncher

public SSHLauncher(String host,
                   int port,
                   String username,
                   String password,
                   String privatekey,
                   String jvmOptions)

メソッドの詳細

isLaunchSupported

public boolean isLaunchSupported()

オーバーライド:

クラス hudson.slaves.ComputerLauncher 内の isLaunchSupported

getJvmOptions

public String getJvmOptions()

Gets the JVM Options used to launch the slave JVM.

戻り値:

getJavaPath

public String getJavaPath()

Gets the optionnal java command to use to launch the slave JVM.

戻り値:

getTimestamp

protected String getTimestamp()

Gets the formatted current time stamp.

戻り値:

the formatted current time stamp.

launch

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

オーバーライド:

クラス hudson.slaves.ComputerLauncher 内の launch

例外:

InterruptedException

resolveJava

protected String resolveJava(hudson.slaves.SlaveComputer computer,
                             hudson.model.TaskListener listener)
                      throws InterruptedException,
                             hudson.util.IOException2

return javaPath if specified in the configuration. Finds local Java, and if none exist, install one.

例外:

InterruptedException

hudson.util.IOException2

reportEnvironment

protected void reportEnvironment(hudson.model.TaskListener listener)
                          throws IOException,
                                 InterruptedException

例外:

IOException

InterruptedException

checkJavaVersion

protected String checkJavaVersion(PrintStream logger,
                                  String javaCommand,
                                  BufferedReader r,
                                  StringWriter output)
                           throws IOException

Given the output of "java -version" in r, determine if this version of Java is supported. This method has default visiblity for testing.

パラメータ:

logger - where to log the output

javaCommand - the command executed, used for logging

r - the output of "java -version"

output - copy the data from r into this output buffer

例外:

IOException

openConnection

protected void openConnection(hudson.model.TaskListener listener)
                       throws IOException,
                              InterruptedException

例外:

IOException

InterruptedException

afterDisconnect

public void afterDisconnect(hudson.slaves.SlaveComputer slaveComputer,
                            hudson.model.TaskListener listener)

オーバーライド:

クラス hudson.slaves.ComputerLauncher 内の afterDisconnect

getHost

public String getHost()

Getter for property 'host'.

戻り値:

Value for property 'host'.

getPort

public int getPort()

Getter for property 'port'.

戻り値:

Value for property 'port'.

getUsername

public String getUsername()

Getter for property 'username'.

戻り値:

Value for property 'username'.

getPassword

public String getPassword()

Getter for property 'password'.

戻り値:

Value for property 'password'.

getPrivatekey

public String getPrivatekey()

Getter for property 'privatekey'.

戻り値:

Value for property 'privatekey'.

getConnection

public com.trilead.ssh2.Connection getConnection()

getPrefixStartSlaveCmd

public String getPrefixStartSlaveCmd()

getSuffixStartSlaveCmd

public String getSuffixStartSlaveCmd()