Package dev.galasa.ipnetwork.spi

Class SSHClient

java.lang.Object

dev.galasa.ipnetwork.spi.SSHClient

All Implemented Interfaces:

ICommandShell

public class SSHClient
extends Object
implements ICommandShell

SSH client for Galasa

Author:

James Bartlett

Constructor Summary

Constructors

Constructor	Description
SSHClient(String hostname, int port, ICredentials credentials, long defaultTimeoutInMillis)

Method Summary

Modifier and Type	Method	Description
void	connect()
void	disconnect()	Disconnect the client
String	issueCommand(String command)	Issue a command using SSH.
String	issueCommand(String command, boolean newShell)	Issue a command using SSH.
String	issueCommand(String command, boolean newShell, long timeoutInMillis)	Issue a command using SSH
String	issueCommand(String command, long timeoutInMillis)	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 timeoutInMillis)	Issue a command using SSH shell
String	issueCommandToShell(String command, long timeoutInMillis)	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

Methods inherited from class java.lang.Object

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

Constructor Details

SSHClient

public SSHClient(String hostname,
 int port,
 ICredentials credentials,
 long defaultTimeoutInMillis)
          throws SSHException

Throws:

SSHException

Method Details

issueCommand

public String issueCommand(String command)
                    throws SSHException

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

Specified by:

issueCommand in interface ICommandShell

Parameters:

command - - command to issue

Returns:

the output of the command (stdout and stderr)

Throws:

SSHException

issueCommand

public String issueCommand(String command,
 long timeoutInMillis)
                    throws SSHException

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

Specified by:

issueCommand in interface ICommandShell

Parameters:

command - - command to issue

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

Returns:

the output of the command (stdout and stderr)

Throws:

SSHException

issueCommand

public String issueCommand(String command,
 boolean newShell)
                    throws SSHException

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

Specified by:

issueCommand in interface ICommandShell

Parameters:

command - - command to issue

newShell - - if true will start a new

Returns:

the output of the command (stdout and stderr)

Throws:

SSHException

issueCommand

public String issueCommand(String command,
 boolean newShell,
 long timeoutInMillis)
                    throws SSHException

Issue a command using SSH

Specified by:

issueCommand in interface ICommandShell

Parameters:

command - - command to issue

newShell - - if true will start a new

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

Returns:

the output of the command (stdout and stderr)

Throws:

SSHException

setChangePromptCommand

public void setChangePromptCommand(String command)

Define the right command used to change the shell prompt

Specified by:

setChangePromptCommand in interface ICommandShell

issueCommandToShell

public String issueCommandToShell(String command)
                           throws SSHException

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

Specified by:

issueCommandToShell in interface ICommandShell

Parameters:

command - - command to issue

Returns:

the output of the command

Throws:

SSHException

issueCommandToShell

public String issueCommandToShell(String command,
 long timeoutInMillis)
                           throws SSHException

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

Specified by:

issueCommandToShell in interface ICommandShell

Parameters:

command - - command to issue

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

Returns:

the output of the command

Throws:

SSHException

issueCommandToShell

public String issueCommandToShell(String command,
 boolean newShell)
                           throws SSHException

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

Specified by:

issueCommandToShell in interface ICommandShell

Parameters:

command - - command to issue

newShell - - if true will start a new

Returns:

the output of the command

Throws:

SSHException

issueCommandToShell

public String issueCommandToShell(String command,
 boolean newShell,
 long timeoutInMillis)
                           throws SSHException

Issue a command using SSH shell

Specified by:

issueCommandToShell in interface ICommandShell

Parameters:

command - - command to issue

newShell - - if true will start a new

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

Returns:

the output of the command

Throws:

SSHException

connect

public void connect()
             throws SSHException

Specified by:

connect in interface ICommandShell

Throws:

SSHException

restartShell

public void restartShell()
                  throws SSHException

Specified by:

restartShell in interface ICommandShell

Throws:

SSHException

disconnect

public void disconnect()
                throws SSHException

Disconnect the client

Specified by:

disconnect in interface ICommandShell

Throws:

IOException

SSHException

reportResultStrings

public void reportResultStrings(boolean report)

Description copied from interface: ICommandShell

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

Specified by:

reportResultStrings in interface ICommandShell

Parameters:

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

setRemoveAnsiEscapeCodes

public void setRemoveAnsiEscapeCodes(boolean remoteAnsiEscapeCodes)

Description copied from interface: ICommandShell

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

Specified by:

setRemoveAnsiEscapeCodes in interface ICommandShell