Package org.jenkinsci.utils.process

Class ProcessInputStream

java.lang.Object

java.io.InputStream

org.jenkinsci.utils.process.ProcessInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ProcessInputStream
extends InputStream

Represents a reader end of the pipe to a running process.

Author:

Kohsuke Kawaguchi

See Also:

• CommandBuilder.popen()

Constructor Summary

Constructors

Constructor	Description
ProcessInputStream(Process p)

Method Summary

Modifier and Type	Method	Description
String	asText()	Reads the whole thing as a string.
int	available()
void	close()
InputStream	getInputStream()
Process	getProcess()	Gives underlying Process
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
long	skip(long n)
String	verifyOrDieWith(String errorMessage)	Waits for the process to complete.
int	waitFor()	Waits for the process to exit and returns its status code.
InputStream	withErrorCheck()	Decorates the input stream by forcing an read error in case the process exits with non-zero exit code.

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessInputStream

public ProcessInputStream(Process p)

Method Details

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

getInputStream

public InputStream getInputStream()

getProcess

public Process getProcess()

Gives underlying Process

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

waitFor

public int waitFor()
            throws InterruptedException

Waits for the process to exit and returns its status code.

Throws:

InterruptedException

asText

public String asText()
              throws IOException,
InterruptedException

Reads the whole thing as a string.

Throws:

IOException

InterruptedException

verifyOrDieWith

public String verifyOrDieWith(String errorMessage)
                       throws IOException,
InterruptedException

Waits for the process to complete. If the process returns a non-zero exit code, throw IOException with all the output from the process for diagnosis.

Throws:

IOException

InterruptedException

withErrorCheck

public InputStream withErrorCheck()

Decorates the input stream by forcing an read error in case the process exits with non-zero exit code.