public class DefaultExecutor extends java.lang.Object implements Executor
Executor exec = new DefaultExecutor();
CommandLine cl = new CommandLine("ls -l");
int exitvalue = exec.execute(cl);
INVALID_EXITVALUE| Constructor and Description |
|---|
DefaultExecutor()
Default constructor creating a default
PumpStreamHandler
and sets the working directory of the subprocess to the current
working directory. |
| Modifier and Type | Method and Description |
|---|---|
protected java.lang.Thread |
createThread(java.lang.Runnable runnable,
java.lang.String name)
Factory method to create a thread waiting for the result of an
asynchronous execution.
|
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<java.lang.String,java.lang.String> environment)
Methods for starting synchronous execution.
|
void |
execute(CommandLine command,
java.util.Map<java.lang.String,java.lang.String> 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<java.lang.String,java.lang.String> 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.
|
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).public ExecuteStreamHandler getStreamHandler()
ExecutorgetStreamHandler in interface ExecutorExecutor.getStreamHandler()public void setStreamHandler(ExecuteStreamHandler streamHandler)
ExecutorProcess).setStreamHandler in interface ExecutorstreamHandler - the stream handlerExecutor.setStreamHandler(org.apache.commons.exec.ExecuteStreamHandler)public ExecuteWatchdog getWatchdog()
ExecutorgetWatchdog in interface ExecutorExecutor.getWatchdog()public void setWatchdog(ExecuteWatchdog watchDog)
ExecutorsetWatchdog in interface ExecutorwatchDog - the watchdogExecutor.setWatchdog(org.apache.commons.exec.ExecuteWatchdog)public ProcessDestroyer getProcessDestroyer()
ExecutorgetProcessDestroyer in interface ExecutorExecutor.getProcessDestroyer()public void setProcessDestroyer(ProcessDestroyer processDestroyer)
ExecutorsetProcessDestroyer in interface ExecutorprocessDestroyer - the ProcessDestroyerExecutor.setProcessDestroyer(ProcessDestroyer)public java.io.File getWorkingDirectory()
ExecutorgetWorkingDirectory in interface ExecutorExecutor.getWorkingDirectory()public void setWorkingDirectory(java.io.File dir)
ExecutorsetWorkingDirectory in interface Executordir - the working directoryExecutor.setWorkingDirectory(java.io.File)public int execute(CommandLine command) throws ExecuteException, java.io.IOException
Executorexecute in interface Executorcommand - the command to executeExecuteException - execution of subprocess failed or the
subprocess returned a exit value indicating a failure
Executor.setExitValue(int).java.io.IOExceptionExecutor.execute(CommandLine)public int execute(CommandLine command, java.util.Map<java.lang.String,java.lang.String> environment) throws ExecuteException, java.io.IOException
Executorexecute in interface Executorcommand - 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.IOExceptionExecutor.execute(CommandLine, java.util.Map)public void execute(CommandLine command, ExecuteResultHandler handler) throws ExecuteException, java.io.IOException
Executorexecute in interface Executorcommand - the command to executehandler - capture process termination and exit codeExecuteException - execution of subprocess failedjava.io.IOExceptionExecutor.execute(CommandLine,
org.apache.commons.exec.ExecuteResultHandler)public void execute(CommandLine command, java.util.Map<java.lang.String,java.lang.String> environment, ExecuteResultHandler handler) throws ExecuteException, java.io.IOException
Executorexecute in interface Executorcommand - 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 codeExecuteException - execution of subprocess failedjava.io.IOExceptionExecutor.execute(CommandLine,
java.util.Map, org.apache.commons.exec.ExecuteResultHandler)public void setExitValue(int value)
ExecutorexitValue of the process to be considered
successful. If a different exit value is returned by
the process then Executor.execute(CommandLine)
will throw an ExecuteExceptionsetExitValue in interface Executorvalue - the exit code representing successful executionExecutor.setExitValue(int)public void setExitValues(int[] values)
ExecutorexitValue 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 Executorvalues - a list of the exit codesExecutor.setExitValues(int[])public boolean isFailure(int exitValue)
ExecutorexitValue 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 ExecutorexitValue - the exit value (return code) to be checkedtrue if exitValue signals a failureExecutor.isFailure(int)protected java.lang.Thread createThread(java.lang.Runnable runnable,
java.lang.String name)
runnable - the runnable passed to the threadname - the name of the threadprotected java.lang.Process launch(CommandLine command, java.util.Map<java.lang.String,java.lang.String> env, java.io.File dir) throws java.io.IOException
command - the command to runenv - the environment for the commanddir - the working directory for the commandjava.io.IOException - forwarded from the particular launcher usedprotected java.lang.Thread getExecutorThread()