|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.exec.DefaultExecutor
public class DefaultExecutor
The default class to start a subprocess. The implementation allows to
Executor exec = new DefaultExecutor(); CommandLine cl = new CommandLine("ls -l"); int exitvalue = exec.execute(cl);
Field Summary |
---|
Fields inherited from interface org.apache.commons.exec.Executor |
---|
INVALID_EXITVALUE |
Constructor Summary | |
---|---|
DefaultExecutor()
Default constructor creating a default PumpStreamHandler
and sets the working directory of the subprocess to the current
working directory. |
Method Summary | |
---|---|
int |
execute(CommandLine command)
Methods for starting synchronous execution. |
void |
execute(CommandLine command,
ExecuteResultHandler handler)
Methods for starting asynchronous execution. |
int |
execute(CommandLine command,
java.util.Map environment)
Methods for starting synchronous execution. |
void |
execute(CommandLine command,
java.util.Map environment,
ExecuteResultHandler handler)
Methods for starting asynchronous execution. |
protected java.lang.Thread |
getExecutorThread()
Get the worker thread being used for asynchronous execution. |
ProcessDestroyer |
getProcessDestroyer()
Set the handler for cleanup of started processes if the main process is going to terminate. |
ExecuteStreamHandler |
getStreamHandler()
Get the StreamHandler used for providing input and retrieving the output. |
ExecuteWatchdog |
getWatchdog()
Get the watchdog used to kill of processes running, typically, too long time. |
java.io.File |
getWorkingDirectory()
Get the working directory of the created process. |
boolean |
isFailure(int exitValue)
Checks whether exitValue signals a failure. |
protected java.lang.Process |
launch(CommandLine command,
java.util.Map env,
java.io.File dir)
Creates a process that runs a command. |
void |
setExitValue(int value)
Define the exitValue of the process to be considered
successful. |
void |
setExitValues(int[] values)
Define a list of exitValue of the process to be considered
successful. |
void |
setProcessDestroyer(ProcessDestroyer processDestroyer)
Get the handler for cleanup of started processes if the main process is going to terminate. |
void |
setStreamHandler(ExecuteStreamHandler streamHandler)
Set a custom the StreamHandler used for providing input and retrieving the output. |
void |
setWatchdog(ExecuteWatchdog watchDog)
Set the watchdog used to kill of processes running, typically, too long time. |
void |
setWorkingDirectory(java.io.File dir)
Set the working directory of the created process. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultExecutor()
PumpStreamHandler
and sets the working directory of the subprocess to the current
working directory.
The PumpStreamHandler
pumps the output of the subprocess
into our System.out
and System.err
to avoid
into our System.out
and System.err
to avoid
a blocked or deadlocked subprocess (seeProcess
).
Method Detail |
---|
public ExecuteStreamHandler getStreamHandler()
Executor
getStreamHandler
in interface Executor
Executor.getStreamHandler()
public void setStreamHandler(ExecuteStreamHandler streamHandler)
Executor
Process
).
setStreamHandler
in interface Executor
streamHandler
- the stream handlerExecutor.setStreamHandler(org.apache.commons.exec.ExecuteStreamHandler)
public ExecuteWatchdog getWatchdog()
Executor
getWatchdog
in interface Executor
Executor.getWatchdog()
public void setWatchdog(ExecuteWatchdog watchDog)
Executor
setWatchdog
in interface Executor
watchDog
- the watchdogExecutor.setWatchdog(org.apache.commons.exec.ExecuteWatchdog)
public ProcessDestroyer getProcessDestroyer()
Executor
getProcessDestroyer
in interface Executor
Executor.getProcessDestroyer()
public void setProcessDestroyer(ProcessDestroyer processDestroyer)
Executor
setProcessDestroyer
in interface Executor
processDestroyer
- the ProcessDestroyerExecutor.setProcessDestroyer(ProcessDestroyer)
public java.io.File getWorkingDirectory()
Executor
getWorkingDirectory
in interface Executor
Executor.getWorkingDirectory()
public void setWorkingDirectory(java.io.File dir)
Executor
setWorkingDirectory
in interface Executor
dir
- the working directoryExecutor.setWorkingDirectory(java.io.File)
public int execute(CommandLine command) throws ExecuteException, java.io.IOException
Executor
execute
in interface Executor
command
- the command to execute
ExecuteException
- execution of subprocess failed or the
subprocess returned a exit value indicating a failure
Executor.setExitValue(int)
.
java.io.IOException
Executor.execute(CommandLine)
public int execute(CommandLine command, java.util.Map environment) throws ExecuteException, java.io.IOException
Executor
execute
in interface Executor
command
- the command to executeenvironment
- The environment for the new process. If null, the
environment of the current process is used.
ExecuteException
- execution of subprocess failed or the
subprocess returned a exit value indicating a failure
Executor.setExitValue(int)
.
java.io.IOException
Executor.execute(CommandLine, java.util.Map)
public void execute(CommandLine command, ExecuteResultHandler handler) throws ExecuteException, java.io.IOException
Executor
execute
in interface Executor
command
- the command to executehandler
- capture process termination and exit code
ExecuteException
- execution of subprocess failed
java.io.IOException
Executor.execute(CommandLine,
org.apache.commons.exec.ExecuteResultHandler)
public void execute(CommandLine command, java.util.Map environment, ExecuteResultHandler handler) throws ExecuteException, java.io.IOException
Executor
execute
in interface Executor
command
- the command to executeenvironment
- The environment for the new process. If null, the
environment of the current process is used.handler
- capture process termination and exit code
ExecuteException
- execution of subprocess failed
java.io.IOException
Executor.execute(CommandLine,
java.util.Map, org.apache.commons.exec.ExecuteResultHandler)
public void setExitValue(int value)
Executor
exitValue
of the process to be considered
successful. If a different exit value is returned by
the process then Executor.execute(CommandLine)
will throw an ExecuteException
setExitValue
in interface Executor
value
- the exit code representing successful executionExecutor.setExitValue(int)
public void setExitValues(int[] values)
Executor
exitValue
of the process to be considered
successful. The caller can pass one of the following values
Executor.isFailure(int)
Executor.execute(CommandLine)
will
throw an ExecuteException
.
setExitValues
in interface Executor
values
- a list of the exit codesExecutor.setExitValues(int[])
public boolean isFailure(int exitValue)
Executor
exitValue
signals a failure. If no
exit values are set than the default conventions of the OS is
used. e.g. most OS regard an exit code of '0' as successful
execution and everything else as failure.
isFailure
in interface Executor
exitValue
- the exit value (return code) to be checked
true
if exitValue
signals a failureExecutor.isFailure(int)
protected java.lang.Process launch(CommandLine command, java.util.Map env, java.io.File dir) throws java.io.IOException
command
- the command to runenv
- the environment for the commanddir
- the working directory for the command
java.io.IOException
- forwarded from the particular launcher usedprotected java.lang.Thread getExecutorThread()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |