com.hp.ucmdb.discovery.library.clients.shell

Class SSHClient

java.lang.Object

com.hp.ucmdb.discovery.library.clients.BaseClient

com.hp.ucmdb.discovery.library.clients.shell.ShellClient

com.hp.ucmdb.discovery.library.clients.shell.SSHClient

All Implemented Interfaces:

LocalizedClient, BandwidthControl, RemoteAgentOptionsManager, RemoteFileSystemManager

public class SSHClient
extends ShellClient

SSHClient runs shell commands using SSH. For a creation example, see ShellClient.

Properties that can be redefined for SSHClient:

• External SSH library log level
  To get more debug messages, set the external SSH library log level property SSHAgent.SSH_LOG_LEVEL. The log level is 1-7 where the debug level is 7. The log messages appear on the console.
• Keyboard interactive prompts & responses
  By default, the user\password are the only prompts identified. If Keyboard authentication was set with a prompt other than user\password, you can set the prompts and responses with properties SSHAgent.PROMPTS and SSHAgent.PROMPT_RESPONSES. The property values are a java.util.List of java.util.String. The prompts and responses are matched by index.
• All Protocol properties can be redefined when creating the client.

See Also:

ShellClient, ClientFactory, ClientsConsts

Nested Class Summary

Nested classes/interfaces inherited from class com.hp.ucmdb.discovery.library.clients.BaseClient

BaseClient.FilteredMethodsHandler

Field Summary

Fields inherited from class com.hp.ucmdb.discovery.library.clients.shell.ShellClient

UNIX_CMD_SEPARATOR, WIN_CMD_SEPARATOR

Fields inherited from class com.hp.ucmdb.discovery.library.clients.BaseClient

CREDENTIALS_ID, ENCODING

Constructor Summary

Constructors

Constructor and Description
SSHClient(ClientsFrameworkImpl framework, java.util.Properties props)

Method Summary

Methods

Modifier and Type	Method and Description
int	downloadFile(java.lang.String localFilePath, java.lang.String remoteFilePath, boolean shouldOverrideLocalFile) Download the specified file (remoteFilePath) from remote machine to probe.
int	downloadFile(java.lang.String localFilePath, java.lang.String remoteFilePath, ExistingFileResolution localFileResolution) Download the specified file (remoteFilePath) from remote machine to probe.
void	executeSuCommand()
void	exitFromSu()
java.lang.String	getFile(java.lang.String remoteFileName, java.lang.String remoteShareName)
java.lang.String	getKeyPath() Returns the key file path from the protocol definition.
int	getPort() Returns the port from the protocol definition.
boolean	isInSuMode()
boolean	isSuConfigured()
java.lang.String	putFile(java.lang.String localFileName, java.lang.String remoteShareName)
boolean	supportsSudo()
int	uploadFile(java.lang.String localFilePath, java.lang.String remoteFilePath, boolean shouldOverrideRemoteFile) Upload the specified file (localFilePath) from probe's machine to remote machine
int	uploadFile(java.lang.String localFilePath, java.lang.String remoteFilePath, ExistingFileResolution remoteFileResolution) Upload the specified file (localFilePath) from probe's machine to remote machine

Methods inherited from class com.hp.ucmdb.discovery.library.clients.shell.ShellClient

canCopyFile, deleteFile, deleteOption, executeCmd, executeCmd, executeCmd, executeCmd, executeCmd, executeCmdWithTimeOut, getBandwidthLimit, getErrorVariable, getLastCommandOutputBytes, getMaxCommandLength, getOptionsDirectory, getOptionsMap, getRemotePlatform, getServerPort, getWelcomeBuffer, setBandwidthLimit, setCharset, setErrorVariable, setMaxCommandLength, setOptionIfNotExist, setOptionsDirectory, setOptionsMap, setOptionsMap, setRemotePlatform

Methods inherited from class com.hp.ucmdb.discovery.library.clients.BaseClient

addDeniedPackage, close, getClientType, getCredentialId, getIpAddress, getProperty, getShellCmdSeperator, getSudoCommands, getSudoPaths, getTimeout, getUserName, isConnected, setAttributeEncrypted

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHClient

public SSHClient(ClientsFrameworkImpl framework,
         java.util.Properties props)
          throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getPort

public int getPort()
            throws java.lang.Exception

Returns the port from the protocol definition. The port can be overidden in the properties at client creation.

Returns:

The SSH port for client connection

Throws:

java.lang.Exception

See Also:

ClientFactory

getKeyPath

public java.lang.String getKeyPath()
                            throws java.lang.Exception

Returns the key file path from the protocol definition. The path can be overridden in the properties at client creation.

Returns:

The path to the key file for secure connection

Throws:

java.lang.Exception

See Also:

ClientFactory

supportsSudo

public boolean supportsSudo()

Overrides:

supportsSudo in class BaseClient

executeSuCommand

public void executeSuCommand()
                      throws java.lang.Exception

Throws:

java.lang.Exception

exitFromSu

public void exitFromSu()
                throws java.lang.Exception

Throws:

java.lang.Exception

putFile

public java.lang.String putFile(java.lang.String localFileName,
                       java.lang.String remoteShareName)
                         throws java.lang.Exception

Overrides:

putFile in class ShellClient

Throws:

java.lang.Exception

getFile

public java.lang.String getFile(java.lang.String remoteFileName,
                       java.lang.String remoteShareName)
                         throws java.lang.Exception

Overrides:

getFile in class ShellClient

Parameters:

remoteFileName - - file name we want to get from remote machine

remoteShareName - - name of the remote share from which we want to get the file

Returns:

- local name of the copied file

Throws:

java.lang.Exception

isInSuMode

public boolean isInSuMode()

isSuConfigured

public boolean isSuConfigured()

downloadFile

public int downloadFile(java.lang.String localFilePath,
               java.lang.String remoteFilePath,
               boolean shouldOverrideLocalFile)
                 throws java.lang.Exception

Download the specified file (remoteFilePath) from remote machine to probe.

Specified by:

downloadFile in interface RemoteFileSystemManager

Overrides:

downloadFile in class ShellClient

Parameters:

localFilePath - - defines the name of downloaded file on probe's machine.

remoteFilePath - - the path of the downloaded file on remote machine.

shouldOverrideLocalFile - - defines behavior if the localFilePath already exists on probe machine. True to override already existing local file with the downloaded file. False to not to perform download if the localFilePath already exists.

Returns:

zero in case of success

Throws:

java.lang.Exception - - exception is thrown in case of download failed.

uploadFile

public int uploadFile(java.lang.String localFilePath,
             java.lang.String remoteFilePath,
             boolean shouldOverrideRemoteFile)
               throws java.lang.Exception

Upload the specified file (localFilePath) from probe's machine to remote machine

Specified by:

uploadFile in interface RemoteFileSystemManager

Overrides:

uploadFile in class ShellClient

Parameters:

localFilePath - - the path of the file to be upload from probe machine

remoteFilePath - - the path of the uploaded file on remote machine

shouldOverrideRemoteFile - - what to do if the file on remote machine already exists. True will cause to override the file on remote machine, false will cause to not to upload the file if it already exists.

Returns:

zero in case of success.

Throws:

java.lang.Exception - - exception is thrown in case the upload failed.

uploadFile

public int uploadFile(java.lang.String localFilePath,
             java.lang.String remoteFilePath,
             ExistingFileResolution remoteFileResolution)
               throws java.lang.Exception

Upload the specified file (localFilePath) from probe's machine to remote machine

Specified by:

uploadFile in interface RemoteFileSystemManager

Overrides:

uploadFile in class ShellClient

Parameters:

localFilePath - - the path of the file to be upload from probe machine

remoteFilePath - - the path of the uploaded file on remote machine

remoteFileResolution - - defines behavior if the file on remote machine already exists.

Returns:

zero in case of success.

Throws:

java.lang.Exception - - exception is thrown in case the upload failed.

downloadFile

public int downloadFile(java.lang.String localFilePath,
               java.lang.String remoteFilePath,
               ExistingFileResolution localFileResolution)
                 throws java.lang.Exception

Download the specified file (remoteFilePath) from remote machine to probe.

Specified by:

downloadFile in interface RemoteFileSystemManager

Overrides:

downloadFile in class ShellClient

Parameters:

localFilePath - - defines the name of downloaded file on probe's machine.

remoteFilePath - - the path of the downloaded file on remote machine.

localFileResolution - - defines behavior if the localFilePath already exists on probe machine.

Returns:

zero in case of success

Throws:

java.lang.Exception - - exception is thrown in case of download failed.