hudson.plugins.clearcase

Interface ClearToolLauncher

All Known Implementing Classes:

HudsonClearToolLauncher

public interface ClearToolLauncher

Interface to hide the Hudson launch parts so other parts can mock the actual launch.

Author:

Erik Ramfelt

Method Summary

Modifier and Type	Method and Description
String	getCmdString(String[] cmd)
hudson.Launcher	getLauncher()
hudson.model.TaskListener	getListener() Returns a task listener for a hudson job
hudson.FilePath	getWorkspace() Returns the workspace file path for a hudson job
boolean	isUnix()
boolean	run(String[] cmd, hudson.FilePath execPath) Launches a cleartool command with arguments.
boolean	run(String[] cmd, InputStream in, OutputStream out, hudson.FilePath execPath) Launches a cleartool command with arguments.
boolean	run(String[] cmd, InputStream in, OutputStream out, hudson.FilePath execPath, boolean logCommand) Launches a cleartool command with arguments.

Method Detail

getCmdString

String getCmdString(String[] cmd)

getLauncher

hudson.Launcher getLauncher()

Returns:

the Hudsonlauncher

getListener

hudson.model.TaskListener getListener()

Returns a task listener for a hudson job

Returns:

a task listener

getWorkspace

hudson.FilePath getWorkspace()

Returns the workspace file path for a hudson job

Returns:

the workspace file path

isUnix

boolean isUnix()

run

boolean run(String[] cmd,
            hudson.FilePath execPath)
     throws IOException,
            InterruptedException

Launches a cleartool command with arguments.

Parameters:

cmd - the command to launch using the clear tool executable

filePath -

Returns:

execPath optional, the path where the command should be launched

Throws:

IOException

InterruptedException

run

boolean run(String[] cmd,
            InputStream in,
            OutputStream out,
            hudson.FilePath execPath)
     throws IOException,
            InterruptedException

Launches a cleartool command with arguments.

Parameters:

cmd - the command to launch using the clear tool executable

in - optional, if the command should be able to receive input

out - optional, can be used to gather the output stream

execPath - optional, the path where the command should be launched

Returns:

true if the command was successful, false otherwise

Throws:

IOException

InterruptedException

run

boolean run(String[] cmd,
            InputStream in,
            OutputStream out,
            hudson.FilePath execPath,
            boolean logCommand)
     throws IOException,
            InterruptedException

Launches a cleartool command with arguments.

Parameters:

cmd - the command to launch using the clear tool executable

in - optional, if the command should be able to receive input

out - optional, can be used to gather the output stream

execPath - optional, the path where the command should be launched

logCommand - optional, log the command itself

Returns:

true if the command was successful, false otherwise

Throws:

IOException

InterruptedException