Package org.apache.commons.exec
Interface Executor
- All Known Implementing Classes:
- DaemonExecutor,- DefaultExecutor
public interface Executor
The main abstraction to start an external process.
 The interface allows to:
 
- set a current working directory for the subprocess
- provide a set of environment variables passed to the subprocess
- capture the subprocess output of stdout and stderr using an ExecuteStreamHandler
- kill long-running processes using an ExecuteWatchdog
- define a set of expected exit values
- terminate any started processes when the main process is terminating using a ProcessDestroyer
The following example shows the basic usage:
 Executor exec = DefaultExecutor.builder().get();
 CommandLine cl = new CommandLine("ls -l");
 int exitvalue = exec.execute(cl);
 - 
Field SummaryFields
- 
Method SummaryModifier and TypeMethodDescriptionintexecute(CommandLine command) Executes a command synchronously.intexecute(CommandLine command, Map<String, String> environment) Executes a command synchronously.voidexecute(CommandLine command, Map<String, String> environment, ExecuteResultHandler handler) Executes a command asynchronously.voidexecute(CommandLine command, ExecuteResultHandler handler) Executes a command asynchronously.Sets the handler for cleanup of started processes if the main process is going to terminate.Gets the StreamHandler used for providing input and retrieving the output.Gets the watchdog used to kill of processes running, typically, too long time.Gets the working directory of the created process.default PathGets the working directory of the created process.booleanisFailure(int exitValue) Tests whetherexitValuesignals a failure.voidsetExitValue(int value) Sets theexitValueof the process to be considered successful.voidsetExitValues(int[] values) Sets a list ofexitValueof the process to be considered successful.voidsetProcessDestroyer(ProcessDestroyer processDestroyer) Sets the handler for cleanup of started processes if the main process is going to terminate.voidsetStreamHandler(ExecuteStreamHandler streamHandler) Sets a custom the StreamHandler used for providing input and retrieving the output.voidsetWatchdog(ExecuteWatchdog watchDog) Sets the watchdog used to kill of processes running, typically, too long time.voidsetWorkingDirectory(File dir) Sets the working directory of the created process.
- 
Field Details- 
INVALID_EXITVALUEInvalid exit code.- See Also:
 
 
- 
- 
Method Details- 
executeExecutes a command synchronously. The child process inherits all environment variables of the parent process.- Parameters:
- command- the command to execute.
- Returns:
- process exit value.
- Throws:
- ExecuteException- execution of subprocess failed or the subprocess returned a exit value indicating a failure- setExitValue(int).
- IOException- If an I/O error occurs.
 
- 
executevoid execute(CommandLine command, ExecuteResultHandler handler) throws ExecuteException, IOException Executes a command asynchronously. The child process inherits all environment variables of the parent process. Result provided to callback handler.- Parameters:
- command- the command to execute.
- handler- capture process termination and exit code.
- Throws:
- ExecuteException- execution of subprocess failed.
- IOException- If an I/O error occurs.
 
- 
executeint execute(CommandLine command, Map<String, String> environment) throws ExecuteException, IOExceptionExecutes a command synchronously.- Parameters:
- command- the command to execute.
- environment- The environment for the new process. If null, the environment of the current process is used.
- Returns:
- process exit value.
- Throws:
- ExecuteException- execution of subprocess failed or the subprocess returned a exit value indicating a failure- setExitValue(int).
- IOException- If an I/O error occurs.
 
- 
executevoid execute(CommandLine command, Map<String, String> environment, ExecuteResultHandler handler) throws ExecuteException, IOExceptionExecutes a command asynchronously. The child process inherits all environment variables of the parent process. Result provided to callback handler.- Parameters:
- command- the command to execute.
- environment- The environment for the new process. If null, the environment of the current process is used.
- handler- capture process termination and exit code.
- Throws:
- ExecuteException- execution of subprocess failed.
- IOException- If an I/O error occurs.
 
- 
getProcessDestroyerSets the handler for cleanup of started processes if the main process is going to terminate.- Returns:
- the ProcessDestroyer.
 
- 
getStreamHandlerGets the StreamHandler used for providing input and retrieving the output.- Returns:
- the StreamHandler.
 
- 
getWatchdogGets the watchdog used to kill of processes running, typically, too long time.- Returns:
- the watchdog.
 
- 
getWorkingDirectoryGets the working directory of the created process.- Returns:
- the working directory.
 
- 
getWorkingDirectoryPathGets the working directory of the created process.- Returns:
- the working directory.
- Since:
- 1.5.0
 
- 
isFailureTests whetherexitValuesignals 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.- Parameters:
- exitValue- the exit value (return code) to be checked.
- Returns:
- trueif- exitValuesignals a failure.
 
- 
setExitValueSets theexitValueof the process to be considered successful. If a different exit value is returned by the process thenexecute(CommandLine)will throw anExecuteException.- Parameters:
- value- the exit code representing successful execution.
 
- 
setExitValuesSets a list ofexitValueof the process to be considered successful. The caller can pass one of the following values.- an array of exit values to be considered successful
- an empty array for auto-detect of successful exit codes relying on isFailure(int)
- null to indicate to skip checking of exit codes
 execute(CommandLine)will throw anExecuteException.- Parameters:
- values- a list of the exit codes.
 
- 
setProcessDestroyerSets the handler for cleanup of started processes if the main process is going to terminate.- Parameters:
- processDestroyer- the ProcessDestroyer.
 
- 
setStreamHandlerSets a custom the StreamHandler used for providing input and retrieving the output. If you don't provide a proper stream handler the executed process might block when writing to stdout and/or stderr (seeProcess).- Parameters:
- streamHandler- the stream handler.
 
- 
setWatchdogSets the watchdog used to kill of processes running, typically, too long time.- Parameters:
- watchDog- the watchdog.
 
- 
setWorkingDirectorySets the working directory of the created process. The working directory must exist when you start the process.- Parameters:
- dir- the working directory.
 
 
-