GenericProcessConsole (SAFS API DOCUMENT)

java.lang.Object
- org.safs.tools.consoles.GenericProcessConsole

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

GenericProcessCapture, ProcessConsole
```
public class GenericProcessConsole
extends java.lang.Object
implements java.lang.Runnable
```
Continuously monitors the wrapped process out and err streams routing them to the local process System.out and System.err via debug(String) so they will not block.
By default, all System.out and System.err will go thru the debug() method. Users can change this behavior by overriding the debug() method and also by turning off the output of either or both of the streams via setShowOutStream(boolean) and setShowErrStream(boolean).
The class also attempts to see "unhandled exceptions" and store them in the exceptions Vector.
Normal usage might be something like below:
```
 
        Process process = runtime.exec(procstr);
        GenericProcessConsole console = new GenericProcessConsole(process);
        Thread athread = new Thread(console);
        athread.start();
  //we can wait until process is finished
        try{ athread.join();}catch(InterruptedException x){;}
        console.shutdown();//precaution
 
```
This class contains no extended SAFS dependencies and can be readily packaged and distributed for non-SAFS installations.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.io.BufferedReader`	`err`
`static java.lang.String`	`ERR_PREFIX` "ERR: "
`protected java.util.Vector`	`exceptions`
`protected boolean`	`exited` Returns true if the process we are capturing has exited.
`protected int`	`exitValue` Returns the exitValue returned from the underlying process.
`protected java.io.BufferedWriter`	`in`
`protected java.io.BufferedReader`	`out`
`static java.lang.String`	`OUT_PREFIX` "OUT: "
`protected java.lang.Process`	`process`
`protected boolean`	`showErrStream` set false to stop a copy of error stream data going to the debug sink.
`protected boolean`	`showOutStream` set false to stop a copy of output stream data going to the debug sink.
`(package private) boolean`	`shutdown`

Constructor Summary

Constructors
Constructor and Description
`GenericProcessConsole(java.lang.Process process)` Default (and only) public constructor for GenericProcessConsole.
`GenericProcessConsole(java.lang.Process process, boolean debug2Console)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_initialize(java.lang.Process process)`
`protected void`	`debug(java.lang.String message)` Writes to System.out .
`java.util.Vector`	`getExceptions()`
`int`	`getExceptionsCount()`
`int`	`getExitValue()` Get the process exitValue.
`boolean`	`isExited()` Returns true if the process we are capturing has exited.
`void`	`run()` Continuously monitors the process out and err streams routing them to the local process System.out and System.err.
`void`	`setShowErrStream(boolean showErr)` set true to have the error stream copied to the active debug sink
`void`	`setShowOutStream(boolean showOut)` set true to have the output stream copied to the active debug sink
`void`	`shutdown()` Call to set the shutdown flag to true to stop the running console thread.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - process
```
protected java.lang.Process process
```
  - out
```
protected java.io.BufferedReader out
```
  - err
```
protected java.io.BufferedReader err
```
  - in
```
protected java.io.BufferedWriter in
```
  - exceptions
```
protected java.util.Vector exceptions
```
  - shutdown
```
boolean shutdown
```
  - showOutStream
```
protected boolean showOutStream
```
    set false to stop a copy of output stream data going to the debug sink. Default setting is true.
  - showErrStream
```
protected boolean showErrStream
```
    set false to stop a copy of error stream data going to the debug sink. Default setting is true.
  - OUT_PREFIX
```
public static final java.lang.String OUT_PREFIX
```
    "OUT: "
    
    See Also:
    
    Constant Field Values
  - ERR_PREFIX
```
public static final java.lang.String ERR_PREFIX
```
    "ERR: "
    
    See Also:
    
    Constant Field Values
  - exitValue
```
protected int exitValue
```
    Returns the exitValue returned from the underlying process. The value is only valid if exited = true;
  - exited
```
protected boolean exited
```
    Returns true if the process we are capturing has exited. We may still be capturing additional data if a secondary process is being monitored, however.
- Constructor Detail
  - GenericProcessConsole
```
public GenericProcessConsole(java.lang.Process process)
```
    Default (and only) public constructor for GenericProcessConsole. The class instance does NOT start its own separate runnable Thread.
  - GenericProcessConsole
```
public GenericProcessConsole(java.lang.Process process,
                             boolean debug2Console)
```
- Method Detail
  - _initialize
```
protected void _initialize(java.lang.Process process)
```
  - getExitValue
```
public int getExitValue()
                 throws java.lang.IllegalStateException
```
    Get the process exitValue. Use isExited() first to avoid the IllegalStateException, if desired.
    
    Returns:
    
    exitValue or IllegalStateException if process has not exited.
    
    Throws:
    
    java.lang.IllegalStateException - if process is still running.
  - isExited
```
public boolean isExited()
```
    Returns true if the process we are capturing has exited. We may still be capturing additional data if a secondary process is being monitored, however.
    
    Returns:
    
    boolean, true if the process we are capturing has exited.
  - debug
```
protected void debug(java.lang.String message)
```
    Writes to System.out . Subclasses should override to log to alternate sinks.
    
    Parameters:
    
    message -
  - setShowOutStream
```
public void setShowOutStream(boolean showOut)
```
    set true to have the output stream copied to the active debug sink
  - setShowErrStream
```
public void setShowErrStream(boolean showErr)
```
    set true to have the error stream copied to the active debug sink
  - shutdown
```
public void shutdown()
```
    Call to set the shutdown flag to true to stop the running console thread.
  - getExceptions
```
public java.util.Vector getExceptions()
```
    Returns:
    
    Vector storing any Exceptions read from Process out and err streams.
  - getExceptionsCount
```
public int getExceptionsCount()
```
    Returns:
    
    the count of Exceptions in out or err streams, or 0.
  - run
```
public void run()
```
    Continuously monitors the process out and err streams routing them to the local process System.out and System.err. Also attempts to see "unhandled exceptions" and store them in the exceptions Vector. Will run indefinitely until the process exits on its own or the shutdown method is called.
    
    Specified by:
    
    run in interface java.lang.Runnable
    
    See Also:
    
    getExceptions(), shutdown()

Class GenericProcessConsole

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

process

out

err

in

exceptions

shutdown

showOutStream

showErrStream

OUT_PREFIX

ERR_PREFIX

exitValue

exited

Constructor Detail

GenericProcessConsole

GenericProcessConsole

Method Detail

_initialize

getExitValue

isExited

debug

setShowOutStream

setShowErrStream

shutdown

getExceptions

getExceptionsCount

run