co.cask.cdap.runtime.spi.ssh

Interface SSHProcess

public interface SSHProcess

Represents a process launched via the SSHSession.execute(String...) method.

Method Summary

Modifier and Type	Method and Description
void	destroy() Attempts to stop the remote process by closing ssh channel.
int	exitValue() Returns the exit code of the remote process if it was completed.
InputStream	getErrorStream() Returns an InputStream for reading from the remote process stderr.
InputStream	getInputStream() Returns an InputStream for reading from the remote process stdout.
OutputStream	getOutputStream() Returns an OutputStream for writing to the remote process stdin.
int	waitFor() Blocks for the remote process to finish.
int	waitFor(long timeout, TimeUnit unit) Blocks for the remote process to finish.

Method Detail

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Returns an OutputStream for writing to the remote process stdin.

Returns:

an OutputStream

Throws:

IOException - if failed to open the stream

getInputStream

InputStream getInputStream()
                    throws IOException

Returns an InputStream for reading from the remote process stdout.

Returns:

an InputStream

Throws:

IOException - if failed to open the stream

getErrorStream

InputStream getErrorStream()
                    throws IOException

Returns an InputStream for reading from the remote process stderr.

Returns:

an InputStream

Throws:

IOException - if failed to open the stream

waitFor

int waitFor()
     throws InterruptedException

Blocks for the remote process to finish.

Returns:

the exit code of the process

Throws:

InterruptedException - if this thread is interrupted while waiting

waitFor

int waitFor(long timeout,
            TimeUnit unit)
     throws TimeoutException,
            InterruptedException

Blocks for the remote process to finish.

Parameters:

timeout - the maximum time to wait

unit - the TimeUnit for the timeout

Returns:

the exit code of the process

Throws:

TimeoutException - if the process is not yet terminated after the given timeout

InterruptedException - if this thread is interrupted while waiting

exitValue

int exitValue()
       throws IllegalThreadStateException

Returns the exit code of the remote process if it was completed.

Throws:

IllegalThreadStateException - if the process is not yet terminated

destroy

void destroy()

Attempts to stop the remote process by closing ssh channel.