SoftwareSignature (api-interfaces 11.0.3 API)

All Superinterfaces:

Serializable
```
public interface SoftwareSignature
extends Serializable
```
Represents a set of rules to detect the existence of a specific software.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ParsingRule`	`addParsingRule(String ruleId)` Creates and add a new ParsingRule that will be a part of the software's detection process.
`ProcessSignature`	`addProcess(String processName)` Creates and adds a new ProcessSignature that will be a part of the software's detection process.
`String`	`getAttributeValue(String attName)` Returns value of the desired attribute.
`String`	`getCategory()` Returns the category of this software signature.
`Collection<String>`	`getConfigFilesPaths()` Returns the paths of the configuration files associated with this software.
`String`	`getName()` Returns the name of the software to be discovered.
`ParsingRule`	`getParsingRule(String ruleId)` Returns the ParsingRule with the specified ID.
`Collection<ParsingRule>`	`getParsingRules()` Returns the parsing rules that are part of the detection process.
`Collection<ProcessSignature>`	`getProcesses()` Returns the process signatures that are part of the detection process.
`Collection<ProcessSignature>`	`getProcessesByName(String processName)` Returns the process signatures that are part of the detection process.
`String`	`getSoftwareCiType()` Returns the type of CI used to represent the software if it is discovered.
`String`	`getSoftwareId()` Returns the software ID of this object
`String`	`getVendor()` Returns the vendor of this software signature.
`boolean`	`isEnabled()` Checks whether this SoftwareSIgnature is enabled.
`void`	`removeAttribute(String attName)` Removes an attribute from the detection of this SoftwareSignature.
`void`	`removeParsingRule(String ruleId)` Removes a ParsingRule from the detection of this SoftwareSignature.
`void`	`removeProcess(ProcessSignature processSignature)` Removes a ProcessSignature from the detection of this SoftwareSignature.
`void`	`setAttribute(String name, String value)` Adds or Updates an attribute that is part of the detection process.
`void`	`setCategory(String category)` Sets the category of this software signature.
`void`	`setConfigFilesPaths(String... paths)` Set the paths of the configuration files associated with this software.
`void`	`setName(String softwareName)` Sets the name of this SoftwareSignature object.
`void`	`setSoftwareCiType(String softwareCiType)` Sets the CI type used to represent the software if it is discovered.
`void`	`setVendor(String vendor)` Sets the vendor of this software signature.
`SoftwareSignature`	`vendor(String vendor)` Sets a vendor to this software signature.

- Method Detail
  - getProcesses
```
Collection<ProcessSignature> getProcesses()
```
    Returns the process signatures that are part of the detection process.
    
    Returns:
    
    the process signatures that are part of the detection process.
  - getProcessesByName
```
Collection<ProcessSignature> getProcessesByName(String processName)
```
    Returns the process signatures that are part of the detection process. and have the specified name.
    
    Parameters:
    
    processName - the name.
    
    Returns:
    
    the process signatures that are part of the detection process.
  - getParsingRules
```
Collection<ParsingRule> getParsingRules()
```
    Returns the parsing rules that are part of the detection process.
    
    Returns:
    
    the parsing rules that are part of the detection process.
  - getParsingRule
```
ParsingRule getParsingRule(String ruleId)
```
    Returns the ParsingRule with the specified ID.
    
    Parameters:
    
    ruleId - the ID.
    
    Returns:
    
    the ParsingRule with the specified ID.
  - getSoftwareId
```
String getSoftwareId()
```
    Returns the software ID of this object
    
    Returns:
    
    the software ID of this object.
  - getName
```
String getName()
```
    Returns the name of the software to be discovered.
    
    Returns:
    
    the name of the software to be discovered.
  - setSoftwareCiType
```
void setSoftwareCiType(String softwareCiType)
```
    Sets the CI type used to represent the software if it is discovered. The type must be derived from a software element CI Type.
    
    Parameters:
    
    softwareCiType - the type of CI used to represent the software.
  - setName
```
void setName(String softwareName)
```
    Sets the name of this SoftwareSignature object.
    
    Parameters:
    
    softwareName - the name.
  - getSoftwareCiType
```
String getSoftwareCiType()
```
    Returns the type of CI used to represent the software if it is discovered.
    
    Returns:
    
    the type of CI used to represent the software if it is discovered.
  - addProcess
```
ProcessSignature addProcess(String processName)
```
    Creates and adds a new ProcessSignature that will be a part of the software's detection process.
    
    Parameters:
    
    processName - the name of the process to add.
    
    Returns:
    
    the new added ProcessSignature.
  - addParsingRule
```
ParsingRule addParsingRule(String ruleId)
```
    Creates and add a new ParsingRule that will be a part of the software's detection process.
    
    Parameters:
    
    ruleId - the ID of the rule to add.
    
    Returns:
    
    the new added ParsingRule.
  - removeParsingRule
```
void removeParsingRule(String ruleId)
                throws ParsingRuleDoesNotExistException
```
    Removes a ParsingRule from the detection of this SoftwareSignature.
    
    Parameters:
    
    ruleId - the ID of the rule to be removed.
    
    Throws:
    
    ParsingRuleDoesNotExistException - if there is no ParsingRule with this name.
  - removeProcess
```
void removeProcess(ProcessSignature processSignature)
            throws ProcessDoesNotExistException
```
    Removes a ProcessSignature from the detection of this SoftwareSignature.
    
    Parameters:
    
    processSignature - the process to be removed.
    
    Throws:
    
    ProcessDoesNotExistException - if there is no ProcessSignature with this name.
  - isEnabled
```
boolean isEnabled()
```
    Checks whether this SoftwareSIgnature is enabled.
    
    Returns:
    
    true if this SoftwareSIgnature is enabled.
  - setConfigFilesPaths
```
void setConfigFilesPaths(String... paths)
```
    Set the paths of the configuration files associated with this software. Each time this method is called, it overrides the previous calls. Pass all the paths on each invocation.
    
    Parameters:
    
    paths - the paths of the configuration files associated with this software.
  - getConfigFilesPaths
```
Collection<String> getConfigFilesPaths()
```
    Returns the paths of the configuration files associated with this software.
    
    Returns:
    
    the paths of the configuration files associated with this software.
  - setAttribute
```
void setAttribute(String name,
                  String value)
```
    Adds or Updates an attribute that is part of the detection process.
    
    Parameters:
    
    name - the name of the attributed to set.
    
    value - the value of the attribute.
  - removeAttribute
```
void removeAttribute(String attName)
              throws AttributeDoesNotExistException
```
    Removes an attribute from the detection of this SoftwareSignature.
    
    Parameters:
    
    attName - the name of the attribute to remove.
    
    Throws:
    
    AttributeDoesNotExistException - if there is no attribute with this name.
  - getAttributeValue
```
String getAttributeValue(String attName)
                  throws AttributeDoesNotExistException
```
    Returns value of the desired attribute.
    
    Parameters:
    
    attName - name of the desired attribute
    
    Returns:
    
    value of the desired attribute
    
    Throws:
    
    AttributeDoesNotExistException - if there isn't an attribute with this name.
  - getCategory
```
String getCategory()
```
    Returns the category of this software signature. A category is any application-defined string. The UCMDB does not use this string.
    
    Returns:
    
    the category of the this software signature.
  - setCategory
```
void setCategory(String category)
```
    Sets the category of this software signature. A category is any application-defined string. The UCMDB does not use this string.
    
    Parameters:
    
    category - the category to be set.
  - getVendor
```
String getVendor()
```
    Returns the vendor of this software signature. The vendor is any application-defined string. The UCMDB does not use this string.
    
    Returns:
    
    the vendor of this software signature.
  - setVendor
```
void setVendor(String vendor)
```
    Sets the vendor of this software signature. The vendor is any application-defined string. The UCMDB does not use this string. Overrides previous calls to vendor(String vendor).
    
    Parameters:
    
    vendor - the vendor.
  - vendor
```
SoftwareSignature vendor(String vendor)
```
    Sets a vendor to this software signature. Overrides previous calls to setVendor(String vendor).
    
    Parameters:
    
    vendor - the category should be sets
    
    Returns:
    
    this object with the change (for chaining)

Interface SoftwareSignature

Method Summary

Method Detail

getProcesses

getProcessesByName

getParsingRules

getParsingRule

getSoftwareId

getName

setSoftwareCiType

setName

getSoftwareCiType

addProcess

addParsingRule

removeParsingRule

removeProcess

isEnabled

setConfigFilesPaths

getConfigFilesPaths

setAttribute

removeAttribute

getAttributeValue

getCategory

setCategory

getVendor

setVendor

vendor