org.mmbase.util.externalprocess

Class CommandLauncher

java.lang.Object

org.mmbase.util.externalprocess.CommandLauncher

public class CommandLauncher
extends Object

The command launcher provides a way to comunicate with a external process

Since:

MMBase-1.6

Version:

$Id:

Author:

Nico Klasens (Finalist IT Group)

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	commandArgs Command and arguments
protected static long	DELAY The number of milliseconds to pause between polling.
protected String	name The internal name of the external process
protected Process	process The process object representing the external process

Constructor Summary

Constructors

Constructor and Description
CommandLauncher(String name) Creates a new launcher Fills in stderr and stdout output to the given streams.

Method Summary

Modifier and Type	Method and Description
protected String[]	constructCommandArray(String command, String[] commandArgs) Constructs a command array that will be passed to the process
void	execute(String command) Execute a command
void	execute(String[] commandArgs) Execute a command
void	execute(String[] commandArgs, String[] env) Execute a command
void	execute(String[] commandArgs, String[] env, String changeToDirectory) Execute a command
void	execute(String commandPath, String[] args) Execute a command
void	execute(String commandPath, String[] args, String[] env) Execute a command
void	execute(String commandPath, String[] args, String[] env, String changeToDirectory) Execute a command
String[]	getCommandArgs() get CommandArgs.
Process	getProcess()
void	printCommandLine(String[] commandArgs) print Command Line.
protected void	processStreams(ProcessClosure closure, OutputStream output, PipedInputStream inputPipe, OutputStream err, PipedInputStream errInPipe, IProgressMonitor monitor) process the Streams.while the external process returns bytes.
void	waitAndRead(OutputStream out, OutputStream err) Reads output from the external process to the streams.
void	waitAndRead(OutputStream output, OutputStream err, IProgressMonitor monitor) Reads output from the external process to the streams.
ProcessClosure	waitAndWrite(InputStream in, OutputStream out, OutputStream err) Writes input to and reads output from the external process to the streams.
void	waitAndWrite(InputStream in, OutputStream output, OutputStream err, IProgressMonitor monitor) Writes input to and reads output from the external process to the streams.

Methods inherited from class java.lang.Object

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

Field Detail

DELAY

protected static final long DELAY

The number of milliseconds to pause between polling.

See Also:

Constant Field Values

process

protected Process process

The process object representing the external process

commandArgs

protected String[] commandArgs

Command and arguments

name

protected String name

The internal name of the external process

Constructor Detail

CommandLauncher

public CommandLauncher(String name)

Creates a new launcher Fills in stderr and stdout output to the given streams. Streams can be set to null, if output not required

Parameters:

name - internal name of the external process

Method Detail

getCommandArgs

public String[] getCommandArgs()

get CommandArgs.

Returns:

String[]

constructCommandArray

protected String[] constructCommandArray(String command,
                                         String[] commandArgs)

Constructs a command array that will be passed to the process

Parameters:

command - path of comand

commandArgs - arguments after the command

execute

public void execute(String command)
             throws ProcessException

Execute a command

Parameters:

command - command

Throws:

IOException - if an I/O error occurs

ProcessException

execute

public void execute(String[] commandArgs)
             throws ProcessException

Execute a command

Parameters:

commandArgs - command and arguments

Throws:

IOException - if an I/O error occurs

ProcessException

execute

public void execute(String commandPath,
                    String[] args)
             throws ProcessException

Execute a command

Parameters:

commandPath - path of comand

args - arguments after the command

Throws:

IOException - if an I/O error occurs

ProcessException

execute

public void execute(String[] commandArgs,
                    String[] env)
             throws ProcessException

Execute a command

Parameters:

commandArgs - command and arguments

env - environment name value pairs

Throws:

IOException - if an I/O error occurs

ProcessException

execute

public void execute(String commandPath,
                    String[] args,
                    String[] env)
             throws ProcessException

Execute a command

Parameters:

commandPath - path of comand

args - arguments after the comand

env - environment name value pairs

Throws:

IOException - if an I/O error occurs

ProcessException

execute

public void execute(String[] commandArgs,
                    String[] env,
                    String changeToDirectory)
             throws ProcessException

Execute a command

Parameters:

commandArgs - command and arguments

env - environment name value pairs

changeToDirectory - working directory

Throws:

IOException - if an I/O error occurs

ProcessException

execute

public void execute(String commandPath,
                    String[] args,
                    String[] env,
                    String changeToDirectory)
             throws ProcessException

Execute a command

Parameters:

commandPath - path of comand

args - arguments after the comand

env - environment name value pairs

changeToDirectory - working directory

Throws:

IOException - if an I/O error occurs

ProcessException

waitAndRead

public void waitAndRead(OutputStream out,
                        OutputStream err)
                 throws ProcessException

Reads output from the external process to the streams.

Parameters:

out - process stdout is written to this stream

err - process stderr is written to this stream

Throws:

ProcessException - if process not yet executed

waitAndRead

public void waitAndRead(OutputStream output,
                        OutputStream err,
                        IProgressMonitor monitor)
                 throws ProcessException

Reads output from the external process to the streams. A progress monitor is polled to test for cancellation. Destroys the process if the monitor becomes cancelled

Parameters:

output - process stdout is written to this stream

err - process stderr is written to this stream

monitor - monitor monitor to receive progress info and to cancel the external process

Throws:

ProcessException - if process not yet executed or if process cancelled

waitAndWrite

public ProcessClosure waitAndWrite(InputStream in,
                                   OutputStream out,
                                   OutputStream err)
                            throws ProcessException

Writes input to and reads output from the external process to the streams.

Parameters:

in - process stdin is read from this stream

out - process stdout is written to this stream

err - process stderr is written to this stream

Throws:

ProcessException - if process not yet executed

waitAndWrite

public void waitAndWrite(InputStream in,
                         OutputStream output,
                         OutputStream err,
                         IProgressMonitor monitor)
                  throws ProcessException

Writes input to and reads output from the external process to the streams. A progress monitor is polled to test for cancellation. Destroys the process if the monitor becomes cancelled

Parameters:

in - process stdin is read from this stream

output - process stdout is written to this stream

err - process stderr is written to this stream

monitor - monitor monitor to receive progress info and to cancel the external process

Throws:

ProcessException - if process not yet executed or if process cancelled

processStreams

protected void processStreams(ProcessClosure closure,
                              OutputStream output,
                              PipedInputStream inputPipe,
                              OutputStream err,
                              PipedInputStream errInPipe,
                              IProgressMonitor monitor)
                       throws ProcessException

process the Streams.while the external process returns bytes. Cancellation is possible by the ProgressMonitor

Parameters:

closure - process closure object which handles the interaction with the external process

output - process stdout is written to this stream

inputPipe - piped stream to other thread for the stdout

err - process stderr is written to this stream

errInPipe - piped stream to other thread for the stderr

monitor - monitor to receive progress info and to cancel the external process

Throws:

ProcessException - if process cancelled

printCommandLine

public void printCommandLine(String[] commandArgs)

print Command Line.

Parameters:

commandArgs - array of comand and args

getProcess

public Process getProcess()

Since:

MMBase-1.9.1