Class PumpStreamHandler

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.

  • Field Details

    • STOP_TIMEOUT_ADDITION

      private static final Duration STOP_TIMEOUT_ADDITION
      Three seconds timeout.

    • outputThread

      private Thread outputThread
      Output thread.

    • errorThread

      private Thread errorThread
      Error thread.

    • inputThread

      private Thread inputThread
      Input thread.

    • outputStream

      private final OutputStream outputStream
      Output stream.

    • errorOutputStream

      private final OutputStream errorOutputStream
      Error output stream.

    • inputStream

      private final InputStream inputStream
      Error input stream.

    • inputStreamPumper

      private InputStreamPumper inputStreamPumper
      Pumper input stream.

    • stopTimeout

      private Duration stopTimeout
      The timeout Duration the implementation waits when stopping the pumper threads.

    • caught

      private IOException caught
      The last exception being caught.

    • threadFactory

      private final ThreadFactory threadFactory
      The thread factory.

  • Constructor Details

    • PumpStreamHandler

      public PumpStreamHandler()
      Constructs a new PumpStreamHandler.

    • PumpStreamHandler

      public PumpStreamHandler(OutputStream allOutputStream)
      Constructs a new PumpStreamHandler.
      Parameters:
      allOutputStream - the output/error OutputStream. The OutputStream implementation must be thread-safe because the output and error reader threads will concurrently write to it.

    • PumpStreamHandler

      public PumpStreamHandler(OutputStream outputStream, OutputStream errorOutputStream)
      Constructs a new PumpStreamHandler.

      If the same OutputStream instance is used for output and error, then it must be thread-safe because the output and error reader threads will concurrently write to it.

      Parameters:
      outputStream - the output OutputStream.
      errorOutputStream - the error OutputStream.

    • PumpStreamHandler

      public PumpStreamHandler(OutputStream outputStream, OutputStream errorOutputStream, InputStream inputStream)
      Constructs a new PumpStreamHandler.

      If the same OutputStream instance is used for output and error, then it must be thread-safe because the output and error reader threads will concurrently write to it.

      Parameters:
      outputStream - the output OutputStream.
      errorOutputStream - the error OutputStream.
      inputStream - the input InputStream.

    • PumpStreamHandler

      private PumpStreamHandler(ThreadFactory threadFactory, OutputStream outputStream, OutputStream errorOutputStream, InputStream inputStream)
      Constructs a new PumpStreamHandler.

      If the same OutputStream instance is used for output and error, then it must be thread-safe because the output and error reader threads will concurrently write to it.

      Parameters:
      outputStream - the output OutputStream.
      errorOutputStream - the error OutputStream.
      inputStream - the input InputStream.

  • Method Details

    • createProcessErrorPump

      protected void createProcessErrorPump(InputStream is, OutputStream os)
      Create the pump to handle error output.
      Parameters:
      is - the InputStream.
      os - the OutputStream.

    • createProcessOutputPump

      protected void createProcessOutputPump(InputStream is, OutputStream os)
      Create the pump to handle process 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' afterward 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.

    • createSystemInPump

      private Thread createSystemInPump(InputStream is, OutputStream os)
      Creates a stream pumper to copy the given input stream to the given output stream.
      Parameters:
      is - the System.in input stream to copy from.
      os - the output stream to copy into.
      Returns:
      the stream pumper thread.

    • getErr

      protected OutputStream getErr()
      Gets the error stream.
      Returns:
      OutputStream.

    • getOut

      protected OutputStream getOut()
      Gets the output stream.
      Returns:
      OutputStream.

    • getStopTimeout

      Duration getStopTimeout()

    • setProcessErrorStream

      public void setProcessErrorStream(InputStream is)
      Sets 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)
      Sets the OutputStream by means of which input can be sent to the process.
      Specified by:
      setProcessInputStream in interface ExecuteStreamHandler
      Parameters:
      os - the OutputStream.

    • setProcessOutputStream

      public void setProcessOutputStream(InputStream is)
      Sets the InputStream from which to read the standard output of the process.
      Specified by:
      setProcessOutputStream in interface ExecuteStreamHandler
      Parameters:
      is - the InputStream.

    • setStopTimeout

      public void setStopTimeout(Duration timeout)
      Sets maximum time to wait until output streams are exhausted when stop() was called.
      Parameters:
      timeout - timeout or zero to wait forever (default).
      Since:
      1.4.0

    • setStopTimeout

      @Deprecated public void setStopTimeout(long timeout)
      Deprecated.
      Use setStopTimeout(Duration).
      Sets maximum time to wait until output streams are exhausted when stop() was called.
      Parameters:
      timeout - timeout in milliseconds or zero to wait forever (default).

    • start

      public void start()
      Starts the Threads.
      Specified by:
      start in interface ExecuteStreamHandler

    • start

      private void start(Thread thread)
      Starts the given Thread.

    • stop

      public void stop() throws IOException
      Stops pumping the streams. When a timeout is specified 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.

    • stop

      private void stop(Thread thread, Duration timeout)
      Stops 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.

    • stopThread

      protected void stopThread(Thread thread, long timeoutMillis)
      Stops 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.
      timeoutMillis - the time in ms to wait to join.