Launcher (Hudson :: Core 3.0.0 API)

To allow important environment variables to be copied over to the remote machine, the 'env' parameter shouldn't contain default inherited environment variables (which often contains machine-specific information, like PATH, TIMEZONE, etc.)

Launcher is responsible for inheriting environment variables.

Author:: Kohsuke Kawaguchi, Winston Prakash (bug fixes)
See Also:: FilePath.createLauncher(TaskListener)

Nested Class Summary
`static class`	`Launcher.LocalLauncher` `Launcher` that launches process locally.
`class`	`Launcher.ProcStarter` Builder pattern for configuring a process to launch.
`static class`	`Launcher.RemoteLauncher` Launches processes remotely by using the given channel.

Field Summary
`static boolean`	`showFullPath` Debug option to display full current path instead of just the last token.

Constructor Summary
`Launcher(TaskListener listener, hudson.remoting.VirtualChannel channel)`

Method Summary
`Launcher`	`decorateByPrefix(String... prefix)` Returns a decorated `Launcher` that puts the given set of arguments as a prefix to any commands that it invokes.
`Launcher`	`decorateFor(Node node)` Returns a decorated `Launcher` for the given node.
`hudson.remoting.VirtualChannel`	`getChannel()` Gets the channel that can be used to run a program remotely.
`Computer`	`getComputer()` Deprecated. since 2008-11-16. See the javadoc for why this is inherently unreliable. If you are trying to figure out the current `Computer` from within a build, use `Computer.currentComputer()`
`TaskListener`	`getListener()` Gets the `TaskListener` that this launcher uses to report the commands that it's executing.
`boolean`	`isUnix()` Returns true if this `Launcher` is going to launch on Unix.
`abstract void`	`kill(Map<String,String> modelEnvVars)` Calls `ProcessTree.killAll(Map)` to kill processes.
`Launcher.ProcStarter`	`launch()` Launches a process by using a builder-pattern to configure the parameters.
`abstract Proc`	`launch(Launcher.ProcStarter starter)` Primarily invoked from `Launcher.ProcStarter.start()` to start a process with a specific launcher.
`Proc`	`launch(String[] cmd, boolean[] mask, Map<String,String> env, InputStream in, OutputStream out)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String[] cmd, boolean[] mask, Map<String,String> env, OutputStream out, FilePath workDir)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String[] cmd, boolean[] mask, String[] env, InputStream in, OutputStream out)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String[] cmd, boolean[] mask, String[] env, InputStream in, OutputStream out, FilePath workDir)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String[] cmd, boolean[] mask, String[] env, OutputStream out, FilePath workDir)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String[] cmd, Map<String,String> env, InputStream in, OutputStream out)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String[] cmd, Map<String,String> env, OutputStream out, FilePath workDir)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String[] cmd, String[] env, InputStream in, OutputStream out)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String[] cmd, String[] env, InputStream in, OutputStream out, FilePath workDir)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String[] cmd, String[] env, OutputStream out, FilePath workDir)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String cmd, Map<String,String> env, OutputStream out, FilePath workDir)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`Proc`	`launch(String cmd, String[] env, OutputStream out, FilePath workDir)` Deprecated. as of 1.311 Use `launch()` and its associated builder pattern
`abstract hudson.remoting.Channel`	`launchChannel(String[] cmd, OutputStream out, FilePath workDir, Map<String,String> envVars)` Launches a specified process and connects its input/output to a `Channel`, then return it.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

showFullPath

public static boolean showFullPath

Debug option to display full current path instead of just the last token.

Constructor Detail

Launcher

public Launcher(TaskListener listener,
                hudson.remoting.VirtualChannel channel)

Method Detail

getChannel

public hudson.remoting.VirtualChannel getChannel()

Gets the channel that can be used to run a program remotely.

Returns:: null if the target node is not configured to support this. this is a transitional measure. Note that a launcher for the master is always non-null.

getListener

public TaskListener getListener()

Gets the TaskListener that this launcher uses to report the commands that it's executing.

getComputer

public Computer getComputer()

Deprecated. since 2008-11-16. See the javadoc for why this is inherently unreliable. If you are trying to figure out the current Computer from within a build, use Computer.currentComputer()

If this Launcher is encapsulating an execution on a specific Computer, return it.

Because of the way internal Hudson abstractions are set up (that is, Launcher only needs a VirtualChannel to do its job and isn't really required that the channel comes from an existing Computer), this method may not always the right Computer instance.

Returns:: null if this launcher is not created from a Computer object.

launch

public final Launcher.ProcStarter launch()

Launches a process by using a builder-pattern to configure the parameters.