com.pastdev.jsch.command

Class CommandRunner.ChannelExecWrapper

java.lang.Object

com.pastdev.jsch.command.CommandRunner.ChannelExecWrapper

Enclosing class:

CommandRunner

public class CommandRunner.ChannelExecWrapper
extends java.lang.Object

Wraps the execution of a command to handle the opening and closing of all the data streams for you. To use this wrapper, you call getXxxStream() for the streams you want to work with, which will return an opened stream. Use the stream as needed then call close() on the ChannelExecWrapper itself, which will return the the exit code from the execution of the command.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.jcraft.jsch.ChannelExec	channel
protected java.lang.String	command
protected java.io.OutputStream	passedInStdErr
protected java.io.InputStream	passedInStdIn
protected java.io.OutputStream	passedInStdOut
protected java.io.InputStream	stdErr
protected java.io.OutputStream	stdIn
protected java.io.InputStream	stdOut

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandRunner.ChannelExecWrapper()
	CommandRunner.ChannelExecWrapper(com.jcraft.jsch.Session session, java.lang.String command, java.io.InputStream stdIn, java.io.OutputStream stdOut, java.io.OutputStream stdErr)

Method Summary

Methods

Modifier and Type	Method and Description
int	close() Safely closes all stream, waits for the underlying connection to close, then returns the exit code from the command execution.
java.io.InputStream	getErrStream() Returns the STDERR stream for you to read from.
java.io.InputStream	getInputStream() Returns the STDOUT stream for you to read from.
java.io.OutputStream	getOutputStream() Returns the STDIN stream for you to write to.

Methods inherited from class java.lang.Object

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

Field Detail

channel

protected com.jcraft.jsch.ChannelExec channel

command

protected java.lang.String command

passedInStdErr

protected java.io.OutputStream passedInStdErr

passedInStdIn

protected java.io.InputStream passedInStdIn

passedInStdOut

protected java.io.OutputStream passedInStdOut

stdErr

protected java.io.InputStream stdErr

stdIn

protected java.io.OutputStream stdIn

stdOut

protected java.io.InputStream stdOut

Constructor Detail

CommandRunner.ChannelExecWrapper

protected CommandRunner.ChannelExecWrapper()

CommandRunner.ChannelExecWrapper

public CommandRunner.ChannelExecWrapper(com.jcraft.jsch.Session session,
                                java.lang.String command,
                                java.io.InputStream stdIn,
                                java.io.OutputStream stdOut,
                                java.io.OutputStream stdErr)
                                 throws com.jcraft.jsch.JSchException,
                                        java.io.IOException

Throws:

com.jcraft.jsch.JSchException

java.io.IOException

Method Detail

close

public int close()

Safely closes all stream, waits for the underlying connection to close, then returns the exit code from the command execution.

Returns:

The exit code from the command execution

getErrStream

public java.io.InputStream getErrStream()
                                 throws java.io.IOException

Returns the STDERR stream for you to read from. No need to close this stream independently, instead, when done with all processing, call close();

Returns:

The STDERR stream

Throws:

java.io.IOException - If unable to read from the stream

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Returns the STDOUT stream for you to read from. No need to close this stream independently, instead, when done with all processing, call close();

Returns:

The STDOUT stream

Throws:

java.io.IOException - If unable to read from the stream

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Returns the STDIN stream for you to write to. No need to close this stream independently, instead, when done with all processing, call close();

Returns:

The STDIN stream

Throws:

java.io.IOException - If unable to write to the stream