Package dev.galasa.ipnetwork

Interface ICommandShell

All Known Implementing Classes:

SSHClient

public interface ICommandShell

Method Summary

Modifier and Type	Method	Description
void	connect()
void	disconnect()
String	issueCommand(String command)
String	issueCommand(String command, boolean newShell)	Issue a command using SSH.
String	issueCommand(String command, boolean newShell, long timeout)	Issue a command using SSH
String	issueCommand(String command, long timeout)	Issue a command using SSH.
String	issueCommandToShell(String command)	Issue a command using SSH shell.
String	issueCommandToShell(String command, boolean newShell)	Issue a command using SSH shell.
String	issueCommandToShell(String command, boolean newShell, long timeout)	Issue a command using SSH shell - not valid for Rexec implementation - equivalent to issueCommand(String, long) for Telnet implementation
String	issueCommandToShell(String command, long timeout)	Issue a command using SSH shell.
void	reportResultStrings(boolean report)	Ask the shell to log the result strings for all shell commands
void	restartShell()
void	setChangePromptCommand(String command)	Define the right command used to change the shell prompt
void	setRemoveAnsiEscapeCodes(boolean remoteAnsiEscapeCodes)	Instruct the command shell to remove ANSI escape codes from the output of commands to the shell

Method Details

issueCommand

String issueCommand(String command)
             throws IpNetworkManagerException

Throws:

IpNetworkManagerException

issueCommand

String issueCommand(String command,
 long timeout)
             throws IpNetworkManagerException

Issue a command using SSH. Equivalent to issueCommand(String, boolean, long)

Parameters:

command - - command to issue

timeout - - time (in milliseconds) to wait with no new output appearing before timing out

Returns:

the output of the command (stdout and stderr)

Throws:

SSHException

IpNetworkManagerException

issueCommand

String issueCommand(String command,
 boolean newShell)
             throws IpNetworkManagerException

Issue a command using SSH. Equivalent to issueCommand(String, boolean, long)

Parameters:

command - - command to issue

newShell - - if true will start a new

Returns:

the output of the command (stdout and stderr)

Throws:

SSHException

IpNetworkManagerException

issueCommand

String issueCommand(String command,
 boolean newShell,
 long timeout)
             throws IpNetworkManagerException

Issue a command using SSH

Parameters:

command - - command to issue

newShell - - if true will start a new

timeout - - time (in milliseconds) to wait with no new output appearing before timing out

Returns:

the output of the command (stdout and stderr)

Throws:

SSHException

IpNetworkManagerException

connect

void connect()
      throws IpNetworkManagerException

Throws:

IpNetworkManagerException

disconnect

void disconnect()
         throws IpNetworkManagerException

Throws:

IpNetworkManagerException

restartShell

void restartShell()
           throws IpNetworkManagerException

Throws:

IpNetworkManagerException

setChangePromptCommand

void setChangePromptCommand(String command)

Define the right command used to change the shell prompt

issueCommandToShell

String issueCommandToShell(String command)
                    throws IpNetworkManagerException

Issue a command using SSH shell. Equivalent to issueCommandToShell(String, boolean, long) - not valid for Rexec implementation - equivalent to issueCommand(String, long) for Telnet implementation

Parameters:

command - - command to issue

Returns:

the output of the command (stdout and stderr)

Throws:

IpNetworkManagerException

issueCommandToShell

String issueCommandToShell(String command,
 long timeout)
                    throws IpNetworkManagerException

Issue a command using SSH shell. Equivalent to issueCommandToShell(String, boolean, long) - not valid for Rexec implementation - equivalent to issueCommand(String, long) for Telnet implementation

Parameters:

command - - command to issue - if true will start a new

Returns:

the output of the command (stdout and stderr)

Throws:

IpNetworkManagerException

issueCommandToShell

String issueCommandToShell(String command,
 boolean newShell)
                    throws IpNetworkManagerException

Issue a command using SSH shell. Equivalent to issueCommandToShell(String, boolean, long) - not valid for Rexec implementation - equivalent to issueCommand(String, long) for Telnet implementation

Parameters:

command - - command to issue

newShell - - if true will start a new

Returns:

the output of the command (stdout and stderr)

Throws:

IpNetworkManagerException

issueCommandToShell

String issueCommandToShell(String command,
 boolean newShell,
 long timeout)
                    throws IpNetworkManagerException

Issue a command using SSH shell - not valid for Rexec implementation - equivalent to issueCommand(String, long) for Telnet implementation

Parameters:

command - - command to issue

newShell - - if true will start a new

timeout - - time (in milliseconds) to wait with no new output appearing before timing out

Returns:

the output of the command

Throws:

IpNetworkManagerException

reportResultStrings

void reportResultStrings(boolean report)

Ask the shell to log the result strings for all shell commands

Parameters:

report - whether the shell should log the results of the shell commands

setRemoveAnsiEscapeCodes

void setRemoveAnsiEscapeCodes(boolean remoteAnsiEscapeCodes)

Instruct the command shell to remove ANSI escape codes from the output of commands to the shell