public interface ClientsFramework
Modifier and Type | Method and Description |
---|---|
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 protocolName)
Returns the IDs of all the credentials for the specific protocol.
|
java.lang.String[] |
getAvailableProtocols(java.lang.String ipAddress,
java.lang.String protocolName)
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()
Returns the current Job ID
|
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. |
BaseClient createClient(java.lang.String credentialsId, java.util.Properties props) throws java.lang.Exception
credentialsId
- ID of the credentials for the connectionprops
- additional properties to pass to the clientjava.lang.Exception
java.lang.String[] getAvailableProtocols(java.lang.String ipAddress, java.lang.String protocolName)
ipAddress
- The connection IPprotocolName
- A value from ClientsConstsClientsConsts
java.lang.String[] getAvailableProtocols(java.lang.String protocolName)
protocolName
- A value from ClientsConstsjava.lang.String getProtocolProperty(java.lang.String credentialId, java.lang.String propertyName) throws java.lang.RuntimeException
credentialId
- The credential IDpropertyName
- The name of the propertyjava.lang.RuntimeException
java.lang.String getProtocolProperty(java.lang.String credentialId, java.lang.String propertyName, java.lang.String defaultValue) throws java.lang.RuntimeException
credentialId
- The credential IDpropertyName
- The name of the propertydefaultValue
- The value to return if no value is found for the specified propertyjava.lang.RuntimeException
java.lang.String createDynamicCredential(ObjectStateHolder protocolOSH)
protocolOSH
- The information needed to create a new credentialvoid releaseDynamicCredential(java.lang.String credentialId)
createDynamicCredential
call.credentialId
- The ID of the credential to deleteElement getCurrentDestinationDataAsXml()
java.lang.String getDiscoveryJobId()
Documentation Feedback
Copyright 2012 Micro Focus or one of its affiliates.