Runs an external program.
closeStreams
public static void closeStreams(Process process)
Close the streams belonging to the given Process.
execute
public int execute()
throws IOException
Runs a process defined by the command line and returns its exit status.
- the exit status of the subprocess or
INVALID
.
getCommandline
public String[] getCommandline()
Returns the commandline used to create a subprocess.
- the commandline used to create a subprocess.
getEnvironment
public String[] getEnvironment()
Returns the environment used to create a subprocess.
- the environment used to create a subprocess.
getExitValue
public int getExitValue()
Query the exit value of the process.
- the exit value or Execute.INVALID if no exit value has
been received.
getProcEnvironment
public static Vector getProcEnvironment()
Find the list of environment variables for this process.
- a vector containing the environment variables.
The vector elements are strings formatted like variable = value.
getWorkingDirectory
public File getWorkingDirectory()
Return the working directory.
isFailure
public boolean isFailure()
Did this execute return in a failure.
- true if and only if the exit code is interpreted as a failure
isFailure
public static boolean isFailure(int exitValue)
Checks whether
exitValue
signals a failure on the current
system (OS specific).
Note that this method relies on the conventions of
the OS, it will return false results if the application you are
running doesn't follow these conventions. One notable
exception is the Java VM provided by HP for OpenVMS - it will
return 0 if successful (like on any other platform), but this
signals a failure on OpenVMS. So if you execute a new Java VM
on OpenVMS, you cannot trust this method.
exitValue
- the exit value (return code) to be checked.
true
if exitValue
signals a failure.
killedProcess
public boolean killedProcess()
Test for an untimely death of the process.
- true if a watchdog had to kill the process.
launch
public static Process launch(Project project,
String[] command,
String[] env,
File dir,
boolean useVM)
throws IOException
Creates a process that runs a command.
project
- the Project, only used for logging purposes, may be null.command
- the command to run.env
- the environment for the command.dir
- the working directory for the command.useVM
- use the built-in exec command for JDK 1.3 if available.
runCommand
public static void runCommand(Task task,
String[] cmdline)
throws BuildException
A utility method that runs an external command. Writes the output and
error streams of the command to the project log.
task
- The task that the command is part of. Used for loggingcmdline
- The command to execute.
setAntRun
public void setAntRun(Project project)
throws BuildException
Set the name of the antRun script using the project's value.
project
- the current project.
BuildException
- not clear when it is going to throw an exception, but
it is the method's signature.
setCommandline
public void setCommandline(String[] commandline)
Sets the commandline of the subprocess to launch.
commandline
- the commandline of the subprocess to launch.
setEnvironment
public void setEnvironment(String[] env)
Sets the environment variables for the subprocess to launch.
env
- array of Strings, each element of which has
an environment variable settings in format key=value.
setExitValue
protected void setExitValue(int value)
Set the exit value.
value
- exit value of the process.
setNewenvironment
public void setNewenvironment(boolean newenv)
Set whether to propagate the default environment or not.
newenv
- whether to propagate the process environment.
setSpawn
public void setSpawn(boolean spawn)
Set whether or not you want the process to be spawned.
Default is not spawned.
spawn
- if true you do not want Ant
to wait for the end of the process.
setStreamHandler
public void setStreamHandler(ExecuteStreamHandler streamHandler)
Set the stream handler to use.
streamHandler
- ExecuteStreamHandler.
setVMLauncher
public void setVMLauncher(boolean useVMLauncher)
Launch this execution through the VM, where possible, rather than through
the OS's shell. In some cases and operating systems using the shell will
allow the shell to perform additional processing such as associating an
executable with a script, etc.
useVMLauncher
- true if exec should launch through the VM,
false if the shell should be used to launch the
command.
setWorkingDirectory
public void setWorkingDirectory(File wd)
Sets the working directory of the process to execute.
This is emulated using the antRun scripts unless the OS is
Windows NT in which case a cmd.exe is spawned,
or MRJ and setting user.dir works, or JDK 1.3 and there is
official support in java.lang.Runtime.
wd
- the working directory of the process.
spawn
public void spawn()
throws IOException
Starts a process defined by the command line.
Ant will not wait for this process, nor log its output.
toString
public static String toString(ByteArrayOutputStream bos)
ByteArrayOutputStream#toString doesn't seem to work reliably on
OS/390, at least not the way we use it in the execution
context.
bos
- the output stream that one wants to read.
- the output stream as a string, read with
special encodings in the case of z/os and os/400.
waitFor
protected void waitFor(Process process)
Wait for a given process.
process
- the process one wants to wait for.