org.safs.tools.consoles

Class ProcessCapture

java.lang.Object

org.safs.tools.consoles.GenericProcessConsole

org.safs.tools.consoles.GenericProcessCapture

org.safs.tools.consoles.ProcessCapture

All Implemented Interfaces:

java.lang.Runnable

public class ProcessCapture
extends GenericProcessCapture

Attempts to capture out and err streams from a process for use by other processes. The process data is available via a Vector retrieved from getData().
By default, this subclass disables the out and err streams from appearing in the debug/console output.

This subclass writes to org.safs.Log (SAFS Debug Log) instead of to System.out

Normal usage might be something like below:

 
        Process process = runtime.exec(procstr);
        ProcessCapture console = new ProcessCapture(process);
        Thread athread = new Thread(console);
        athread.start();
  //we can wait until process is finished
        try{ athread.join();}catch(InterruptedException x){;}
        console.shutdown();//precaution
        Vector data = console.getData();
 

Alternatively, we can autostart the capture thread. We don't have to wait for it to end if we don't want to. The autostarted thread can be acquired, though:

 
        Process process = runtime.exec(procstr);
        ProcessCapture console = new ProcessCapture(process, null, true, true);
  //we can wait until process is finished if we want
        try{ console.thread.join();}catch(InterruptedException x){;}
        Vector data = console.getData();
        console.shutdown();//precautionary force shutdown
 

Data for the Error and Output streams is captured into the single Vector storage. The Error stream data is prefixed with the ERR_PREFIX, while the Output data is prefixed with the OUT_PREFIX.

In the latter example the out and err streams will also appear in any active debug() sink/console.

Author:

Carl Nagle

Field Summary

Fields inherited from class org.safs.tools.consoles.GenericProcessCapture

data, monitor, thread

Fields inherited from class org.safs.tools.consoles.GenericProcessConsole

err, ERR_PREFIX, exceptions, exited, exitValue, in, out, OUT_PREFIX, process, showErrStream, showOutStream, shutdown

Constructor Summary

Constructors

Constructor and Description
ProcessCapture(java.lang.Process process) Default Constructor for ProcessCapture.
ProcessCapture(java.lang.Process process, java.lang.String monitor, boolean autostart) Alternative constructor suggesting the IO thread should remain open as long as a secondary process/pid remains running.
ProcessCapture(java.lang.Process process, java.lang.String monitor, boolean autostart, boolean debug2console) Alternative constructor suggesting the IO thread should remain open as long as a secondary process/pid remains running.

Method Summary

Modifier and Type	Method and Description
protected void	debug(java.lang.String message) Writes to Log.debug(Object)--the SAFS Debug Log.

Methods inherited from class org.safs.tools.consoles.GenericProcessCapture

getData, getDataLineCount, run, waitOutput

Methods inherited from class org.safs.tools.consoles.GenericProcessConsole

_initialize, getExceptions, getExceptionsCount, getExitValue, isExited, setShowErrStream, setShowOutStream, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessCapture

public ProcessCapture(java.lang.Process process)

Default Constructor for ProcessCapture. This sets up a default console that does not monitor any secondary processes, does NOT autostart its own capture thread, and does not copy out and err streams to the debug() sink/console.

Parameters:

process - to capture IO in, out, and err streams.

See Also:

GenericProcessConsole.setShowOutStream(boolean), GenericProcessConsole.setShowErrStream(boolean)

ProcessCapture

public ProcessCapture(java.lang.Process process,
                      java.lang.String monitor,
                      boolean autostart)

Alternative constructor suggesting the IO thread should remain open as long as a secondary process/pid remains running. This instance also does not copy out and err streams to the debug() sink/console.

Parameters:

process - -- to capture IO in, out, and err streams.

monitor - -- optional secondary process name or pid to monitor for continued IO output.

autostart - -- true if we should automatically start the separate capture thread.

See Also:

GenericProcessConsole.setShowOutStream(boolean), GenericProcessConsole.setShowErrStream(boolean)

ProcessCapture

public ProcessCapture(java.lang.Process process,
                      java.lang.String monitor,
                      boolean autostart,
                      boolean debug2console)

Alternative constructor suggesting the IO thread should remain open as long as a secondary process/pid remains running. This constructor allows the caller to change the default behavior for the out and err streams being written to the debug() sink/console.

Parameters:

process - -- to capture IO in, out, and err streams.

monitor - -- optional secondary process name or pid to monitor for continued IO output.

autostart - -- true if we should automatically start the separate capture thread.

debug2console - -- true if out and err streams should appear in the debug sink/console. The streams do NOT appear in the debug sink/console by default.

Method Detail

debug

protected void debug(java.lang.String message)

Writes to Log.debug(Object)--the SAFS Debug Log. Subclasses should override to log to alternate sinks.

Overrides:

debug in class GenericProcessConsole

Parameters:

message -