com.peterphi.std.system.exec

Class BaseExeced

java.lang.Object

com.peterphi.std.system.exec.BaseExeced

Direct Known Subclasses:

Execed

public class BaseExeced
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	cmd
protected boolean	combinedOutput
protected int	exitCode
protected boolean	finished
java.lang.Object	monitor
protected java.lang.Process	process

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseExeced(java.util.List<java.lang.String> cmd, java.lang.Process p, boolean combinedOutput)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Thread	copy(java.io.InputStream in, java.io.Writer out)
protected java.lang.Thread	discard(java.io.InputStream in)
void	discardOutput() Indicates that the output of this process should be discarded
int	exitCode() Returns the exit code of the application, assuming it has already terminated.
protected void	finished(int exitCode)
java.io.InputStream	getStandardErrorStream()
java.io.OutputStream	getStandardInputStream()
java.io.InputStream	getStandardOutputStream()
boolean	isFinished() Determines if the application has completed yet
void	kill()
static BaseExeced	spawn(Exec e)
protected void	unexpectedFailure(java.io.IOException e)
int	waitForExit() Wait an indefinite amount of time for the process to exit
int	waitForExit(Deadline deadline) Waits for the process to exit; this method blocks until the process has completed (at which point it returns the process exit code) or until deadline has elapsed, at which point it returns Integer.MIN_VALUE
int	waitForExit(Deadline deadline, int expected) Wait until deadline for the process to exit, expecting the return code to be expected.
int	waitForExit(int expected) Wait an indefinite amount of time for the process to exit, expecting the return code to be expected.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

monitor

public final java.lang.Object monitor

cmd

protected final java.util.List<java.lang.String> cmd

process

protected final java.lang.Process process

combinedOutput

protected final boolean combinedOutput

finished

protected boolean finished

exitCode

protected int exitCode

Constructor Detail

BaseExeced

protected BaseExeced(java.util.List<java.lang.String> cmd,
          java.lang.Process p,
          boolean combinedOutput)

Method Detail

kill

public void kill()

isFinished

public boolean isFinished()

Determines if the application has completed yet

Returns:

true if the process has terminated, otherwise false

exitCode

public int exitCode()
             throws java.lang.IllegalThreadStateException

Returns the exit code of the application, assuming it has already terminated. If the process has not yet terminated then an IllegalStateException will be thrown

Returns:

the exit code of the process

Throws:

java.lang.IllegalStateException - if the process has not yet terminated

java.lang.IllegalThreadStateException

waitForExit

public int waitForExit(int expected)

Wait an indefinite amount of time for the process to exit, expecting the return code to be expected. If the output is not expected then a RuntimeException is thrown

Parameters:

expected - the expected return code

Returns:

the exit code of the process

Throws:

java.lang.RuntimeException - if the return code was not what was expected

waitForExit

public int waitForExit(Deadline deadline,
              int expected)

Wait until deadline for the process to exit, expecting the return code to be expected. If the output is not expected (or if the operation times out) then a RuntimeException is thrown
In the event of a timeout the process is not terminated

Parameters:

deadline -

expected -

Returns:

the exit code of the process

Throws:

java.lang.RuntimeException - if a timeout occurrs or if the return code was not what was expected

waitForExit

public int waitForExit()

Wait an indefinite amount of time for the process to exit

Returns:

the exit code of the process

waitForExit

public int waitForExit(Deadline deadline)

Waits for the process to exit; this method blocks until the process has completed (at which point it returns the process exit code) or until deadline has elapsed, at which point it returns Integer.MIN_VALUE

Parameters:

deadline -

Returns:

the exit code of the process

getStandardOutputStream

public java.io.InputStream getStandardOutputStream()

getStandardErrorStream

public java.io.InputStream getStandardErrorStream()

getStandardInputStream

public java.io.OutputStream getStandardInputStream()

discardOutput

public void discardOutput()

Indicates that the output of this process should be discarded

finished

protected void finished(int exitCode)

unexpectedFailure

protected void unexpectedFailure(java.io.IOException e)

copy

protected java.lang.Thread copy(java.io.InputStream in,
                    java.io.Writer out)

discard

protected java.lang.Thread discard(java.io.InputStream in)

spawn

public static BaseExeced spawn(Exec e)
                        throws java.io.IOException

Throws:

java.io.IOException