com.cerner.ccl.j4ccl.ssh

Class JSchSshTerminal

java.lang.Object

com.cerner.ccl.j4ccl.ssh.JSchSshTerminal

public class JSchSshTerminal
extends Object

A wrapper around a JSch and ChannelShell object to facilitate submission of commands through an emulated SSH terminal.

Author:

Joshua Hyde

Constructor Summary

Constructors

Constructor and Description
JSchSshTerminal() Create a terminal with no timeout.
JSchSshTerminal(com.cerner.ftp.jsch.ConnectionPool pool) Create a terminal.

Method Summary

Modifier and Type	Method and Description
TerminalResponse	executeCommandGroups(List<CommandExpectationGroup> commandExpectationGroups) Execute a list of CommandExpectationGroup.
void	setExpectationTimeout(long expectationTimeout) Sets the expectation timeout for this terminal.
void	setOutputStream(OutputStream stream) Set an output stream to which console output should be piped.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSchSshTerminal

public JSchSshTerminal()

Create a terminal with no timeout.

JSchSshTerminal

public JSchSshTerminal(com.cerner.ftp.jsch.ConnectionPool pool)

Create a terminal.

Parameters:

pool - A ConnectionPool from which connections are to be retrieved.

Method Detail

executeCommandGroups

public TerminalResponse executeCommandGroups(List<CommandExpectationGroup> commandExpectationGroups)
                                      throws SshException

Execute a list of CommandExpectationGroup. Consumers of this method should set the expectationTimeout if the default value needs to be overridden

Parameters:

commandExpectationGroups - The command expectation groups to execute.

Returns:

The TerminalResponse for executing the commands.

Throws:

SshException - The exception thrown if something goes wrong.

SshException

setOutputStream

public void setOutputStream(OutputStream stream)

Set an output stream to which console output should be piped.

Parameters:

stream - The OutputStream object to which SSH console data should be piped.

setExpectationTimeout

public void setExpectationTimeout(long expectationTimeout)

Sets the expectation timeout for this terminal.

Parameters:

expectationTimeout - The expecationTimout value to set. The value will not be set if the provided value is not positive. If the value was not previously set it will be the default value 20000.