Index

A B C D E F G H I J K L M N O P Q R S T V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

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[]) - 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, 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.
addTimeoutObserver(TimeoutObserver) - Method in class org.apache.commons.exec.Watchdog
Adds a TimeoutObserver.
addVariableToEnvironment(Map<String, String>, String) - Static method in class org.apache.commons.exec.environment.EnvironmentUtils
Adds 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.
asThis() - Method in class org.apache.commons.exec.DefaultExecutor.Builder
Returns this instance typed as the subclass type T.

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.
builder() - Static method in class org.apache.commons.exec.DaemonExecutor
Creates a new builder.
builder() - Static method in class org.apache.commons.exec.DefaultExecutor
Creates a new builder.
builder() - Static method in class org.apache.commons.exec.ExecuteWatchdog
Creates a new builder.
builder() - Static method in class org.apache.commons.exec.Watchdog
Creates a new builder.
Builder() - Constructor for class org.apache.commons.exec.DaemonExecutor.Builder
Constructs a new instance.
Builder() - Constructor for class org.apache.commons.exec.DefaultExecutor.Builder
Constructs a new instance.
Builder() - Constructor for class org.apache.commons.exec.ExecuteWatchdog.Builder
Constructs a new instance.
Builder() - Constructor for class org.apache.commons.exec.Watchdog.Builder
Constructs a new instance.
ByteArrayOutputStreamX(int) - Constructor for class org.apache.commons.exec.LogOutputStream.ByteArrayOutputStreamX
 

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.
charset - Variable in class org.apache.commons.exec.LogOutputStream
 
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.
checkWorkingDirectory() - Method in class org.apache.commons.exec.DefaultExecutor
 
checkWorkingDirectory(File) - Method in class org.apache.commons.exec.DefaultExecutor
 
checkWorkingDirectory(Path) - Method in class org.apache.commons.exec.DefaultExecutor
 
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.
closeCatch(Closeable) - Method in class org.apache.commons.exec.DefaultExecutor
Closes the Closeable, remembering any exception.
closeProcessStreams(Process) - Method in class org.apache.commons.exec.DefaultExecutor
Closes 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
Abstracts 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
Constructs a new instance.
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
Constructs a new instance.
CommandLine - Class in org.apache.commons.exec
CommandLine objects help handling command lines specifying processes to execute.
CommandLine(File) - Constructor for class org.apache.commons.exec.CommandLine
Constructs a command line without any arguments.
CommandLine(String) - Constructor for class org.apache.commons.exec.CommandLine
Constructs a command line without any arguments.
CommandLine(Path) - Constructor for class org.apache.commons.exec.CommandLine
Constructs 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
Writes the command into a temporary DCL script and returns the corresponding File object.
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
Creates 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
Creates 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
DaemonExecutor(ThreadFactory, ExecuteStreamHandler, Path) - Constructor for class org.apache.commons.exec.DaemonExecutor
 
DaemonExecutor.Builder - Class in org.apache.commons.exec
Constructs a new builder.
DARWIN - Static variable in class org.apache.commons.exec.OS
 
DebugUtils - Class in org.apache.commons.exec.util
Provides debugging support.
DebugUtils() - Constructor for class org.apache.commons.exec.util.DebugUtils
Deprecated.
Will be private in the next major version.
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
Constructs a new instance.
DefaultExecutor - Class in org.apache.commons.exec
The default class to start a subprocess.
DefaultExecutor() - Constructor for class org.apache.commons.exec.DefaultExecutor
DefaultExecutor(ThreadFactory, ExecuteStreamHandler, Path) - Constructor for class org.apache.commons.exec.DefaultExecutor
 
DefaultExecutor.Builder<T> - Class in org.apache.commons.exec
Constructs a new DefaultExecutor.
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
Constructs a new instance.
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

EMPTY_STRING_ARRAY - Static variable in class org.apache.commons.exec.util.StringUtils
 
ensureStarted() - Method in class org.apache.commons.exec.ExecuteWatchdog
Ensures that the process is started or not already terminated so we do not race with asynch executionor hang forever.
ENVIRONMENT - Static variable in class org.apache.commons.exec.environment.EnvironmentUtils
 
EnvironmentUtils - Class in org.apache.commons.exec.environment
Wraps environment variables.
EnvironmentUtils() - Constructor for class org.apache.commons.exec.environment.EnvironmentUtils
Hides constructor.
errorOutputStream - 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
Executes the given command in a new process.
exec(CommandLine, Map<String, String>) - 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>) - 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 interface org.apache.commons.exec.launcher.CommandLauncher
Executes 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.CommandLauncherImpl
 
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>, 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.
exec(CommandLine, Map<String, String>, Path) - Method in interface org.apache.commons.exec.launcher.CommandLauncher
Executes 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) - Method in interface org.apache.commons.exec.Executor
Executes a command synchronously.
execute(CommandLine, Map<String, String>) - Method in class org.apache.commons.exec.DefaultExecutor
 
execute(CommandLine, Map<String, String>) - Method in interface org.apache.commons.exec.Executor
Executes a command synchronously.
execute(CommandLine, Map<String, String>, ExecuteResultHandler) - Method in class org.apache.commons.exec.DefaultExecutor
 
execute(CommandLine, Map<String, String>, ExecuteResultHandler) - Method in interface org.apache.commons.exec.Executor
Executes a command asynchronously.
execute(CommandLine, ExecuteResultHandler) - Method in class org.apache.commons.exec.DefaultExecutor
 
execute(CommandLine, ExecuteResultHandler) - Method in interface org.apache.commons.exec.Executor
Executes a command asynchronously.
ExecuteException - Exception Class in org.apache.commons.exec
An exception indicating that the executing a subprocesses failed.
ExecuteException(String, int) - Constructor for exception class org.apache.commons.exec.ExecuteException
Constructs a new exception with the specified detail message.
ExecuteException(String, int, Throwable) - Constructor for exception class org.apache.commons.exec.ExecuteException
Constructs a new exception with the specified detail message and cause.
executeInternal(CommandLine, Map<String, String>, Path, 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 - Variable in class org.apache.commons.exec.DefaultExecutor.Builder
 
executeStreamHandler - Variable in class org.apache.commons.exec.DefaultExecutor
Taking care of output and error stream.
ExecuteStreamHandler - Interface in org.apache.commons.exec
Handles stream of subprocesses for Executors.
ExecuteWatchdog - Class in org.apache.commons.exec
Destroys a process running for too long.
ExecuteWatchdog(long) - Constructor for class org.apache.commons.exec.ExecuteWatchdog
ExecuteWatchdog(ThreadFactory, Duration) - Constructor for class org.apache.commons.exec.ExecuteWatchdog
Creates a new watchdog with a given timeout.
ExecuteWatchdog.Builder - Class in org.apache.commons.exec
Builds ExecuteWatchdog instances.
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 class 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

failedToStart(Exception) - Method in class org.apache.commons.exec.ExecuteWatchdog
Notification that starting the process failed.
FAMILY_9X - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_DOS - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_MAC - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_NETWARE - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_NT - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_OS2 - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_OS400 - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_TANDEM - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_UNIX - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_VMS - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_WINDOWS - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
FAMILY_ZOS - Static variable in class org.apache.commons.exec.OS
OS family that can be tested for.
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
Fires a timeout occurred event for each observer.
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
Flushes this log stream.

G

get() - Method in class org.apache.commons.exec.DaemonExecutor.Builder
Creates a new configured DaemonExecutor.
get() - Method in class org.apache.commons.exec.DefaultExecutor.Builder
Creates a new configured DefaultExecutor.
get() - Method in class org.apache.commons.exec.ExecuteWatchdog.Builder
Creates a new configured ExecuteWatchdog.
get() - Method in class org.apache.commons.exec.Watchdog.Builder
Creates a new configured ExecuteWatchdog.
getArguments() - Method in class org.apache.commons.exec.CommandLine
Gets the expanded and quoted command line arguments.
getErr() - Method in class org.apache.commons.exec.PumpStreamHandler
Gets the error stream.
getException() - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
Gets the exception causing the process execution to fail.
getExceptionCaught() - Method in class org.apache.commons.exec.DefaultExecutor
Gets the first IOException being thrown.
getExecutable() - Method in class org.apache.commons.exec.CommandLine
Gets the executable.
getExecuteStreamHandler() - Method in class org.apache.commons.exec.DefaultExecutor.Builder
 
getExecutorThread() - Method in class org.apache.commons.exec.DefaultExecutor
Gets the worker thread being used for asynchronous execution.
getExitValue() - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
Gets the exitValue of the process.
getExitValue() - Method in exception class org.apache.commons.exec.ExecuteException
Gets the exit value returned by the failed process.
getMessageLevel() - Method in class org.apache.commons.exec.LogOutputStream
Gets the trace level of the log system.
getOut() - Method in class org.apache.commons.exec.PumpStreamHandler
Gets 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
Gets the list of environment variables for this process.
getProcEnvironment() - Static method in class org.apache.commons.exec.environment.EnvironmentUtils
Gets 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
Sets the handler for cleanup of started processes if the main process is going to terminate.
getStopTimeout() - Method in class org.apache.commons.exec.PumpStreamHandler
 
getStreamHandler() - Method in class org.apache.commons.exec.DefaultExecutor
 
getStreamHandler() - Method in interface org.apache.commons.exec.Executor
Gets the StreamHandler used for providing input and retrieving the output.
getSubstitutionMap() - Method in class org.apache.commons.exec.CommandLine
Gets the substitution map.
getThreadFactory() - Method in class org.apache.commons.exec.DefaultExecutor.Builder
 
getThreadFactory() - Method in class org.apache.commons.exec.DefaultExecutor
Gets the thread factory.
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
Gets 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
Gets the working directory of the created process.
getWorkingDirectoryPath() - Method in class org.apache.commons.exec.DefaultExecutor.Builder
 
getWorkingDirectoryPath() - Method in interface org.apache.commons.exec.Executor
Gets 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
Tests whether 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.
INFINITE_TIMEOUT_DURATION - Static variable in class org.apache.commons.exec.ExecuteWatchdog
The marker for an infinite timeout.
inputStream - Variable in class org.apache.commons.exec.PumpStreamHandler
 
inputStreamPumper - 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.
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
Tests whether or not the ProcessDestroyer is registered as shutdown hook.
isArch(String) - Static method in class org.apache.commons.exec.OS
Tests whether the OS on which commons-exec 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".
isEmpty() - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer
Tests emptiness (size == 0).
isFailure(int) - Method in class org.apache.commons.exec.DefaultExecutor
 
isFailure(int) - Method in interface org.apache.commons.exec.Executor
Tests whether exitValue signals a failure.
isFailure(int) - Method in interface org.apache.commons.exec.launcher.CommandLauncher
Tests 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
Tests whether the OS on which commons-exec is executing matches the given OS family.
isFamilyDOS() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the DOS family.
isFamilyMac() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the Mac family.
isFamilyNetware() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the Netware family.
isFamilyOpenVms() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the OpenVMS family.
isFamilyOS2() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the OS/2 family.
isFamilyOS400() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the OS/400 family.
isFamilyTandem() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the Tandem family.
isFamilyUnix() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the Unix family.
isFamilyWin9x() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the Windows 9x family.
isFamilyWindows() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the Windows family.
isFamilyWinNT() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the Windows NT family.
isFamilyZOS() - Static method in class org.apache.commons.exec.OS
Tests whether the OS is in the z/OS family.
isFile - Variable in class org.apache.commons.exec.CommandLine
Tests whether a file was used to set the executable.
isFile() - Method in class org.apache.commons.exec.CommandLine
Tests whether a file was used to set the executable.
isFinished() - Method in class org.apache.commons.exec.StreamPumper
Tests 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
Tests whether if the OS on which commons-exec is executing matches the given OS name.
isOs(String, String, String, String) - Static method in class org.apache.commons.exec.OS
Tests whether the OS on which commons-exec 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
Tests whether the OS on which commonss-exec 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 Java 1.3 (and higher).
Java13CommandLauncher() - Constructor for class org.apache.commons.exec.launcher.Java13CommandLauncher
Constructs a new instance.

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.
launch(CommandLine, Map<String, String>, Path) - 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.
launcher - Variable in class org.apache.commons.exec.launcher.CommandLauncherProxy
The command launcher to use.
level - Variable in class org.apache.commons.exec.LogOutputStream
 
LF - Static variable in class org.apache.commons.exec.LogOutputStream
Line-feed.
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.
LogOutputStream(int, Charset) - Constructor for class org.apache.commons.exec.LogOutputStream
Creates a new instance of this class, specifying the character set that should be used for outputting the string for each line
LogOutputStream.ByteArrayOutputStreamX - Class in org.apache.commons.exec
 

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
Deprecated.
Will be private in the next major version.
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.

N

newThread(ThreadFactory, Runnable, String, boolean) - Static method in class org.apache.commons.exec.ThreadUtil
Creates a new Thread from the given factory and prefixes it's name with a prefix and sets the daemon flag.

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.
Constructs a new instance.
org.apache.commons.exec - package org.apache.commons.exec
The main Apache Commons Exec package.
org.apache.commons.exec.environment - package org.apache.commons.exec.environment
Queries the operating system environment.
org.apache.commons.exec.launcher - package org.apache.commons.exec.launcher
Operating system dependent command launchers are abstracted by the interface CommandLauncher.
org.apache.commons.exec.util - package org.apache.commons.exec.util
Gathers utilities.
os - Variable in class org.apache.commons.exec.InputStreamPumper
The output stream to pmp into.
os - Variable in class org.apache.commons.exec.StreamPumper
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
Avoids instances.
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
 
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
Constructs a new instance.
outputStream - 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
Parses 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.
ProcessDestroyerThread() - Constructor for class org.apache.commons.exec.ShutdownHookProcessDestroyer.ProcessDestroyerThread
 
processes - Variable in class org.apache.commons.exec.ShutdownHookProcessDestroyer
The list of currently running processes.
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
Constructs a new PumpStreamHandler.
PumpStreamHandler(OutputStream) - Constructor for class org.apache.commons.exec.PumpStreamHandler
Constructs a new PumpStreamHandler.
PumpStreamHandler(OutputStream, OutputStream) - Constructor for class org.apache.commons.exec.PumpStreamHandler
Constructs a new PumpStreamHandler.
PumpStreamHandler(OutputStream, OutputStream, InputStream) - Constructor for class org.apache.commons.exec.PumpStreamHandler
Constructs a new PumpStreamHandler.
PumpStreamHandler(ThreadFactory, OutputStream, OutputStream, InputStream) - Constructor for class org.apache.commons.exec.PumpStreamHandler
Constructs 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.
removeTimeoutObserver(TimeoutObserver) - Method in class org.apache.commons.exec.Watchdog
Removes a TimeoutObserver.
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.ProcessDestroyerThread
 
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 class org.apache.commons.exec.ExecuteException
Comment for serialVersionUID.
setExceptionCaught(IOException) - Method in class org.apache.commons.exec.DefaultExecutor
Sets the first IOException thrown.
setExecuteStreamHandler(ExecuteStreamHandler) - Method in class org.apache.commons.exec.DefaultExecutor.Builder
Sets the PumpStreamHandler.
setExitValue(int) - Method in class org.apache.commons.exec.DefaultExecutor
 
setExitValue(int) - Method in interface org.apache.commons.exec.Executor
Sets 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
Sets 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
Sets 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
Sets a handler for the error stream of the subprocess.
setProcessErrorStream(InputStream) - Method in class org.apache.commons.exec.PumpStreamHandler
Sets the InputStream from which to read the standard error of the process.
setProcessInputStream(OutputStream) - Method in interface org.apache.commons.exec.ExecuteStreamHandler
Sets a handler for the input stream of the subprocess.
setProcessInputStream(OutputStream) - Method in class org.apache.commons.exec.PumpStreamHandler
Sets 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
Sets a handler for the output stream of the subprocess.
setProcessOutputStream(InputStream) - Method in class org.apache.commons.exec.PumpStreamHandler
Sets the InputStream from which to read the standard output of the process.
setShouldDestroy(boolean) - Method in class org.apache.commons.exec.ShutdownHookProcessDestroyer.ProcessDestroyerThread
 
setStopTimeout(long) - Method in class org.apache.commons.exec.PumpStreamHandler
setStopTimeout(Duration) - Method in class org.apache.commons.exec.PumpStreamHandler
Sets maximum time to wait until output streams are exhausted 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
Sets a custom the StreamHandler used for providing input and retrieving the output.
setStreams(ExecuteStreamHandler, Process) - Method in class org.apache.commons.exec.DefaultExecutor
 
setSubstitutionMap(Map<String, ?>) - Method in class org.apache.commons.exec.CommandLine
Sets the substitutionMap to expand variables in the command line.
setThreadFactory(ThreadFactory) - Method in class org.apache.commons.exec.DefaultExecutor.Builder
Sets the ThreadFactory.
setThreadFactory(ThreadFactory) - Method in class org.apache.commons.exec.ExecuteWatchdog.Builder
Sets the thread factory.
setThreadFactory(ThreadFactory) - Method in class org.apache.commons.exec.Watchdog.Builder
Sets the thread factory.
setTimeout(Duration) - Method in class org.apache.commons.exec.ExecuteWatchdog.Builder
Sets the timeout duration.
setTimeout(Duration) - Method in class org.apache.commons.exec.Watchdog.Builder
Sets the timeout duration.
setWatchdog(ExecuteWatchdog) - Method in class org.apache.commons.exec.DefaultExecutor
 
setWatchdog(ExecuteWatchdog) - Method in interface org.apache.commons.exec.Executor
Sets the watchdog used to kill of processes running, typically, too long time.
setWorkingDirectory(File) - Method in class org.apache.commons.exec.DefaultExecutor.Builder
Sets the working directory.
setWorkingDirectory(File) - Method in class org.apache.commons.exec.DefaultExecutor
setWorkingDirectory(File) - Method in interface org.apache.commons.exec.Executor
Sets the working directory of the created process.
setWorkingDirectory(Path) - Method in class org.apache.commons.exec.DefaultExecutor.Builder
Sets the working directory.
shouldDestroy - Variable in class org.apache.commons.exec.ShutdownHookProcessDestroyer.ProcessDestroyerThread
 
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.ProcessDestroyerThread - Class in org.apache.commons.exec
 
SINGLE_QUOTE - Static variable in class org.apache.commons.exec.util.StringUtils
 
size - Variable in class org.apache.commons.exec.StreamPumper
The size of the internal buffer for copying the streams.
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.
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
Sleep time in milliseconds.
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
Starts handling of the streams.
start() - Method in class org.apache.commons.exec.PumpStreamHandler
Starts the Threads.
start() - Method in class org.apache.commons.exec.Watchdog
Starts a new thread.
start(Process) - Method in class org.apache.commons.exec.ExecuteWatchdog
Watches the given process and terminates it, if it runs for too long.
start(Thread) - Method in class org.apache.commons.exec.PumpStreamHandler
Starts the given Thread.
stop - Variable in class org.apache.commons.exec.InputStreamPumper
Flag to stop the stream pumping.
stop() - Method in interface org.apache.commons.exec.ExecuteStreamHandler
Stops handling of the streams - will not be restarted.
stop() - Method in class org.apache.commons.exec.ExecuteWatchdog
Stops the watcher.
stop() - Method in class org.apache.commons.exec.PumpStreamHandler
Stops pumping the streams.
stop() - Method in class org.apache.commons.exec.Watchdog
Requests a thread stop.
stop(Thread, Duration) - Method in class org.apache.commons.exec.PumpStreamHandler
Stops a pumper thread.
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
Requests processing to stop.
stopThread(Thread, long) - Method in class org.apache.commons.exec.PumpStreamHandler
Stops a pumper thread.
stopTimeout - Variable in class org.apache.commons.exec.PumpStreamHandler
The timeout Duration the implementation waits when stopping the pumper threads.
StreamPumper - Class in org.apache.commons.exec
Copies all data from an input stream to an output stream.
StreamPumper(InputStream, OutputStream) - Constructor for class org.apache.commons.exec.StreamPumper
Constructs a new stream pumper.
StreamPumper(InputStream, OutputStream, boolean) - Constructor for class org.apache.commons.exec.StreamPumper
Constructs a new stream pumper.
StreamPumper(InputStream, OutputStream, boolean, int) - Constructor for class org.apache.commons.exec.StreamPumper
Constructs 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
Deprecated.
Will be private in the next major version.
substitutionMap - Variable in class org.apache.commons.exec.CommandLine
A map of name value pairs used to expand command line arguments.

T

threadFactory - Variable in class org.apache.commons.exec.DefaultExecutor.Builder
 
threadFactory - Variable in class org.apache.commons.exec.DefaultExecutor
The thread factory.
threadFactory - Variable in class org.apache.commons.exec.ExecuteWatchdog.Builder
 
threadFactory - Variable in class org.apache.commons.exec.ExecuteWatchdog
The thread factory.
threadFactory - Variable in class org.apache.commons.exec.PumpStreamHandler
The thread factory.
threadFactory - Variable in class org.apache.commons.exec.Watchdog.Builder
 
threadFactory - Variable in class org.apache.commons.exec.Watchdog
The thread factory.
ThreadUtil - Class in org.apache.commons.exec
Internal thread helper.
ThreadUtil() - Constructor for class org.apache.commons.exec.ThreadUtil
 
timeout - Variable in class org.apache.commons.exec.ExecuteWatchdog.Builder
 
timeout - Variable in class org.apache.commons.exec.Watchdog.Builder
 
timeoutMillis - 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) - Static method in class org.apache.commons.exec.environment.EnvironmentUtils
 
toString(String[], String) - Static method in class org.apache.commons.exec.util.StringUtils
toString(Charset) - Method in class org.apache.commons.exec.LogOutputStream.ByteArrayOutputStreamX
 
toStrings() - Method in class org.apache.commons.exec.CommandLine
Converts the command line as an array of strings.
toStrings(Map<String, String>) - Static method in class org.apache.commons.exec.environment.EnvironmentUtils
Converts a variable map 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
Constructs a new instance.

W

waitFor() - 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.
waitFor(long) - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
waitFor(Duration) - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
Causes the current thread to wait, if necessary, until the process has terminated.
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
Deprecated.
Use get().
Watchdog(ThreadFactory, Duration) - Constructor for class org.apache.commons.exec.Watchdog
Constructs a new instance.
Watchdog.Builder - Class in org.apache.commons.exec
Builds ExecuteWatchdog instances.
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
Constructs a new instance.
workingDirectory - Variable in class org.apache.commons.exec.DefaultExecutor.Builder
 
workingDirectory - Variable in class org.apache.commons.exec.DefaultExecutor
The working directory of the process.
write(byte[], int, int) - Method in class org.apache.commons.exec.LogOutputStream
Writes a block of characters to the output stream.
write(int) - Method in class org.apache.commons.exec.LogOutputStream
Writes the data to the buffer and flush the buffer, if a line separator is detected.
A B C D E F G H I J K L M N O P Q R S T V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form