com.cerner.ccl.j4ccl.ssh

Class CommandExpectationGroup

java.lang.Object

com.cerner.ccl.j4ccl.ssh.CommandExpectationGroup

Direct Known Subclasses:

MaskedCommandExpectationGroup

public class CommandExpectationGroup
extends Object

Encapsulates a list of commands together with regex patterns for the set of potential responses to any of the commands. The intention is for the system to send the commands to a terminal in order, one command at a time, waiting after each command is sent to receive one of the expected responses before sending the next command. In practice the expectations will be checked in order so it is best to list the expectations with the most likely ones and the ones easiest to check listed first.

Author:

Fred Eckertson

Constructor Summary

Constructors

Modifier	Constructor and Description
	CommandExpectationGroup() Constructs a CommandExpectationGroup without masked commands.
protected	CommandExpectationGroup(boolean maskCommands) Constructs a CommandExpectationGroup with commands masked as specified.

Method Summary

Modifier and Type	Method and Description
void	addCommand(String command) Adds a single command to the end of the current list of commands.
void	addCommands(List<String> commands) Appends a list of commands to the end of the current list of commands.
void	addExpectation(String expectation) Adds a single expectation to the end of the current list of expectations.
void	addExpectations(List<String> expectations) Appends a list of expectations to the end of the current list of expectations.
List<String>	getCommands() Retrieves the current list of commands.
List<String>	getExpectations() Retrieves the current list of expectations.
boolean	maskCommands() Retrieves the mask commands indicator.
String	toString() Overrides the toString method.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandExpectationGroup

public CommandExpectationGroup()

Constructs a CommandExpectationGroup without masked commands.

CommandExpectationGroup

protected CommandExpectationGroup(boolean maskCommands)

Constructs a CommandExpectationGroup with commands masked as specified.

Parameters:

maskCommands - A boolean value indicating whether to mask the commands.

Method Detail

addCommand

public void addCommand(String command)

Adds a single command to the end of the current list of commands.

Parameters:

command - The command to add.

addCommands

public void addCommands(List<String> commands)

Appends a list of commands to the end of the current list of commands.

Parameters:

commands - The list of command to add.

addExpectation

public void addExpectation(String expectation)

Adds a single expectation to the end of the current list of expectations.

Parameters:

expectation - The expectation to add.

addExpectations

public void addExpectations(List<String> expectations)

Appends a list of expectations to the end of the current list of expectations.

Parameters:

expectations - The list of expectations to add.

getCommands

public List<String> getCommands()

Retrieves the current list of commands.

Returns:

The current list of commands.

getExpectations

public List<String> getExpectations()

Retrieves the current list of expectations.

Returns:

The current list of expectations.

maskCommands

public boolean maskCommands()

Retrieves the mask commands indicator.

Returns:

The mask commands indicator.

toString

public String toString()

Overrides the toString method. Note that commands added after toString has been invoked will not be represented in future invocations.

Overrides:

toString in class Object