com.helger.jsch.command

Class CommandRunner.ChannelExecWrapper

java.lang.Object

com.helger.jsch.command.CommandRunner.ChannelExecWrapper

Enclosing class:

CommandRunner

public class CommandRunner.ChannelExecWrapper
extends 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.

Constructor Summary

Constructors

Constructor and Description
ChannelExecWrapper(com.jcraft.jsch.Session session, String command, InputStream stdIn, OutputStream stdOut, OutputStream stdErr)

Method Summary

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.
InputStream	getErrStream() Returns the STDERR stream for you to read from.
InputStream	getInputStream() Returns the STDOUT stream for you to read from.
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

Constructor Detail

ChannelExecWrapper

public ChannelExecWrapper(@Nonnull
                          com.jcraft.jsch.Session session,
                          @Nonnull
                          String command,
                          @Nullable
                          InputStream stdIn,
                          @Nullable
                          OutputStream stdOut,
                          @Nullable
                          OutputStream stdErr)
                   throws com.jcraft.jsch.JSchException

Throws:

com.jcraft.jsch.JSchException

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 InputStream getErrStream()
                         throws 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:

IOException - If unable to read from the stream

getInputStream

public InputStream getInputStream()
                           throws 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:

IOException - If unable to read from the stream

getOutputStream

public OutputStream getOutputStream()
                             throws 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:

IOException - If unable to write to the stream