com.cloupia.lib.util.ssh

Class SSHClient

java.lang.Object

com.cloupia.lib.util.ssh.AbstractSSHClient

com.cloupia.lib.util.ssh.SSHClient

public class SSHClient
extends AbstractSSHClient

Field Summary

Fields inherited from class com.cloupia.lib.util.ssh.AbstractSSHClient

_client, alternateSource, client, con, echoCommands, host, keyFile, maxRetries, passphrase, password, port, pvtKey, reader, sock, sshVersion, userName

Constructor Summary

Constructors

Constructor and Description
SSHClient(java.lang.String host, int port, java.lang.String userName, java.io.File keyFile)
SSHClient(java.lang.String host, int port, java.lang.String userName, java.lang.String password)

Method Summary

Modifier and Type	Method and Description
void	echoOff()
void	echoOn()
SSHCommandOutput	executeCommand(java.lang.String command)
SSHCommandOutput	executeCommand(java.lang.String command, java.lang.String inputData)
static SSHCommandOutput	executeCommandAndClose(java.lang.String ip, int port, java.lang.String username, java.lang.String password, java.lang.String command) This call will open connection, execute the command and disconnects the connection.
static SSHCommandOutput	executeCommandAndCloseWithRetry(java.lang.String ip, int port, java.lang.String username, java.lang.String password, java.lang.String command, int retryCount) This call will open connection, execute the command and disconnects the connection.
static boolean	executeCommandASync(java.lang.String ip, int port, java.lang.String username, java.lang.String password, java.lang.String command) This call will open connection, execute the commands asynchronously by launching a new thread.
SSHCommandOutput	executeCommandV1(java.lang.String command)
SSHCommandOutput	executeCommandV1(java.lang.String command, java.lang.String inputData)
SSHCommandOutput	executeNexusCommand(java.lang.String command)
static int	getRetryCountForSignatureFailure()
void	openShell(java.io.InputStream in)
com.maverick.ssh.SshSession	openShell(int columns, int rows)

Methods inherited from class com.cloupia.lib.util.ssh.AbstractSSHClient

connect, connect, disconnect, getHost, getPort, getSession, isConnected, main, setAlternatePasswordSource

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHClient

public SSHClient(java.lang.String host,
                 int port,
                 java.lang.String userName,
                 java.lang.String password)

SSHClient

public SSHClient(java.lang.String host,
                 int port,
                 java.lang.String userName,
                 java.io.File keyFile)

Method Detail

executeCommand

public SSHCommandOutput executeCommand(java.lang.String command)
                                throws java.lang.Exception

Throws:

java.lang.Exception

echoOff

public void echoOff()

echoOn

public void echoOn()

executeCommand

public SSHCommandOutput executeCommand(java.lang.String command,
                                       java.lang.String inputData)
                                throws java.lang.Exception

Throws:

java.lang.Exception

executeNexusCommand

public SSHCommandOutput executeNexusCommand(java.lang.String command)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

executeCommandV1

public SSHCommandOutput executeCommandV1(java.lang.String command)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

executeCommandV1

public SSHCommandOutput executeCommandV1(java.lang.String command,
                                         java.lang.String inputData)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

openShell

public com.maverick.ssh.SshSession openShell(int columns,
                                             int rows)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

openShell

public void openShell(java.io.InputStream in)
               throws java.lang.Exception

Throws:

java.lang.Exception

executeCommandAndClose

public static SSHCommandOutput executeCommandAndClose(java.lang.String ip,
                                                      int port,
                                                      java.lang.String username,
                                                      java.lang.String password,
                                                      java.lang.String command)
                                               throws java.lang.Exception

This call will open connection, execute the command and disconnects the connection. The caller of this API need not open or close connections

Parameters:

ip -

port -

username -

password -

command -

Throws:

java.lang.Exception

executeCommandAndCloseWithRetry

public static SSHCommandOutput executeCommandAndCloseWithRetry(java.lang.String ip,
                                                               int port,
                                                               java.lang.String username,
                                                               java.lang.String password,
                                                               java.lang.String command,
                                                               int retryCount)
                                                        throws java.lang.Exception

This call will open connection, execute the command and disconnects the connection. The caller of this API need not open or close connections

Parameters:

ip -

port -

username -

password -

command -

retryCount -

Throws:

java.lang.Exception

executeCommandASync

public static boolean executeCommandASync(java.lang.String ip,
                                          int port,
                                          java.lang.String username,
                                          java.lang.String password,
                                          java.lang.String command)
                                   throws java.lang.Exception

This call will open connection, execute the commands asynchronously by launching a new thread. It should be used in cases where we are running some ssh commands which will disconnect the communication channel (like changing IP Address of the device after logging into that device). The caller of this API need not open connections

Parameters:

ip -

port -

username -

password -

command -

Returns:

whether the initial ssh connection to execute the ssh command was successful or not

Throws:

java.lang.Exception

getRetryCountForSignatureFailure

public static int getRetryCountForSignatureFailure()