com.hp.ucmdb.discovery.library.clients
Interface ClientsFramework

public interface ClientsFramework

Services for handling a protocol client.

Method Summary

BaseClient	createClient(java.lang.String credentialsId, java.util.Properties props) Creates a client of the specified type.
java.lang.String	createDynamicCredential(ObjectStateHolder protocolOSH) Creates a new credential dynamically.
java.lang.String[]	getAvailableProtocols(java.lang.String protcolName) Returns the IDs of all the credentials for the specific protocol.
java.lang.String[]	getAvailableProtocols(java.lang.String ipAddress, java.lang.String protcolName) Returns the IDs for those credentials of the specified protocol for which the specified IP address is in scope.
Element	getCurrentDestinationDataAsXml()
java.lang.String	getDiscoveryJobId()
java.lang.String	getProtocolProperty(java.lang.String credentialId, java.lang.String propertyName) Returns the value of the specified property of the specified credentials.
java.lang.String	getProtocolProperty(java.lang.String credentialId, java.lang.String propertyName, java.lang.String defaultValue) Returns the value of the property of the specified credentials.
void	releaseDynamicCredential(java.lang.String credentialId) Deletes a credential which was created by a createDynamicCredential call.

Method Detail

createClient

BaseClient createClient(java.lang.String credentialsId,
                        java.util.Properties props)
                        throws java.lang.Exception

Creates a client of the specified type. Use this when the credentials are known. Otherwise, use a client factory. The type is identified by the specified credentials.

Parameters:

credentialsId - ID of the credentials for the connection

props - additional properties to pass to the client

Returns:

A client of the specified type

Throws:

java.lang.Exception

getAvailableProtocols

java.lang.String[] getAvailableProtocols(java.lang.String ipAddress,
                                         java.lang.String protcolName)

Returns the IDs for those credentials of the specified protocol for which the specified IP address is in scope.

Parameters:

ipAddress - The connection IP

protcolName - A value from ClientsConsts

Returns:

The credentials IDs

See Also:

ClientsConsts

getAvailableProtocols

java.lang.String[] getAvailableProtocols(java.lang.String protcolName)

Returns the IDs of all the credentials for the specific protocol.

Parameters:

protcolName - A value from ClientsConsts

Returns:

The credentials IDs

getProtocolProperty

java.lang.String getProtocolProperty(java.lang.String credentialId,
                                     java.lang.String propertyName)
                                     throws java.lang.RuntimeException

Returns the value of the specified property of the specified credentials.

Parameters:

credentialId - The credential ID

propertyName - The name of the property

Returns:

protocol The property value

Throws:

java.lang.RuntimeException

getProtocolProperty

java.lang.String getProtocolProperty(java.lang.String credentialId,
                                     java.lang.String propertyName,
                                     java.lang.String defaultValue)
                                     throws java.lang.RuntimeException

Returns the value of the property of the specified credentials. If the property is not found, the specified default value is returned.

Parameters:

credentialId - The credential ID

propertyName - The name of the property

defaultValue - The value to return if no value is found for the specified property

Throws:

java.lang.RuntimeException

createDynamicCredential

java.lang.String createDynamicCredential(ObjectStateHolder protocolOSH)

Creates a new credential dynamically.

Parameters:

protocolOSH - The information needed to create a new credential

Returns:

new created credential ID

releaseDynamicCredential

void releaseDynamicCredential(java.lang.String credentialId)

Deletes a credential which was created by a createDynamicCredential call.

Parameters:

credentialId - The ID of the credential to delete

getCurrentDestinationDataAsXml

Element getCurrentDestinationDataAsXml()

getDiscoveryJobId

java.lang.String getDiscoveryJobId()