net.eduvax.util

Class OSCmdRunner

java.lang.Object

net.eduvax.util.OSCmdRunner

All Implemented Interfaces:

java.lang.Runnable

public class OSCmdRunner
extends java.lang.Object
implements java.lang.Runnable

Helper for executing OS commands

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OSCmdRunner.Callback
static class	OSCmdRunner.PrintStreamCallback

Field Summary

Fields

Modifier and Type	Field and Description
private OSCmdRunner.Callback	_callback command output stream handler
private java.lang.String[]	_commandLine Command line arguments
private java.io.File	_directory command working directory
private ErrorHandler	_errHandler error handler
private java.lang.Process	_process system process for command execution
private EThread	_thread thread used when desynchronized command run
private static java.lang.String	ERR_INTERRUPT
private static java.lang.String	ERR_NOTALLOWED
private static java.lang.String	ERR_NOTFOUND
private static java.lang.String	ERR_OSTREAM

Constructor Summary

Constructors

Constructor and Description
OSCmdRunner(java.lang.String[] command) create new OS command runner

Method Summary

Methods

Modifier and Type	Method and Description
static OSCmdRunner	exec(java.lang.String cmd)
static OSCmdRunner	exec(java.lang.String[] cmd) Runs OS command in separate thread.
protected java.lang.String[]	getCommandLine()
protected ErrorHandler	getErrorHandler() Get command error handler.
int	getExitValue()
protected java.lang.Process	getProcess()
private void	handleError(java.lang.String errId, Error.ELevel level, java.lang.Exception ex) handle error
void	join() Wait for command completion.
void	join(long timeout) Wait for command completion.
protected void	processStarted()
void	run() run command
void	setCallback(OSCmdRunner.Callback c) Change output stream callback.
void	setErrorHandler(ErrorHandler handler) Change error handler.
void	setPrintStream(java.io.PrintStream o) Change output stream.
void	setWorkingDirectory(java.io.File dir) Change command working directory
void	setWorkingDirectory(java.lang.String dir) Change command working directory

Methods inherited from class java.lang.Object

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

Field Detail

_thread

private EThread _thread

thread used when desynchronized command run

_process

private java.lang.Process _process

system process for command execution

_commandLine

private java.lang.String[] _commandLine

Command line arguments

_callback

private OSCmdRunner.Callback _callback

command output stream handler

_directory

private java.io.File _directory

command working directory

_errHandler

private ErrorHandler _errHandler

error handler

ERR_OSTREAM

private static final java.lang.String ERR_OSTREAM

See Also:

Constant Field Values

ERR_NOTFOUND

private static final java.lang.String ERR_NOTFOUND

See Also:

Constant Field Values

ERR_NOTALLOWED

private static final java.lang.String ERR_NOTALLOWED

See Also:

Constant Field Values

ERR_INTERRUPT

private static final java.lang.String ERR_INTERRUPT

See Also:

Constant Field Values

Constructor Detail

OSCmdRunner

public OSCmdRunner(java.lang.String[] command)

create new OS command runner

Parameters:

command - command line (program name + args)

Method Detail

setPrintStream

public void setPrintStream(java.io.PrintStream o)

Change output stream.

set the stream where running command outputs are rederected.

warning: this methode change the callback used to process command outputs.

Parameters:

o - new output stream.

setCallback

public void setCallback(OSCmdRunner.Callback c)

Change output stream callback.

Parameters:

c - new callback.

setWorkingDirectory

public void setWorkingDirectory(java.lang.String dir)

Change command working directory

Parameters:

dir - new working directory

setWorkingDirectory

public void setWorkingDirectory(java.io.File dir)

Change command working directory

Parameters:

dir - new working directory

processStarted

protected void processStarted()

run

public void run()

run command

Specified by:

run in interface java.lang.Runnable

exec

public static OSCmdRunner exec(java.lang.String[] cmd)

Runs OS command in separate thread. Outputs stdout and stderr of running command to System.out.

Parameters:

cmd - command line (program name + args)

join

public void join()

Wait for command completion. Does nothing when command not runned with its own thread.

join

public void join(long timeout)

Wait for command completion. Does nothing when command not runned with its own thread.

Parameters:

timeout - max wait delay

exec

public static OSCmdRunner exec(java.lang.String cmd)

getExitValue

public int getExitValue()

Returns:

command exit value when available

getProcess

protected java.lang.Process getProcess()

Returns:

process

getCommandLine

protected java.lang.String[] getCommandLine()

Returns:

command line

handleError

private void handleError(java.lang.String errId,
               Error.ELevel level,
               java.lang.Exception ex)

handle error

Parameters:

errId - on of ERR_* consts

level - one of Error.L_* consts

ex - exception source of error (null if not any)

getErrorHandler

protected ErrorHandler getErrorHandler()

Get command error handler. The one set with setErrorHandler(), Default App error handler if not any.

Returns:

error handler

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

Change error handler. Error handler should be set before running command.

Parameters:

handler - new error handler