com.hp.ucmdb.discovery.library.clients.ddmagent

Class DDMClient

java.lang.Object

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

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

com.hp.ucmdb.discovery.library.clients.ddmagent.DDMClient

All Implemented Interfaces:

LocalizedClient, BandwidthControl, RemoteAgentOptionsManager, RemoteFileSystemManager

public final class DDMClient
extends ShellClient

Created by IntelliJ IDEA. User: eichbege Date: 3/23/11 Time: 12:18 PM To change this template use File | Settings | File Templates.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DDMClient.UPLOAD_CERTIFICATES_STATUS

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
DDMClient(ClientsFrameworkImpl framework, java.util.Properties props)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	changeFileMode(java.lang.String existingFilePath, java.lang.String newFileMode)
boolean	deleteFile(java.lang.String remoteFilePath)
boolean	deleteOption(java.lang.String optionName) Deletes the remote setting on a remote machine by a given key
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.
java.lang.String	executeProcess(java.lang.String cmd)
java.lang.String	executeProcess(java.lang.String cmd, int cmdTimeout)
java.lang.String	executeProcess(java.lang.String cmd, int cmdTimeout, boolean synchronous)
java.util.Map<java.lang.String,java.lang.String>	getEnvironmentVariables()
java.util.Map<java.lang.String,java.lang.String>	getOptionsMap() Get all remote agent settings
int	getPort() Returns the port from the protocol definition.
java.lang.String	getServerPort() Returns the server port used by the agent session
java.util.Properties	getSysInfo()
java.lang.String	getUserName() Returns the username set in the protocol definition that is used for connection.
java.lang.String	getVersion()
boolean	hasShell()
void	setConnectedShellCredentialID(java.lang.String connectedCredentialID)
java.lang.String	setOptionIfNotExist(java.lang.String optionName, java.lang.String optionValue) Attempts to set a value to the given key on a remote machine, if such key doesn't already exist
void	setOptionsMap(java.util.Map<java.lang.String,java.lang.String> optionsMap, boolean override) Sets remote agent's settings.
boolean	supportsSudo()
static DDMClient.UPLOAD_CERTIFICATES_STATUS	uploadCertificates(RemoteFileSystemManager client, java.lang.String ip, java.lang.String basedir, java.lang.String credentialId)
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, executeCmd, executeCmd, executeCmd, executeCmd, executeCmd, executeCmdWithTimeOut, getBandwidthLimit, getErrorVariable, getFile, getLastCommandOutputBytes, getMaxCommandLength, getOptionsDirectory, getRemotePlatform, getWelcomeBuffer, putFile, setBandwidthLimit, setCharset, setErrorVariable, setMaxCommandLength, setOptionsDirectory, setOptionsMap, setRemotePlatform

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DDMClient

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

Throws:

java.lang.Exception

Method Detail

uploadCertificates

public static DDMClient.UPLOAD_CERTIFICATES_STATUS uploadCertificates(RemoteFileSystemManager client,
                                                      java.lang.String ip,
                                                      java.lang.String basedir,
                                                      java.lang.String credentialId)
                                                               throws java.lang.Exception

Throws:

java.lang.Exception

supportsSudo

public boolean supportsSudo()

Overrides:

supportsSudo in class BaseClient

setConnectedShellCredentialID

public void setConnectedShellCredentialID(java.lang.String connectedCredentialID)

getServerPort

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

Returns the server port used by the agent session

Overrides:

getServerPort in class ShellClient

Returns:

The port number

Throws:

java.lang.Exception

getPort

public int getPort()
            throws java.lang.Exception

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

Returns:

The SSH port for client connection

Throws:

java.lang.Exception - if something goes wrong

See Also:

ClientFactory

getVersion

public java.lang.String getVersion()

Returns:

the version of remote UD Agent

hasShell

public boolean hasShell()

Returns:

the version of remote UD Agent

uploadFile

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

Description copied from interface: RemoteFileSystemManager

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.

downloadFile

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

Description copied from interface: RemoteFileSystemManager

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.

changeFileMode

public java.lang.String changeFileMode(java.lang.String existingFilePath,
                              java.lang.String newFileMode)
                                throws java.lang.Exception

Throws:

java.lang.Exception

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.

deleteFile

public boolean deleteFile(java.lang.String remoteFilePath)
                   throws java.lang.Exception

Throws:

java.lang.Exception

setOptionsMap

public void setOptionsMap(java.util.Map<java.lang.String,java.lang.String> optionsMap,
                 boolean override)
                   throws java.lang.Exception

Description copied from class: ShellClient

Sets remote agent's settings.

Specified by:

setOptionsMap in interface RemoteAgentOptionsManager

Overrides:

setOptionsMap in class ShellClient

Parameters:

optionsMap - - map that contains pairs of options (option name and option value) to be set on remote machine

override - - if set to true, then this operation clears all remote agent's options except of the options that are passed in settingsMap

Throws:

java.lang.Exception - if failed to set remote agent's settings

getSysInfo

public java.util.Properties getSysInfo()
                                throws java.lang.Exception

Throws:

java.lang.Exception

getOptionsMap

public java.util.Map<java.lang.String,java.lang.String> getOptionsMap()
                                                               throws java.lang.Exception

Description copied from class: ShellClient

Get all remote agent settings

Specified by:

getOptionsMap in interface RemoteAgentOptionsManager

Overrides:

getOptionsMap in class ShellClient

Returns:

a map that contains pairs of remote agent option name and option value

Throws:

java.lang.Exception - if failed to get remote agent's settings

getEnvironmentVariables

public java.util.Map<java.lang.String,java.lang.String> getEnvironmentVariables()
                                                                         throws java.lang.Exception

Throws:

java.lang.Exception

setOptionIfNotExist

public java.lang.String setOptionIfNotExist(java.lang.String optionName,
                                   java.lang.String optionValue)
                                     throws java.lang.Exception

Description copied from class: ShellClient

Attempts to set a value to the given key on a remote machine, if such key doesn't already exist

Specified by:

setOptionIfNotExist in interface RemoteAgentOptionsManager

Overrides:

setOptionIfNotExist in class ShellClient

Parameters:

optionName - key

optionValue - value

Returns:

null if the key didn't previously exist, or a previous value if the key did exist

Throws:

java.lang.Exception - if something bad happens

deleteOption

public boolean deleteOption(java.lang.String optionName)

Description copied from class: ShellClient

Deletes the remote setting on a remote machine by a given key

Specified by:

deleteOption in interface RemoteAgentOptionsManager

Overrides:

deleteOption in class ShellClient

Parameters:

optionName - key to remove

Returns:

whether the removal succeeded or not

executeProcess

public java.lang.String executeProcess(java.lang.String cmd)
                                throws java.lang.Exception

Throws:

java.lang.Exception

executeProcess

public java.lang.String executeProcess(java.lang.String cmd,
                              int cmdTimeout)
                                throws java.lang.Exception

Throws:

java.lang.Exception

executeProcess

public java.lang.String executeProcess(java.lang.String cmd,
                              int cmdTimeout,
                              boolean synchronous)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getUserName

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

Description copied from class: BaseClient

Returns the username set in the protocol definition that is used for connection. The name can be overridden when creating the client.

Overrides:

getUserName in class BaseClient

Returns:

The username

Throws:

java.lang.Exception