com.hp.ucmdb.api.discovery.services
Interface DDMSoftwareSignatureService

public interface DDMSoftwareSignatureService

Services to define software items to be discovered by the DDMProbe components. The definitions are system-wide. If more than one DDM probe component is defined, the definitions apply to all of them.

Method Summary

void	disableSignature(java.lang.String signatureID) Disables the SoftwareSignature.
void	enableSignature(java.lang.String signatureID) Enables the SoftwareSignature.
DiscoveryFactory	getDiscoveryFactory() Returns the factory that creates the objects required by this service.
SoftwareSignature	getSignature(java.lang.String signatureID) Returns the specified SoftwareSignature.
java.util.Collection<SoftwareSignature>	getSignatures() Returns the SoftwareSignature objects currently associated with the DDM system.
void	removeSignature(java.lang.String signatureID) Removes the SoftwareSignature from the system.
void	setSignature(SoftwareSignature softwareSignature) Sets a softwareSignature to be available to the DDMProbe components.

Method Detail

setSignature

void setSignature(SoftwareSignature softwareSignature)
                  throws java.lang.IllegalArgumentException

Sets a softwareSignature to be available to the DDMProbe components.
If this is a new signature, it is added and enabled.
If a signature with the same ID already exists, the data is updated. If an existing signature is disabled, calling this method does not enable it.

Parameters:

softwareSignature - the SoftwareSignature.

Throws:

java.lang.IllegalArgumentException - if the SoftwareSignature object is not valid

disableSignature

void disableSignature(java.lang.String signatureID)
                      throws SignatureDoesNotExistException

Disables the SoftwareSignature.
Disabled software is ignored by the DDMProbe components and cannot be discovered.

Parameters:

signatureID - the name of the SoftwareSignature.

Throws:

SignatureDoesNotExistException - ia signature named signatureID does not exist.

enableSignature

void enableSignature(java.lang.String signatureID)
                     throws SignatureDoesNotExistException

Enables the SoftwareSignature.
Enabled software can be discovered by the DDM probes.

Parameters:

signatureID - the name of the SoftwareSignature.

Throws:

SignatureDoesNotExistException - a signature named signatureID does not exist.

removeSignature

void removeSignature(java.lang.String signatureID)
                     throws SignatureDoesNotExistException

Removes the SoftwareSignature from the system.
After using this method, the software cannot be discovered by the DDMProbe components.

Parameters:

signatureID - the name of the SoftwareSignature.

Throws:

SignatureDoesNotExistException - a signature named signatureID does not exist.

getSignatures

java.util.Collection<SoftwareSignature> getSignatures()

Returns the SoftwareSignature objects currently associated with the DDM system.

Returns:

the SoftwareSignature objects currently associated with the DDM system.

getSignature

SoftwareSignature getSignature(java.lang.String signatureID)

Returns the specified SoftwareSignature.
Changes made to the returned SoftwareSignature do not affect the DDM server.

Parameters:

signatureID - the name of the SoftwareSignature to retrieve.

Returns:

the specified SoftwareSignature, or null if no signature of the specified name exists.

getDiscoveryFactory

DiscoveryFactory getDiscoveryFactory()

Returns the factory that creates the objects required by this service.

Returns:

the factory that creates the objects required by this service.