org.oddjob.jobs

Class ExecBase

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.framework.extend.SimpleJob

org.oddjob.framework.extend.SerializableJob

org.oddjob.jobs.ExecBase

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, ArooaContextAware, ArooaSessionAware, Forceable, PropertyChangeNotifier, Iconic, ConsoleOwner, LogEnabled, Resetable, Stateful, Stoppable

Direct Known Subclasses:

ExecJob, JavaJob

public abstract class ExecBase
extends SerializableJob
implements Stoppable, ConsoleOwner

Base class for Jobs that create an external process.

See Also:

Serialized Form

Author:

Rob Gordon.

Field Summary

Fields inherited from class org.oddjob.framework.extend.SimpleJob

stop

Constructor Summary

Constructors

Constructor and Description
ExecBase()

Method Summary

Modifier and Type	Method and Description
ArooaTokenizer	commandTokenizer() Provide the ArooaTokenizer to use for parsing commands.
LogArchive	consoleLog() Provide the console archive.
protected int	execute() Execute this job.
java.io.File	getDir()
java.lang.String	getEnvironment(java.lang.String name)
int	getExitValue()
java.io.OutputStream	getStderr() Get the output stream for stderr.
java.io.InputStream	getStdin() Get the input stream for stdin.
java.io.OutputStream	getStdout() Get the output stream for stdout.
boolean	isNewEnvironment()
boolean	isRedirectStderr()
boolean	isStopForcibly()
void	onStop() Allow sub classes to do something on stop.
protected abstract java.lang.String[]	provideArgs()
void	setDir(java.io.File dir) Set the working directory.
void	setEnvironment(java.lang.String name, java.lang.String value) Add an environment variable.
void	setNewEnvironment(boolean explicitEnvironment)
void	setRedirectStderr(boolean redirectErrorStream)
void	setStderr(java.io.OutputStream stderr) Set the output stream stderr from the process will be directed to.
void	setStdin(java.io.InputStream stdin) Set the input stream stdin for the process will be read from.
void	setStdout(java.io.OutputStream stdout) Set the output stream stdout from the process will be directed to.
void	setStopForcibly(boolean stopForcibly)

Methods inherited from class org.oddjob.framework.extend.SimpleJob

fireDestroyedState, force, getStateChanger, hardReset, iconHelper, isStop, onDestroy, onReset, run, sleep, softReset, stateHandler, stop

Methods inherited from class org.oddjob.framework.extend.BasePrimary

configure, getName, logger, logger, loggerName, save, setName, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.Stoppable

stop

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

ExecBase

public ExecBase()

Method Detail

setDir

public void setDir(java.io.File dir)

Set the working directory.

Parameters:

dir - The working directory.

setNewEnvironment

public void setNewEnvironment(boolean explicitEnvironment)

Property: newEnvironment

Description: Create a fresh/clean environment.

Required: No.

isNewEnvironment

public boolean isNewEnvironment()

setEnvironment

public void setEnvironment(java.lang.String name,
                           java.lang.String value)

Add an environment variable.

Parameters:

name - The of the environment variable.

value - The value of the environment variable.

getEnvironment

public java.lang.String getEnvironment(java.lang.String name)

setRedirectStderr

public void setRedirectStderr(boolean redirectErrorStream)

Property: redirectStderr

Description: Redirect the standard error stream in standard output.

Required: No.

isRedirectStderr

public boolean isRedirectStderr()

setStdin

public void setStdin(java.io.InputStream stdin)

Set the input stream stdin for the process will be read from.

Parameters:

stdin - An InputStream.

getStdin

public java.io.InputStream getStdin()

Get the input stream for stdin. This will be null unless one has been provided.

Returns:

An InputStream or null.

setStdout

public void setStdout(java.io.OutputStream stdout)

Set the output stream stdout from the process will be directed to.

Parameters:

stdout - The output stream.

getStdout

public java.io.OutputStream getStdout()

Get the output stream for stdout. This will be null unless one has been provided.

Returns:

An OutputStream or null.

setStderr

public void setStderr(java.io.OutputStream stderr)

Set the output stream stderr from the process will be directed to.

Parameters:

stderr - The error stream.

getStderr

public java.io.OutputStream getStderr()

Get the output stream for stderr. This will be null unless one has been provided.

Returns:

An OutputStream or null.

isStopForcibly

public boolean isStopForcibly()

setStopForcibly

public void setStopForcibly(boolean stopForcibly)

commandTokenizer

public ArooaTokenizer commandTokenizer()

Provide the ArooaTokenizer to use for parsing commands.

Returns:

A tokenizer, never null.

provideArgs

protected abstract java.lang.String[] provideArgs()
                                           throws java.lang.Exception

Throws:

java.lang.Exception

execute

protected int execute()
               throws java.lang.Exception

Description copied from class: SimpleJob

Execute this job.

Specified by:

execute in class SimpleJob

Returns:

0 if the job is complete, anything else otherwise.

Throws:

java.lang.Exception - If the unexpected occurs.

onStop

public void onStop()

Description copied from class: SimpleJob

Allow sub classes to do something on stop.

Overrides:

onStop in class SimpleJob

getDir

public java.io.File getDir()

Returns:

Returns the dir.

getExitValue

public int getExitValue()

consoleLog

public LogArchive consoleLog()

Description copied from interface: ConsoleOwner

Provide the console archive.

Specified by:

consoleLog in interface ConsoleOwner

Returns:

The archive. Must not be null.