PumpStreamHandler (Apache Commons Exec 1.3 API)

java.lang.Object
- org.apache.commons.exec.PumpStreamHandler

All Implemented Interfaces:

ExecuteStreamHandler
```
public class PumpStreamHandler
extends Object
implements ExecuteStreamHandler
```
Copies standard output and error of sub-processes to standard output and error of the parent process. If output or error stream are set to null, any feedback from that stream will be lost.

Version:

$Id: PumpStreamHandler.java 1557263 2014-01-10 21:18:09Z ggregory $

Constructor Summary

Constructors
Constructor and Description
`PumpStreamHandler()` Construct a new `PumpStreamHandler`.
`PumpStreamHandler(OutputStream outAndErr)` Construct a new `PumpStreamHandler`.
`PumpStreamHandler(OutputStream out, OutputStream err)` Construct a new `PumpStreamHandler`.
`PumpStreamHandler(OutputStream out, OutputStream err, InputStream input)` Construct a new `PumpStreamHandler`.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`createProcessErrorPump(InputStream is, OutputStream os)` Create the pump to handle error output.
`protected void`	`createProcessOutputPump(InputStream is, OutputStream os)` Create the pump to handle process output.
`protected Thread`	`createPump(InputStream is, OutputStream os)` Creates a stream pumper to copy the given input stream to the given output stream.
`protected Thread`	`createPump(InputStream is, OutputStream os, boolean closeWhenExhausted)` Creates a stream pumper to copy the given input stream to the given output stream.
`protected OutputStream`	`getErr()` Get the error stream.
`protected OutputStream`	`getOut()` Get the output stream.
`void`	`setProcessErrorStream(InputStream is)` Set the `InputStream` from which to read the standard error of the process.
`void`	`setProcessInputStream(OutputStream os)` Set the `OutputStream` by means of which input can be sent to the process.
`void`	`setProcessOutputStream(InputStream is)` Set the `InputStream` from which to read the standard output of the process.
`void`	`setStopTimeout(long timeout)` Set maximum time to wait until output streams are exchausted when `stop()` was called.
`void`	`start()` Start the `Thread`s.
`void`	`stop()` Stop pumping the streams.
`protected void`	`stopThread(Thread thread, long timeout)` Stopping a pumper thread.

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

- Constructor Detail
  - PumpStreamHandler
```
public PumpStreamHandler()
```
    Construct a new PumpStreamHandler.
  - PumpStreamHandler
```
public PumpStreamHandler(OutputStream outAndErr)
```
    Construct a new PumpStreamHandler.
    
    Parameters:
    outAndErr - the output/error OutputStream.
  - PumpStreamHandler
```
public PumpStreamHandler(OutputStream out,
                 OutputStream err)
```
    Construct a new PumpStreamHandler.
    
    Parameters:
    out - the output OutputStream.
    err - the error OutputStream.
  - PumpStreamHandler
```
public PumpStreamHandler(OutputStream out,
                 OutputStream err,
                 InputStream input)
```
    Construct a new PumpStreamHandler.
    
    Parameters:
    out - the output OutputStream.
    err - the error OutputStream.
    input - the input InputStream.
- Method Detail
  - setStopTimeout
```
public void setStopTimeout(long timeout)
```
    Set maximum time to wait until output streams are exchausted when stop() was called.
    
    Parameters:
    timeout - timeout in milliseconds or zero to wait forever (default)
  - setProcessOutputStream
```
public void setProcessOutputStream(InputStream is)
```
    Set the InputStream from which to read the standard output of the process.
    
    Specified by:
    
    setProcessOutputStream in interface ExecuteStreamHandler
    
    Parameters:
    is - the InputStream.
  - setProcessErrorStream
```
public void setProcessErrorStream(InputStream is)
```
    Set the InputStream from which to read the standard error of the process.
    
    Specified by:
    
    setProcessErrorStream in interface ExecuteStreamHandler
    
    Parameters:
    is - the InputStream.
  - setProcessInputStream
```
public void setProcessInputStream(OutputStream os)
```
    Set the OutputStream by means of which input can be sent to the process.
    
    Specified by:
    
    setProcessInputStream in interface ExecuteStreamHandler
    
    Parameters:
    os - the OutputStream.
  - start
```
public void start()
```
    Start the Threads.
    
    Specified by:
    
    start in interface ExecuteStreamHandler
  - stop
```
public void stop()
          throws IOException
```
    Stop pumping the streams. When a timeout is specified it it is not guaranteed that the pumper threads are cleanly terminated.
    
    Specified by:
    
    stop in interface ExecuteStreamHandler
    
    Throws:
    
    IOException - thrown when an I/O exception occurs.
  - getErr
```
protected OutputStream getErr()
```
    Get the error stream.
    
    Returns:
    OutputStream.
  - getOut
```
protected OutputStream getOut()
```
    Get the output stream.
    
    Returns:
    OutputStream.
  - createProcessOutputPump
```
protected void createProcessOutputPump(InputStream is,
                           OutputStream os)
```
    Create the pump to handle process output.
    
    Parameters:
    is - the InputStream.
    os - the OutputStream.
  - createProcessErrorPump
```
protected void createProcessErrorPump(InputStream is,
                          OutputStream os)
```
    Create the pump to handle error output.
    
    Parameters:
    is - the InputStream.
    os - the OutputStream.
  - createPump
```
protected Thread createPump(InputStream is,
                OutputStream os)
```
    Creates a stream pumper to copy the given input stream to the given output stream. When the 'os' is an PipedOutputStream we are closing 'os' afterwards to avoid an IOException ("Write end dead").
    
    Parameters:
    is - the input stream to copy from
    os - the output stream to copy into
    
    Returns:
    the stream pumper thread
  - createPump
```
protected Thread createPump(InputStream is,
                OutputStream os,
                boolean closeWhenExhausted)
```
    Creates a stream pumper to copy the given input stream to the given output stream.
    
    Parameters:
    is - the input stream to copy from
    os - the output stream to copy into
    closeWhenExhausted - close the output stream when the input stream is exhausted
    
    Returns:
    the stream pumper thread
  - stopThread
```
protected void stopThread(Thread thread,
              long timeout)
```
    Stopping a pumper thread. The implementation actually waits longer than specified in 'timeout' to detect if the timeout was indeed exceeded. If the timeout was exceeded an IOException is created to be thrown to the caller.
    
    Parameters:
    thread - the thread to be stopped
    timeout - the time in ms to wait to join

Class PumpStreamHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PumpStreamHandler

PumpStreamHandler

PumpStreamHandler

PumpStreamHandler

Method Detail

setStopTimeout

setProcessOutputStream

setProcessErrorStream

setProcessInputStream

start

stop

getErr

getOut

createProcessOutputPump

createProcessErrorPump

createPump

createPump

stopThread