Skip navigation links
A B C D E F G H I J K L M O P Q R S T V W 

A

add(Process) - Method in interface org.apache.commons.exec.ProcessDestroyer
Returns true if the specified Process was successfully added to the list of processes to be destroy.
add(Process) - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer
Returns true if the specified Process was successfully added to the list of processes to destroy upon VM exit.
addArgument(String) - Method in class org.apache.commons.exec.CommandLine
Add a single argument.
addArgument(String, boolean) - Method in class org.apache.commons.exec.CommandLine
Add a single argument.
addArguments(String[]) - Method in class org.apache.commons.exec.CommandLine
Add multiple arguments.
addArguments(String[], boolean) - Method in class org.apache.commons.exec.CommandLine
Add multiple arguments.
addArguments(String) - Method in class org.apache.commons.exec.CommandLine
Add multiple arguments.
addArguments(String, boolean) - Method in class org.apache.commons.exec.CommandLine
Add multiple arguments.
added - Variable in class org.apache.commons.exec.ShutdownHookProcessDestroyer
Whether or not this ProcessDestroyer has been registered as a shutdown hook
addShutdownHook() - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer
Registers this ProcessDestroyer as a shutdown hook, uses reflection to ensure pre-JDK 1.3 compatibility.
addTimeoutObserver(TimeoutObserver) - Method in class org.apache.commons.exec.Watchdog
 
addVariableToEnvironment(Map<String, String>, String) - Static method in class org.apache.commons.exec.environment.EnvironmentUtils
Add a key/value pair to the given environment.
Argument(String, boolean) - Constructor for class org.apache.commons.exec.CommandLine.Argument
 
arguments - Variable in class org.apache.commons.exec.CommandLine
The arguments of the command.

B

BACKSLASH_CHAR - Static variable in class org.apache.commons.exec.util.StringUtils
 
buffer - Variable in class org.apache.commons.exec.LogOutputStream
the internal buffer

C

caught - Variable in class org.apache.commons.exec.ExecuteWatchdog
Exception that might be thrown during the process execution.
caught - Variable in class org.apache.commons.exec.PumpStreamHandler
the last exception being caught
cause - Variable in exception org.apache.commons.exec.ExecuteException
The underlying cause of this exception.
checkException() - Method in class org.apache.commons.exec.ExecuteWatchdog
This method will rethrow the exception that was possibly caught during the run of the process.
cleanUp() - Method in class org.apache.commons.exec.ExecuteWatchdog
reset the monitor flag and the process.
close() - Method in class org.apache.commons.exec.LogOutputStream
Writes all remaining data from the buffer.
closeProcessStreams(Process) - Method in class org.apache.commons.exec.DefaultExecutor
Close the streams belonging to the given Process.
closeWhenExhausted - Variable in class org.apache.commons.exec.StreamPumper
close the output stream when exhausted
CommandLauncher - Interface in org.apache.commons.exec.launcher
Interface to shield the caller from the various platform-dependent implementations.
CommandLauncherFactory - Class in org.apache.commons.exec.launcher
Builds a command launcher for the OS and JVM we are running under.
CommandLauncherFactory() - Constructor for class org.apache.commons.exec.launcher.CommandLauncherFactory
 
CommandLauncherImpl - Class in org.apache.commons.exec.launcher
A command launcher for a particular JVM/OS platform.
CommandLauncherImpl() - Constructor for class org.apache.commons.exec.launcher.CommandLauncherImpl
 
CommandLauncherProxy - Class in org.apache.commons.exec.launcher
A command launcher that proxies another command launcher.
CommandLauncherProxy(CommandLauncher) - Constructor for class org.apache.commons.exec.launcher.CommandLauncherProxy
 
CommandLine - Class in org.apache.commons.exec
CommandLine objects help handling command lines specifying processes to execute.
CommandLine(String) - Constructor for class org.apache.commons.exec.CommandLine
Create a command line without any arguments.
CommandLine(File) - Constructor for class org.apache.commons.exec.CommandLine
Create a command line without any arguments.
CommandLine(CommandLine) - Constructor for class org.apache.commons.exec.CommandLine
Copy constructor.
CommandLine.Argument - Class in org.apache.commons.exec
Encapsulates a command line argument.
COMMONS_EXEC_DEBUG - Static variable in class org.apache.commons.exec.util.DebugUtils
System property to determine how to dump an exception.
COMMONS_EXEC_LENIENT - Static variable in class org.apache.commons.exec.util.DebugUtils
System property to determine how to handle exceptions.
copy(Map<K, V>) - Static method in class org.apache.commons.exec.util.MapUtils
Clones a map.
CR - Static variable in class org.apache.commons.exec.LogOutputStream
Carriage return
createCommandFile(CommandLine, Map<String, String>) - Method in class org.apache.commons.exec.launcher.VmsCommandLauncher
 
createEnvironmentMap() - Method in class org.apache.commons.exec.environment.DefaultProcessingEnvironment
Creates a map that obeys the casing rules of the current platform for key lookup.
createProcEnvironment() - Method in class org.apache.commons.exec.environment.DefaultProcessingEnvironment
Find the list of environment variables for this process.
createProcessErrorPump(InputStream, OutputStream) - Method in class org.apache.commons.exec.PumpStreamHandler
Create the pump to handle error output.
createProcessOutputPump(InputStream, OutputStream) - Method in class org.apache.commons.exec.PumpStreamHandler
Create the pump to handle process output.
createPump(InputStream, OutputStream) - Method in class org.apache.commons.exec.PumpStreamHandler
Creates a stream pumper to copy the given input stream to the given output stream.
createPump(InputStream, OutputStream, boolean) - Method in class org.apache.commons.exec.PumpStreamHandler
Creates a stream pumper to copy the given input stream to the given output stream.
createSystemInPump(InputStream, OutputStream) - Method in class org.apache.commons.exec.PumpStreamHandler
Creates a stream pumper to copy the given input stream to the given output stream.
createThread(Runnable, String) - Method in class org.apache.commons.exec.DaemonExecutor
Factory method to create a thread waiting for the result of an asynchronous execution.
createThread(Runnable, String) - Method in class org.apache.commons.exec.DefaultExecutor
Factory method to create a thread waiting for the result of an asynchronous execution.
createVMLauncher() - Static method in class org.apache.commons.exec.launcher.CommandLauncherFactory
Factory method to create an appropriate launcher.

D

DaemonExecutor - Class in org.apache.commons.exec
Runs daemon processes asynchronously.
DaemonExecutor() - Constructor for class org.apache.commons.exec.DaemonExecutor
 
DebugUtils - Class in org.apache.commons.exec.util
Provides debugging support.
DebugUtils() - Constructor for class org.apache.commons.exec.util.DebugUtils
 
DEFAULT_SIZE - Static variable in class org.apache.commons.exec.StreamPumper
the default size of the internal buffer for copying the streams
DefaultExecuteResultHandler - Class in org.apache.commons.exec
A default implementation of 'ExecuteResultHandler' used for asynchronous process handling.
DefaultExecuteResultHandler() - Constructor for class org.apache.commons.exec.DefaultExecuteResultHandler
Constructor.
DefaultExecutor - Class in org.apache.commons.exec
The default class to start a subprocess.
DefaultExecutor() - Constructor for class org.apache.commons.exec.DefaultExecutor
Default constructor creating a default PumpStreamHandler and sets the working directory of the subprocess to the current working directory.
DefaultProcessingEnvironment - Class in org.apache.commons.exec.environment
Helper class to determine the environment variable for the OS.
DefaultProcessingEnvironment() - Constructor for class org.apache.commons.exec.environment.DefaultProcessingEnvironment
 
destroyProcess() - Method in class org.apache.commons.exec.ExecuteWatchdog
Destroys the running process manually.
destroyProcessThread - Variable in class org.apache.commons.exec.ShutdownHookProcessDestroyer
The thread registered at the JVM to execute the shutdown handler
DOUBLE_QUOTE - Static variable in class org.apache.commons.exec.util.StringUtils
 

E

ensureStarted() - Method in class org.apache.commons.exec.ExecuteWatchdog
Ensures that the process is started, so we do not race with asynch execution.
EnvironmentUtils - Class in org.apache.commons.exec.environment
Wrapper for environment variables.
EnvironmentUtils() - Constructor for class org.apache.commons.exec.environment.EnvironmentUtils
Disable constructor.
err - Variable in class org.apache.commons.exec.PumpStreamHandler
 
errorThread - Variable in class org.apache.commons.exec.PumpStreamHandler
 
exception - Variable in class org.apache.commons.exec.DefaultExecuteResultHandler
Any offending exception
exceptionCaught - Variable in class org.apache.commons.exec.DefaultExecutor
the first exception being caught to be thrown to the caller
exec(CommandLine, Map<String, String>) - Method in interface org.apache.commons.exec.launcher.CommandLauncher
Launches the given command in a new process.
exec(CommandLine, Map<String, String>, File) - Method in interface org.apache.commons.exec.launcher.CommandLauncher
Launches the given command in a new process, in the given working directory.
exec(CommandLine, Map<String, String>) - Method in class org.apache.commons.exec.launcher.CommandLauncherImpl
 
exec(CommandLine, Map<String, String>, File) - Method in class org.apache.commons.exec.launcher.CommandLauncherImpl
 
exec(CommandLine, Map<String, String>) - Method in class org.apache.commons.exec.launcher.CommandLauncherProxy
Launches the given command in a new process.
exec(CommandLine, Map<String, String>, File) - Method in class org.apache.commons.exec.launcher.Java13CommandLauncher
Launches the given command in a new process, in the given working directory
exec(CommandLine, Map<String, String>, File) - Method in class org.apache.commons.exec.launcher.OS2CommandLauncher
Launches the given command in a new process, in the given working directory.
exec(CommandLine, Map<String, String>) - Method in class org.apache.commons.exec.launcher.VmsCommandLauncher
Launches the given command in a new process.
exec(CommandLine, Map<String, String>, File) - Method in class org.apache.commons.exec.launcher.VmsCommandLauncher
Launches the given command in a new process, in the given working directory.
exec(CommandLine, Map<String, String>, File) - Method in class org.apache.commons.exec.launcher.WinNTCommandLauncher
Launches the given command in a new process, in the given working directory.
executable - Variable in class org.apache.commons.exec.CommandLine
The program to execute.
execute(CommandLine) - Method in class org.apache.commons.exec.DefaultExecutor
 
execute(CommandLine, Map<String, String>) - Method in class org.apache.commons.exec.DefaultExecutor
 
execute(CommandLine, ExecuteResultHandler) - Method in class org.apache.commons.exec.DefaultExecutor
 
execute(CommandLine, Map<String, String>, ExecuteResultHandler) - Method in class org.apache.commons.exec.DefaultExecutor
 
execute(CommandLine) - Method in interface org.apache.commons.exec.Executor
Methods for starting synchronous execution.
execute(CommandLine, Map<String, String>) - Method in interface org.apache.commons.exec.Executor
Methods for starting synchronous execution.
execute(CommandLine, ExecuteResultHandler) - Method in interface org.apache.commons.exec.Executor
Methods for starting asynchronous execution.
execute(CommandLine, Map<String, String>, ExecuteResultHandler) - Method in interface org.apache.commons.exec.Executor
Methods for starting asynchronous execution.
ExecuteException - Exception in org.apache.commons.exec
An exception indicating that the executing a subprocesses failed.
ExecuteException(String, int) - Constructor for exception org.apache.commons.exec.ExecuteException
Construct a new exception with the specified detail message.
ExecuteException(String, int, Throwable) - Constructor for exception org.apache.commons.exec.ExecuteException
Construct a new exception with the specified detail message and cause.
executeInternal(CommandLine, Map<String, String>, File, ExecuteStreamHandler) - Method in class org.apache.commons.exec.DefaultExecutor
Execute an internal process.
ExecuteResultHandler - Interface in org.apache.commons.exec
The callback handlers for the result of asynchronous process execution.
ExecuteStreamHandler - Interface in org.apache.commons.exec
Used by Execute to handle input and output stream of subprocesses.
ExecuteWatchdog - Class in org.apache.commons.exec
Destroys a process running for too long.
ExecuteWatchdog(long) - Constructor for class org.apache.commons.exec.ExecuteWatchdog
Creates a new watchdog with a given timeout.
Executor - Interface in org.apache.commons.exec
The main abstraction to start an external process.
executorThread - Variable in class org.apache.commons.exec.DefaultExecutor
worker thread for asynchronous execution
exitValue - Variable in class org.apache.commons.exec.DefaultExecuteResultHandler
The exit value of the finished process
exitValue - Variable in exception org.apache.commons.exec.ExecuteException
The exit value returned by the failed process
exitValues - Variable in class org.apache.commons.exec.DefaultExecutor
the exit values considered to be successful
expandArgument(String) - Method in class org.apache.commons.exec.CommandLine
Expand variables in a command line argument.

F

FAMILY_DOS - Static variable in class org.apache.commons.exec.OS
 
FAMILY_MAC - Static variable in class org.apache.commons.exec.OS
 
FAMILY_NETWARE - Static variable in class org.apache.commons.exec.OS
 
FAMILY_OPENVMS - Static variable in class org.apache.commons.exec.OS
 
FAMILY_OS_2 - Static variable in class org.apache.commons.exec.OS
 
FAMILY_OS_400 - Static variable in class org.apache.commons.exec.OS
 
FAMILY_TANDEM - Static variable in class org.apache.commons.exec.OS
 
FAMILY_UNIX - Static variable in class org.apache.commons.exec.OS
 
FAMILY_WIN9X - Static variable in class org.apache.commons.exec.OS
 
FAMILY_WINDOWS - Static variable in class org.apache.commons.exec.OS
 
FAMILY_Z_OS - Static variable in class org.apache.commons.exec.OS
 
finished - Variable in class org.apache.commons.exec.StreamPumper
was the end of the stream reached
fireTimeoutOccured() - Method in class org.apache.commons.exec.Watchdog
 
fixFileSeparatorChar(String) - Static method in class org.apache.commons.exec.util.StringUtils
Fixes the file separator char for the target platform using the following replacement.
flush() - Method in class org.apache.commons.exec.LogOutputStream
Flush this log stream.

G

getArguments() - Method in class org.apache.commons.exec.CommandLine
Returns the expanded and quoted command line arguments.
getCause() - Method in exception org.apache.commons.exec.ExecuteException
Return the underlying cause of this exception (if any).
getErr() - Method in class org.apache.commons.exec.PumpStreamHandler
Get the error stream.
getException() - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
Get the exception causing the process execution to fail.
getExceptionCaught() - Method in class org.apache.commons.exec.DefaultExecutor
Get the first IOException being thrown.
getExecutable() - Method in class org.apache.commons.exec.CommandLine
Returns the executable.
getExecutorThread() - Method in class org.apache.commons.exec.DefaultExecutor
Get the worker thread being used for asynchronous execution.
getExitValue() - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
Get the exitValue of the process.
getExitValue() - Method in exception org.apache.commons.exec.ExecuteException
Gets the exit value returned by the failed process
getMessageLevel() - Method in class org.apache.commons.exec.LogOutputStream
 
getOut() - Method in class org.apache.commons.exec.PumpStreamHandler
Get the output stream.
getProcEnvCommand() - Method in class org.apache.commons.exec.environment.DefaultProcessingEnvironment
Deprecated.
No longer needed
getProcEnvironment() - Method in class org.apache.commons.exec.environment.DefaultProcessingEnvironment
Find the list of environment variables for this process.
getProcEnvironment() - Static method in class org.apache.commons.exec.environment.EnvironmentUtils
Find the list of environment variables for this process.
getProcessDestroyer() - Method in class org.apache.commons.exec.DefaultExecutor
 
getProcessDestroyer() - Method in interface org.apache.commons.exec.Executor
Set the handler for cleanup of started processes if the main process is going to terminate.
getStreamHandler() - Method in class org.apache.commons.exec.DefaultExecutor
 
getStreamHandler() - Method in interface org.apache.commons.exec.Executor
Get the StreamHandler used for providing input and retrieving the output.
getSubstitutionMap() - Method in class org.apache.commons.exec.CommandLine
 
getValue() - Method in class org.apache.commons.exec.CommandLine.Argument
 
getWatchdog() - Method in class org.apache.commons.exec.DefaultExecutor
 
getWatchdog() - Method in interface org.apache.commons.exec.Executor
Get the watchdog used to kill of processes running, typically, too long time.
getWorkingDirectory() - Method in class org.apache.commons.exec.DefaultExecutor
 
getWorkingDirectory() - Method in interface org.apache.commons.exec.Executor
Get the working directory of the created process.

H

handleException(String, Exception) - Static method in class org.apache.commons.exec.util.DebugUtils
Handles an exception based on the system properties.
handleQuoting - Variable in class org.apache.commons.exec.CommandLine.Argument
 
hasResult - Variable in class org.apache.commons.exec.DefaultExecuteResultHandler
Keep track if the process is still running
hasResult() - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
Has the process exited and a result is available, i.e.
hasWatchdog - Variable in class org.apache.commons.exec.ExecuteWatchdog
Is a user-supplied timeout in use

I

INFINITE_TIMEOUT - Static variable in class org.apache.commons.exec.ExecuteWatchdog
The marker for an infinite timeout
input - Variable in class org.apache.commons.exec.PumpStreamHandler
 
InputStreamPumper - Class in org.apache.commons.exec
Copies all data from an System.input stream to an output stream of the executed process.
InputStreamPumper(InputStream, OutputStream) - Constructor for class org.apache.commons.exec.InputStreamPumper
Create a new stream pumper.
inputStreamPumper - Variable in class org.apache.commons.exec.PumpStreamHandler
 
inputThread - Variable in class org.apache.commons.exec.PumpStreamHandler
 
INTIAL_SIZE - Static variable in class org.apache.commons.exec.LogOutputStream
Initial buffer size.
INVALID_EXITVALUE - Static variable in interface org.apache.commons.exec.Executor
Invalid exit code.
is - Variable in class org.apache.commons.exec.InputStreamPumper
the input stream to pump from
is - Variable in class org.apache.commons.exec.StreamPumper
the input stream to pump from
isAddedAsShutdownHook() - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer
Returns whether or not the ProcessDestroyer is registered as as shutdown hook
isArch(String) - Static method in class org.apache.commons.exec.OS
Determines if the OS on which Ant is executing matches the given OS architecture.
isDebugEnabled() - Static method in class org.apache.commons.exec.util.DebugUtils
Determines if debugging is enabled based on the system property "COMMONS_EXEC_DEBUG".
isFailure(int) - Method in class org.apache.commons.exec.DefaultExecutor
 
isFailure(int) - Method in interface org.apache.commons.exec.Executor
Checks whether exitValue signals a failure.
isFailure(int) - Method in interface org.apache.commons.exec.launcher.CommandLauncher
Checks whether exitValue signals a failure on the current system (OS specific).
isFailure(int) - Method in class org.apache.commons.exec.launcher.CommandLauncherImpl
 
isFailure(int) - Method in class org.apache.commons.exec.launcher.VmsCommandLauncher
 
isFamily(String) - Static method in class org.apache.commons.exec.OS
Determines if the OS on which Ant is executing matches the given OS family.
isFamilyDOS() - Static method in class org.apache.commons.exec.OS
 
isFamilyMac() - Static method in class org.apache.commons.exec.OS
 
isFamilyNetware() - Static method in class org.apache.commons.exec.OS
 
isFamilyOpenVms() - Static method in class org.apache.commons.exec.OS
 
isFamilyOS2() - Static method in class org.apache.commons.exec.OS
 
isFamilyOS400() - Static method in class org.apache.commons.exec.OS
 
isFamilyTandem() - Static method in class org.apache.commons.exec.OS
 
isFamilyUnix() - Static method in class org.apache.commons.exec.OS
 
isFamilyWin9x() - Static method in class org.apache.commons.exec.OS
 
isFamilyWindows() - Static method in class org.apache.commons.exec.OS
 
isFamilyZOS() - Static method in class org.apache.commons.exec.OS
 
isFile - Variable in class org.apache.commons.exec.CommandLine
Was a file being used to set the executable?
isFile() - Method in class org.apache.commons.exec.CommandLine
Was a file being used to set the executable?
isFinished() - Method in class org.apache.commons.exec.StreamPumper
Tells whether the end of the stream has been reached.
isHandleQuoting() - Method in class org.apache.commons.exec.CommandLine.Argument
 
isLenientEnabled() - Static method in class org.apache.commons.exec.util.DebugUtils
Determines if lenient mode is enabled.
isName(String) - Static method in class org.apache.commons.exec.OS
Determines if the OS on which Ant is executing matches the given OS name.
isOs(String, String, String, String) - Static method in class org.apache.commons.exec.OS
Determines if the OS on which Ant is executing matches the given OS family, name, architecture and version
isQuoted(String) - Static method in class org.apache.commons.exec.util.StringUtils
Determines if this is a quoted argument - either single or double quoted.
isVersion(String) - Static method in class org.apache.commons.exec.OS
Determines if the OS on which Ant is executing matches the given OS version.
isWatching() - Method in class org.apache.commons.exec.ExecuteWatchdog
Indicates whether or not the watchdog is still monitoring the process.

J

Java13CommandLauncher - Class in org.apache.commons.exec.launcher
A command launcher for JDK/JRE 1.3 (and higher).
Java13CommandLauncher() - Constructor for class org.apache.commons.exec.launcher.Java13CommandLauncher
Constructor

K

killedProcess - Variable in class org.apache.commons.exec.ExecuteWatchdog
Say whether or not the process was killed due to running overtime.
killedProcess() - Method in class org.apache.commons.exec.ExecuteWatchdog
Indicates whether the last process run was killed.

L

launch(CommandLine, Map<String, String>, File) - Method in class org.apache.commons.exec.DefaultExecutor
Creates a process that runs a command.
launcher - Variable in class org.apache.commons.exec.DefaultExecutor
launches the command in a new process
level - Variable in class org.apache.commons.exec.LogOutputStream
 
LF - Static variable in class org.apache.commons.exec.LogOutputStream
Linefeed
LogOutputStream - Class in org.apache.commons.exec
Base class to connect a logging system to the output and/or error stream of then external process.
LogOutputStream() - Constructor for class org.apache.commons.exec.LogOutputStream
Creates a new instance of this class.
LogOutputStream(int) - Constructor for class org.apache.commons.exec.LogOutputStream
Creates a new instance of this class.

M

MapUtils - Class in org.apache.commons.exec.util
Helper classes to manipulate maps to pass substition map to the CommandLine.
MapUtils() - Constructor for class org.apache.commons.exec.util.MapUtils
 
merge(Map<K, V>, Map<K, V>) - Static method in class org.apache.commons.exec.util.MapUtils
Clones the lhs map and add all things from the rhs map.
myLauncher - Variable in class org.apache.commons.exec.launcher.CommandLauncherProxy
 

O

observers - Variable in class org.apache.commons.exec.Watchdog
 
onProcessComplete(int) - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
 
onProcessComplete(int) - Method in interface org.apache.commons.exec.ExecuteResultHandler
The asynchronous execution completed.
onProcessFailed(ExecuteException) - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
 
onProcessFailed(ExecuteException) - Method in interface org.apache.commons.exec.ExecuteResultHandler
The asynchronous execution failed.
OpenVmsProcessingEnvironment - Class in org.apache.commons.exec.environment
Deprecated.
No longer needed
OpenVmsProcessingEnvironment() - Constructor for class org.apache.commons.exec.environment.OpenVmsProcessingEnvironment
Deprecated.
 
org.apache.commons.exec - package org.apache.commons.exec
 
org.apache.commons.exec.environment - package org.apache.commons.exec.environment
 
org.apache.commons.exec.launcher - package org.apache.commons.exec.launcher
 
org.apache.commons.exec.util - package org.apache.commons.exec.util
 
os - Variable in class org.apache.commons.exec.InputStreamPumper
the output stream to pmp into
OS - Class in org.apache.commons.exec
Condition that tests the OS type.
OS() - Constructor for class org.apache.commons.exec.OS
Default constructor
os - Variable in class org.apache.commons.exec.StreamPumper
the output stream to pmp into
OS2CommandLauncher - Class in org.apache.commons.exec.launcher
A command launcher for OS/2 that uses 'cmd.exe' when launching commands in directories other than the current working directory.
OS2CommandLauncher(CommandLauncher) - Constructor for class org.apache.commons.exec.launcher.OS2CommandLauncher
 
OS_ARCH - Static variable in class org.apache.commons.exec.OS
 
OS_NAME - Static variable in class org.apache.commons.exec.OS
 
OS_VERSION - Static variable in class org.apache.commons.exec.OS
 
out - Variable in class org.apache.commons.exec.PumpStreamHandler
 
outputThread - Variable in class org.apache.commons.exec.PumpStreamHandler
 

P

parse(String) - Static method in class org.apache.commons.exec.CommandLine
Create a command line from a string.
parse(String, Map<String, ?>) - Static method in class org.apache.commons.exec.CommandLine
Create a command line from a string.
parseEnvironmentVariable(String) - Static method in class org.apache.commons.exec.environment.EnvironmentUtils
Split a key/value pair into a String[].
PATH_SEP - Static variable in class org.apache.commons.exec.OS
 
prefix(Map<K, V>, String) - Static method in class org.apache.commons.exec.util.MapUtils
Clones a map and prefixes the keys in the clone, e.g.
procEnvironment - Variable in class org.apache.commons.exec.environment.DefaultProcessingEnvironment
the environment variables of the process
process - Variable in class org.apache.commons.exec.ExecuteWatchdog
The process to execute and watch for duration.
processBuffer() - Method in class org.apache.commons.exec.LogOutputStream
Converts the buffer to a string and sends it to processLine.
processDestroyer - Variable in class org.apache.commons.exec.DefaultExecutor
optional cleanup of started processes
ProcessDestroyer - Interface in org.apache.commons.exec
Destroys all registered Process after a certain event, typically when the VM exits
ProcessDestroyerImpl() - Constructor for class org.apache.commons.exec.ShutdownHookProcessDestroyer.ProcessDestroyerImpl
 
processes - Variable in class org.apache.commons.exec.ShutdownHookProcessDestroyer
the list of currently running processes
PROCESSING_ENVIRONMENT_IMPLEMENTATION - Static variable in class org.apache.commons.exec.environment.EnvironmentUtils
 
processLine(String) - Method in class org.apache.commons.exec.LogOutputStream
Logs a line to the log system of the user.
processLine(String, int) - Method in class org.apache.commons.exec.LogOutputStream
Logs a line to the log system of the user.
processStarted - Variable in class org.apache.commons.exec.ExecuteWatchdog
Indicates that the process is verified as started
PumpStreamHandler - Class in org.apache.commons.exec
Copies standard output and error of sub-processes to standard output and error of the parent process.
PumpStreamHandler() - Constructor for class org.apache.commons.exec.PumpStreamHandler
Construct a new PumpStreamHandler.
PumpStreamHandler(OutputStream) - Constructor for class org.apache.commons.exec.PumpStreamHandler
Construct a new PumpStreamHandler.
PumpStreamHandler(OutputStream, OutputStream) - Constructor for class org.apache.commons.exec.PumpStreamHandler
Construct a new PumpStreamHandler.
PumpStreamHandler(OutputStream, OutputStream, InputStream) - Constructor for class org.apache.commons.exec.PumpStreamHandler
Construct a new PumpStreamHandler.

Q

quoteArgument(String) - Static method in class org.apache.commons.exec.util.StringUtils
Put quotes around the given String if necessary.

R

remove(Process) - Method in interface org.apache.commons.exec.ProcessDestroyer
Returns true if the specified Process was successfully removed from the list of processes to be destroy.
remove(Process) - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer
Returns true if the specified Process was successfully removed from the list of processes to destroy upon VM exit.
removeShutdownHook() - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer
Removes this ProcessDestroyer as a shutdown hook, uses reflection to ensure pre-JDK 1.3 compatibility
removeTimeoutObserver(TimeoutObserver) - Method in class org.apache.commons.exec.Watchdog
 
run() - Method in class org.apache.commons.exec.InputStreamPumper
Copies data from the input stream to the output stream.
run() - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer.ProcessDestroyerImpl
 
run() - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer
Invoked by the VM when it is exiting.
run() - Method in class org.apache.commons.exec.StreamPumper
Copies data from the input stream to the output stream.
run() - Method in class org.apache.commons.exec.Watchdog
 
running - Variable in class org.apache.commons.exec.ShutdownHookProcessDestroyer
Whether or not this ProcessDestroyer is currently running as shutdown hook
runProcEnvCommand() - Method in class org.apache.commons.exec.environment.DefaultProcessingEnvironment
Deprecated.
No longer needed

S

serialVersionUID - Static variable in exception org.apache.commons.exec.ExecuteException
Comment for serialVersionUID.
setExceptionCaught(IOException) - Method in class org.apache.commons.exec.DefaultExecutor
Keep track of the first IOException being thrown.
setExitValue(int) - Method in class org.apache.commons.exec.DefaultExecutor
 
setExitValue(int) - Method in interface org.apache.commons.exec.Executor
Define the exitValue of the process to be considered successful.
setExitValues(int[]) - Method in class org.apache.commons.exec.DefaultExecutor
 
setExitValues(int[]) - Method in interface org.apache.commons.exec.Executor
Define a list of exitValue of the process to be considered successful.
setProcessDestroyer(ProcessDestroyer) - Method in class org.apache.commons.exec.DefaultExecutor
 
setProcessDestroyer(ProcessDestroyer) - Method in interface org.apache.commons.exec.Executor
Get the handler for cleanup of started processes if the main process is going to terminate.
setProcessErrorStream(InputStream) - Method in interface org.apache.commons.exec.ExecuteStreamHandler
Install a handler for the error stream of the subprocess.
setProcessErrorStream(InputStream) - Method in class org.apache.commons.exec.PumpStreamHandler
Set the InputStream from which to read the standard error of the process.
setProcessInputStream(OutputStream) - Method in interface org.apache.commons.exec.ExecuteStreamHandler
Install a handler for the input stream of the subprocess.
setProcessInputStream(OutputStream) - Method in class org.apache.commons.exec.PumpStreamHandler
Set the OutputStream by means of which input can be sent to the process.
setProcessNotStarted() - Method in class org.apache.commons.exec.ExecuteWatchdog
 
setProcessOutputStream(InputStream) - Method in interface org.apache.commons.exec.ExecuteStreamHandler
Install a handler for the output stream of the subprocess.
setProcessOutputStream(InputStream) - Method in class org.apache.commons.exec.PumpStreamHandler
Set the InputStream from which to read the standard output of the process.
setShouldDestroy(boolean) - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer.ProcessDestroyerImpl
 
setStopTimeout(long) - Method in class org.apache.commons.exec.PumpStreamHandler
Set maximum time to wait until output streams are exchausted when PumpStreamHandler.stop() was called.
setStreamHandler(ExecuteStreamHandler) - Method in class org.apache.commons.exec.DefaultExecutor
 
setStreamHandler(ExecuteStreamHandler) - Method in interface org.apache.commons.exec.Executor
Set a custom the StreamHandler used for providing input and retrieving the output.
setSubstitutionMap(Map<String, ?>) - Method in class org.apache.commons.exec.CommandLine
Set the substitutionMap to expand variables in the command line.
setWatchdog(ExecuteWatchdog) - Method in class org.apache.commons.exec.DefaultExecutor
 
setWatchdog(ExecuteWatchdog) - Method in interface org.apache.commons.exec.Executor
Set the watchdog used to kill of processes running, typically, too long time.
setWorkingDirectory(File) - Method in class org.apache.commons.exec.DefaultExecutor
 
setWorkingDirectory(File) - Method in interface org.apache.commons.exec.Executor
Set the working directory of the created process.
shouldDestroy - Variable in class org.apache.commons.exec.ShutdownHookProcessDestroyer.ProcessDestroyerImpl
 
ShutdownHookProcessDestroyer - Class in org.apache.commons.exec
Destroys all registered Processes when the VM exits.
ShutdownHookProcessDestroyer() - Constructor for class org.apache.commons.exec.ShutdownHookProcessDestroyer
Constructs a ProcessDestroyer and obtains Runtime.addShutdownHook() and Runtime.removeShutdownHook() through reflection.
ShutdownHookProcessDestroyer.ProcessDestroyerImpl - Class in org.apache.commons.exec
 
SINGLE_QUOTE - Static variable in class org.apache.commons.exec.util.StringUtils
 
size() - Method in interface org.apache.commons.exec.ProcessDestroyer
Returns the number of registered processes.
size() - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer
Returns the number of registered processes.
size - Variable in class org.apache.commons.exec.StreamPumper
the size of the internal buffer for copying the streams
skip - Variable in class org.apache.commons.exec.LogOutputStream
 
SLASH_CHAR - Static variable in class org.apache.commons.exec.util.StringUtils
 
SLEEP_TIME_MS - Static variable in class org.apache.commons.exec.DefaultExecuteResultHandler
the interval polling the result
SLEEPING_TIME - Static variable in class org.apache.commons.exec.InputStreamPumper
 
split(String, String) - Static method in class org.apache.commons.exec.util.StringUtils
Split a string into an array of strings based on a separator.
start() - Method in interface org.apache.commons.exec.ExecuteStreamHandler
Start handling of the streams.
start(Process) - Method in class org.apache.commons.exec.ExecuteWatchdog
Watches the given process and terminates it, if it runs for too long.
start() - Method in class org.apache.commons.exec.PumpStreamHandler
Start the Threads.
start() - Method in class org.apache.commons.exec.Watchdog
 
stop() - Method in interface org.apache.commons.exec.ExecuteStreamHandler
Stop handling of the streams - will not be restarted.
stop() - Method in class org.apache.commons.exec.ExecuteWatchdog
Stops the watcher.
stop - Variable in class org.apache.commons.exec.InputStreamPumper
flag to stop the stream pumping
stop() - Method in class org.apache.commons.exec.PumpStreamHandler
Stop pumping the streams.
stop() - Method in class org.apache.commons.exec.Watchdog
 
STOP_TIMEOUT_ADDITION - Static variable in class org.apache.commons.exec.PumpStreamHandler
 
stopped - Variable in class org.apache.commons.exec.Watchdog
 
stopProcessing() - Method in class org.apache.commons.exec.InputStreamPumper
 
stopThread(Thread, long) - Method in class org.apache.commons.exec.PumpStreamHandler
Stopping a pumper thread.
stopTimeout - Variable in class org.apache.commons.exec.PumpStreamHandler
the timeout in ms the implementation waits when stopping the pumper threads
streamHandler - Variable in class org.apache.commons.exec.DefaultExecutor
taking care of output and error stream
StreamPumper - Class in org.apache.commons.exec
Copies all data from an input stream to an output stream.
StreamPumper(InputStream, OutputStream, boolean) - Constructor for class org.apache.commons.exec.StreamPumper
Create a new stream pumper.
StreamPumper(InputStream, OutputStream, boolean, int) - Constructor for class org.apache.commons.exec.StreamPumper
Create a new stream pumper.
StreamPumper(InputStream, OutputStream) - Constructor for class org.apache.commons.exec.StreamPumper
Create a new stream pumper.
stringSubstitution(String, Map<? super String, ?>, boolean) - Static method in class org.apache.commons.exec.util.StringUtils
Perform a series of substitutions.
StringUtils - Class in org.apache.commons.exec.util
Supplement of commons-lang, the stringSubstitution() was in a simpler implementation available in an older commons-lang implementation.
StringUtils() - Constructor for class org.apache.commons.exec.util.StringUtils
 
substitutionMap - Variable in class org.apache.commons.exec.CommandLine
A map of name value pairs used to expand command line arguments

T

timeout - Variable in class org.apache.commons.exec.Watchdog
 
TimeoutObserver - Interface in org.apache.commons.exec
Interface for classes that want to be notified by Watchdog.
timeoutOccured(Watchdog) - Method in class org.apache.commons.exec.ExecuteWatchdog
Called after watchdog has finished.
timeoutOccured(Watchdog) - Method in interface org.apache.commons.exec.TimeoutObserver
Called when the watchdog times out.
toCleanExecutable(String) - Method in class org.apache.commons.exec.CommandLine
Cleans the executable string.
toString() - Method in class org.apache.commons.exec.CommandLine
Stringify operator returns the command line as a string.
toString(String[], String) - Static method in class org.apache.commons.exec.util.StringUtils
Concatenates an array of string using a separator.
toStrings() - Method in class org.apache.commons.exec.CommandLine
Returns the command line as an array of strings.
toStrings(Map<String, String>) - Static method in class org.apache.commons.exec.environment.EnvironmentUtils
Get the variable list as an array.
translateCommandline(String) - Static method in class org.apache.commons.exec.CommandLine
Crack a command line.

V

value - Variable in class org.apache.commons.exec.CommandLine.Argument
 
VmsCommandLauncher - Class in org.apache.commons.exec.launcher
A command launcher for VMS that writes the command to a temporary DCL script before launching commands.
VmsCommandLauncher() - Constructor for class org.apache.commons.exec.launcher.VmsCommandLauncher
 

W

waitFor() - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
Causes the current thread to wait, if necessary, until the process has terminated.
waitFor(long) - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
Causes the current thread to wait, if necessary, until the process has terminated.
waitFor() - Method in class org.apache.commons.exec.StreamPumper
This method blocks until the stream pumper finishes.
watch - Variable in class org.apache.commons.exec.ExecuteWatchdog
Say whether or not the watchdog is currently monitoring a process.
watchdog - Variable in class org.apache.commons.exec.DefaultExecutor
monitoring of long running processes
watchdog - Variable in class org.apache.commons.exec.ExecuteWatchdog
Will tell us whether timeout has occurred.
Watchdog - Class in org.apache.commons.exec
Generalization of ExecuteWatchdog
Watchdog(long) - Constructor for class org.apache.commons.exec.Watchdog
 
WinNTCommandLauncher - Class in org.apache.commons.exec.launcher
A command launcher for Windows XP/2000/NT that uses 'cmd.exe' when launching commands in directories other than the current working directory.
WinNTCommandLauncher(CommandLauncher) - Constructor for class org.apache.commons.exec.launcher.WinNTCommandLauncher
 
workingDirectory - Variable in class org.apache.commons.exec.DefaultExecutor
the working directory of the process
write(int) - Method in class org.apache.commons.exec.LogOutputStream
Write the data to the buffer and flush the buffer, if a line separator is detected.
write(byte[], int, int) - Method in class org.apache.commons.exec.LogOutputStream
Write a block of characters to the output stream
A B C D E F G H I J K L M O P Q R S T V W 
Skip navigation links