DaemonExecutor
, DefaultExecutor
public interface Executor
Executor exec = new DefaultExecutor(); CommandLine cl = new CommandLine("ls -l"); int exitvalue = exec.execute(cl);
Modifier and Type | Field | Description |
---|---|---|
static int |
INVALID_EXITVALUE |
Invalid exit code.
|
Modifier and Type | Method | Description |
---|---|---|
int |
execute(CommandLine command) |
Methods for starting synchronous 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.
|
void |
execute(CommandLine command,
ExecuteResultHandler handler) |
Methods for starting 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. |
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.
|
static final int INVALID_EXITVALUE
void setExitValue(int value)
exitValue
of the process to be considered
successful. If a different exit value is returned by
the process then execute(CommandLine)
will throw an ExecuteException
value
- the exit code representing successful executionvoid setExitValues(int[] values)
exitValue
of the process to be considered
successful. The caller can pass one of the following values
isFailure(int)
execute(CommandLine)
will
throw an ExecuteException
.values
- a list of the exit codesboolean isFailure(int exitValue)
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.exitValue
- the exit value (return code) to be checkedtrue
if exitValue
signals a failureExecuteStreamHandler getStreamHandler()
void setStreamHandler(ExecuteStreamHandler streamHandler)
Process
).streamHandler
- the stream handlerExecuteWatchdog getWatchdog()
void setWatchdog(ExecuteWatchdog watchDog)
watchDog
- the watchdogProcessDestroyer getProcessDestroyer()
void setProcessDestroyer(ProcessDestroyer processDestroyer)
processDestroyer
- the ProcessDestroyerjava.io.File getWorkingDirectory()
void setWorkingDirectory(java.io.File dir)
dir
- the working directoryint execute(CommandLine command) throws ExecuteException, java.io.IOException
command
- the command to executeExecuteException
- execution of subprocess failed or the
subprocess returned a exit value indicating a failure
setExitValue(int)
.java.io.IOException
int execute(CommandLine command, java.util.Map<java.lang.String,java.lang.String> environment) throws ExecuteException, java.io.IOException
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
setExitValue(int)
.java.io.IOException
void execute(CommandLine command, ExecuteResultHandler handler) throws ExecuteException, java.io.IOException
command
- the command to executehandler
- capture process termination and exit codeExecuteException
- execution of subprocess failedjava.io.IOException
void execute(CommandLine command, java.util.Map<java.lang.String,java.lang.String> environment, ExecuteResultHandler handler) throws ExecuteException, java.io.IOException
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 codeExecuteException
- execution of subprocess failedjava.io.IOException