exec/com.smushytaco.exec/ManagedProcess

ManagedProcess

public class ManagedProcess implements ManagedProcessState

Managed OS Process (Executable, Program, Command). Created by build.

Intended for controlling external "tools", often "daemons", which produce some text-based control output. In this form not yet suitable for programs returning binary data via stdout (but could be extended).

Does reasonably extensive logging about what it's doing (contrary to Apache Commons Exec), including logging the processes stdout &stderr, into SLF4J (not the System.out.Console).

Author

Michael Vorburger

Neelesh Shastry

William Dutton

See also

Executor

Internally based on http://commons.apache.org/exec/ but intentionally not exposing this; could be switched later, if there is any need.

Properties

EXIT_VALUE_DESTROYED

public final static int EXIT_VALUE_DESTROYED

Synthetic exit code returned when this process was explicitly destroyed via destroy rather than terminating normally.

EXIT_VALUE_STILL_RUNNING

public final static int EXIT_VALUE_STILL_RUNNING

Synthetic exit code used to indicate that the process was still running when a bounded wait timed out (see waitForExitMaxMs).

Functions

public void destroy()

Kills the Process.

public int exitValue()

Returns the exit value for the subprocess.

public String getConsole()

Returns the recent console output captured from the process (stdout and stderr).

getExecutablePath

public Path getExecutablePath()

Returns the path of the executable that will be launched.

getLastConsoleLines

public String getLastConsoleLines()

Returns a formatted string with the last N lines of console output for diagnostics.

getProcLongName

public String getProcLongName()

Returns a descriptive name of the process suitable for logs (typically includes the command and, if available, the working directory).

public boolean isAlive()

Tests if this process is alive.

notifyProcessHalted

public void notifyProcessHalted()

Allows LoggingExecuteResultHandler to notify if process has halted (success or failure).

public synchronized ManagedProcess start()

Starts the Process.

startAndWaitForConsoleMessageMaxMs

public boolean startAndWaitForConsoleMessageMaxMs(String messageInConsole, long maxWaitUntilReturning)

Starts the Process and waits (blocks) until the process prints a certain message.

public int waitForExit()

Waits for the process to terminate.

waitForExitMaxMs

public int waitForExitMaxMs(long maxWaitUntilReturning)

Like waitForExit, but waits max.

waitForExitMaxMsOrDestroy

public ManagedProcess waitForExitMaxMsOrDestroy(long maxWaitUntilDestroyTimeout)

Like waitForExit, but waits max.

watchDogKilledProcess

public boolean watchDogKilledProcess()

Indicates whether the watchdog forcibly killed the process.