hudson.slaves
Class CommandLauncher

java.lang.Object
  hudson.model.AbstractDescribableImpl<ComputerLauncher>
      hudson.slaves.ComputerLauncher
          hudson.slaves.CommandLauncher

All Implemented Interfaces:

ExtensionPoint, Describable<ComputerLauncher>

public class CommandLauncher
extends ComputerLauncher

ComputerLauncher through a remote login mechanism like ssh/rsh.

Author:

Stephen Connolly, Kohsuke Kawaguchi

Nested Class Summary

static class

CommandLauncher.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.slaves.ComputerLauncher

LIST

Constructor Summary

CommandLauncher(String command)

CommandLauncher(String command, EnvVars env)

Method Summary

String	getCommand()
void	launch(SlaveComputer computer, TaskListener listener) Launches the slave agent for the given 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

CommandLauncher

@DataBoundConstructor
public CommandLauncher(String command)

CommandLauncher

public CommandLauncher(String command,
                       EnvVars env)

Method Detail

getCommand

public String getCommand()

launch

public void launch(SlaveComputer computer,
                   TaskListener listener)

Description copied from class: ComputerLauncher

Launches the slave agent for the given Computer.

If the slave agent is launched successfully, SlaveComputer.setChannel(InputStream, OutputStream, TaskListener, Channel.Listener) should be invoked in the end to notify Hudson of the established connection. The operation could also fail, in which case there's no need to make any callback notification, (except to notify the user of the failure through StreamTaskListener.) Also note that the normal return of this method call does not necessarily signify a successful launch. If someone programmatically calls this method and wants to find out if the launch was a success, use Computer.isOnline() at the end.

This method must operate synchronously. Asynchrony is provided by Computer.connect(boolean) and its correct operation depends on this.

Overrides:

launch in class ComputerLauncher

listener - The progress of the launch, as well as any error, should be sent to this listener.