com.cerner.ccl.j4ccl.ssh

Class CclCommandTerminal

java.lang.Object

com.cerner.ccl.j4ccl.ssh.CclCommandTerminal

public class CclCommandTerminal
extends Object

A forwarding object that wraps JSchSshTerminal to facilitate accessing CCL, authenticating, executing commands, and logging.

Author:

Joshua Hyde

Field Summary

Fields

Modifier and Type	Field and Description
static String	CCL_ABORT_PATTERN A regex for the string that is output when CCL aborts.
static String	CCL_VIEWER_PATTERN A regex for the header row in CCL's results viewer.

Constructor Summary

Constructors

Constructor and Description
CclCommandTerminal(com.cerner.ccl.j4ccl.TerminalProperties terminalProperties, OutputStreamConfiguration streamConfiguration) Create a CCL command proxy out of the given configuration.

Method Summary

Modifier and Type	Method and Description
void	executeCommands(JSchSshTerminal terminal, List<String> commands, boolean authenticate) Launches a CCL session, authenticated if authentication is specified, executes a provided list of CCL commands and exits the CCL session.
com.cerner.ccl.j4ccl.TerminalProperties	getTerminalProperties() Retrieves the TerminalProperties object currently in effect for this CclCommandTerminal.

Methods inherited from class java.lang.Object

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

Field Detail

CCL_VIEWER_PATTERN

public static final String CCL_VIEWER_PATTERN

A regex for the header row in CCL's results viewer.

See Also:

Constant Field Values

CCL_ABORT_PATTERN

public static final String CCL_ABORT_PATTERN

A regex for the string that is output when CCL aborts.

See Also:

Constant Field Values

Constructor Detail

CclCommandTerminal

public CclCommandTerminal(com.cerner.ccl.j4ccl.TerminalProperties terminalProperties,
                          OutputStreamConfiguration streamConfiguration)

Create a CCL command proxy out of the given configuration.

Parameters:

terminalProperties - The TerminalProperties to apply to this terminal.

streamConfiguration - The configured location to which output should be written.

Method Detail

executeCommands

public void executeCommands(JSchSshTerminal terminal,
                            List<String> commands,
                            boolean authenticate)
                     throws SshException

Launches a CCL session, authenticated if authentication is specified, executes a provided list of CCL commands and exits the CCL session.

Parameters:

terminal - A JSchSshTerminal to be used to interact with the remote server.

commands - A Collection of String objects representing the commands to be run.

authenticate - A boolean flag indicating whether or not to authenticate the CCL session

Throws:

SshException - If any errors occur during sessionCommandsthe execution of the commands.

SshException

getTerminalProperties

public com.cerner.ccl.j4ccl.TerminalProperties getTerminalProperties()

Retrieves the TerminalProperties object currently in effect for this CclCommandTerminal.

Returns:

The TerminalProperties object currently in effect for this CclCommandTerminal.