Index
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 specifiedProcess
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 specifiedProcess
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.
- 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.
B
- 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
- Builder() - Constructor for class org.apache.commons.exec.DefaultExecutor.Builder
- Builder() - Constructor for class org.apache.commons.exec.ExecuteWatchdog.Builder
- Builder() - Constructor for class org.apache.commons.exec.Watchdog.Builder
C
- 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.
- 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.
- 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
-
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
-
Create a command line without any arguments.
- CommandLine(String) - 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.
- 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.
- 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.
- 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
-
Deprecated.
- DaemonExecutor.Builder - Class in org.apache.commons.exec
-
Constructs a new builder.
- DebugUtils - Class in org.apache.commons.exec.util
-
Provides debugging support.
- DebugUtils() - Constructor for class org.apache.commons.exec.util.DebugUtils
- 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
-
Deprecated.
- DefaultExecutor.Builder<T> - Class in org.apache.commons.exec
-
Constructs a new builder.
- 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.
E
- EnvironmentUtils - Class in org.apache.commons.exec.environment
-
Wraps environment variables.
- 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.
- 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.
- ExecuteResultHandler - Interface in org.apache.commons.exec
-
The callback handlers for the result of asynchronous process execution.
- ExecuteStreamHandler - Interface in org.apache.commons.exec
-
Handles stream of subprocesses for
Executor
s. - ExecuteWatchdog - Class in org.apache.commons.exec
-
Destroys a process running for too long.
- ExecuteWatchdog(long) - Constructor for class org.apache.commons.exec.ExecuteWatchdog
-
Deprecated.
- 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.
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.
- 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. - getExecutable() - Method in class org.apache.commons.exec.CommandLine
-
Gets the executable.
- 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.
- 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.
- 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.
H
- handleException(String, Exception) - Static method in class org.apache.commons.exec.util.DebugUtils
-
Handles an exception based on the system properties.
- hasResult() - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
-
Tests whether the process exited and a result is available, i.e.
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.
- 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.
- INVALID_EXITVALUE - Static variable in interface org.apache.commons.exec.Executor
-
Invalid exit code.
- 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
- 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() - 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.
- 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 JDK/JRE 1.3 (and higher).
- Java13CommandLauncher() - Constructor for class org.apache.commons.exec.launcher.Java13CommandLauncher
-
Constructs a new instance.
K
- 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.
- 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
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.
O
- 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
-
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 - Class in org.apache.commons.exec
-
Condition that tests the OS type.
- 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.
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.
- 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
- processBuffer() - Method in class org.apache.commons.exec.LogOutputStream
-
Converts the buffer to a string and sends it to
processLine
. - ProcessDestroyer - Interface in org.apache.commons.exec
-
Destroys all registered
Process
after a certain event, typically when the VM exits. - 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.
- 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
.
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 specifiedProcess
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 specifiedProcess
was successfully removed from the list of processes to destroy upon VM exit. - 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
-
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
- runProcEnvCommand() - Method in class org.apache.commons.exec.environment.DefaultProcessingEnvironment
-
Deprecated.No longer needed.
S
- 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. - 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. - setStopTimeout(long) - Method in class org.apache.commons.exec.PumpStreamHandler
-
Deprecated.
- 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.
- 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
-
Deprecated.
- setWorkingDirectory(File) - Method in interface org.apache.commons.exec.Executor
-
Sets the working directory of the created process.
- ShutdownHookProcessDestroyer - Class in org.apache.commons.exec
-
Destroys all registered
Process
es when the VM exits. - ShutdownHookProcessDestroyer() - Constructor for class org.apache.commons.exec.ShutdownHookProcessDestroyer
-
Constructs a
ProcessDestroyer
and obtainsRuntime.addShutdownHook()
andRuntime.removeShutdownHook()
through reflection. - 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.
- 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
Thread
s. - 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.
- 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.
- 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.
- 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
T
- 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.
- 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
-
Deprecated.
- 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.
V
- 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() - 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
-
Deprecated.
- waitFor(Duration) - Method in class org.apache.commons.exec.DefaultExecuteResultHandler
-
Causes the current thread to wait, if necessary, until the process has terminated.
- Watchdog - Class in org.apache.commons.exec
-
Generalization of
ExecuteWatchdog
. - Watchdog(long) - Constructor for class org.apache.commons.exec.Watchdog
-
Deprecated.
- 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.
- 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.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
DaemonExecutor.Builder.get()
.