com.ibm.tivoli.nm.collectors.framework.utils

Class CollectorDataUtils

java.lang.Object

com.ibm.tivoli.nm.collectors.framework.utils.CollectorDataUtils

public class CollectorDataUtils
extends java.lang.Object

Utility class for adding and manipulating custom data within the collector store

Author:

Emlyn Whittick

Constructor Summary

Constructors

Constructor and Description
CollectorDataUtils()

Method Summary

Modifier and Type	Method and Description
static void	addCollectedEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a collects relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addCollectedEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int sequence) Add a collects relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a collects relationship between two entities.
static void	addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int sequence) Add a collects relationship between two entities.
static void	addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a collects relationship between some entity data and another entity.
static void	addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int sequence) Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addContainedEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a contains relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addContainedEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int upwardConnection) Add a contains relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a containment (contains) relationship between two entities
static void	addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int upwardConnection) Add a containment (contains) relationship between two entities
static void	addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int upwardConnection) Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields
static java.util.Map<java.lang.String,java.lang.Object>	addCustomData(Element element, java.lang.String dataName, java.lang.Object data) Add a custom data entry to some entity data
static java.util.Map<java.lang.String,java.lang.Object>	addCustomData(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.lang.Object data) Add a custom data entry to some entity data
static void	addDependentEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a dependency relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addDependentEntity(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int dependencyType) Add a dependency relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a dependency relationship between two entities
static void	addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int dependencyType) Add a dependency relationship between two entities
static void	addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a dependency relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails, int dependencyType) Add a dependency relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addGenericRelationshipData(java.util.Map<java.lang.String,java.lang.Object> customData, java.lang.String relationship, java.util.Map<java.lang.String,java.lang.Object> relationshipData) Add generic relationship data (e.g.
static void	addGeographicData(Element element, java.util.Map<java.lang.String,java.lang.Object> data) Adds geographical data to a given element.
static void	addHostedService(Element element, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a hostedService relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields
static void	addHostedService(java.util.Map<java.lang.String,java.lang.Object> dataHash, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a hostedService relationship between two entities
static void	addHostedService(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName, java.util.Map<java.lang.String,java.lang.Object> entityDetails) Add a hostedService relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields
static java.lang.Object	getCustomData(Element element, java.lang.String dataName) Get a custom data entry from some element data
static java.lang.Object	getCustomData(java.util.Map<java.lang.String,java.lang.Object> entityData, java.lang.String dataName) Get a custom data entry from some entity data
static java.util.Map<java.lang.String,java.lang.Object>	getGeographicData(Element element) Return the geographic data for a given element as a single map as required for the addGeographicData(Element, Map) method

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectorDataUtils

public CollectorDataUtils()

Method Detail

addCollectedEntity

public static void addCollectedEntity(Element element,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                               throws CollectorException

Add a collects relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

element - The network element that represents the collecting entity

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addCollectedEntity

public static void addCollectedEntity(Element element,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails,
                                      int sequence)
                               throws CollectorException

Add a collects relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

element - The network element that represents the collecting entity

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

sequence - An integer representing the sequence

Throws:

CollectorException

addCollectedEntity

public static void addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                               throws CollectorException

Add a collects relationship between two entities.

Parameters:

dataHash - Reference to a map within the store. The collects relationship will be added to this object, which represents the collecting entity

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addCollectedEntity

public static void addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails,
                                      int sequence)
                               throws CollectorException

Add a collects relationship between two entities.

Parameters:

dataHash - Reference to a map within the store. The collects relationship will be added to this object, which represents the collecting entity

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

sequence - An integer representing the sequence

Throws:

CollectorException

addCollectedEntity

public static void addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                               throws CollectorException

Add a collects relationship between some entity data and another entity. Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

entityData - The map that represents the collecting entity

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addCollectedEntity

public static void addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails,
                                      int sequence)
                               throws CollectorException

Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

entityData - The map that represents the collecting entity

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

sequence - An integer representing the sequence

Throws:

CollectorException

addContainedEntity

public static void addContainedEntity(Element element,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                               throws CollectorException

Add a contains relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

element - The element that represents the containing entity

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addContainedEntity

public static void addContainedEntity(Element element,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails,
                                      int upwardConnection)
                               throws CollectorException

Add a contains relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

element - The element that represents the containing entity

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

upwardConnection - An integer representing the upward connection

Throws:

CollectorException

addContainedEntity

public static void addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                               throws CollectorException

Add a containment (contains) relationship between two entities

Parameters:

dataHash - Reference to a map within the store. The contains relationship will be added to this object, which represents the containing entity

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addContainedEntity

public static void addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails,
                                      int upwardConnection)
                               throws CollectorException

Add a containment (contains) relationship between two entities

Parameters:

dataHash - Reference to a map within the store. The contains relationship will be added to this object, which represents the containing entity

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

upwardConnection - An integer representing the upward connection

Throws:

CollectorException

addContainedEntity

public static void addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                               throws CollectorException

Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

entityData - The map that represents the collecting entity

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addContainedEntity

public static void addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails,
                                      int upwardConnection)
                               throws CollectorException

Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

entityData - The map that represents the containing entity

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

upwardConnection - An integer representing the upward connection

Throws:

CollectorException

addCustomData

public static java.util.Map<java.lang.String,java.lang.Object> addCustomData(Element element,
                                                                             java.lang.String dataName,
                                                                             java.lang.Object data)

Add a custom data entry to some entity data

Parameters:

element - The element data to add the custom data to

dataName - The name of the custom data entry (e.g. ranData)

data - The data to store

Returns:

The custom data map for reference

addCustomData

public static java.util.Map<java.lang.String,java.lang.Object> addCustomData(java.util.Map<java.lang.String,java.lang.Object> entityData,
                                                                             java.lang.String dataName,
                                                                             java.lang.Object data)

Add a custom data entry to some entity data

Parameters:

entityData - The entity data to add the custom data to

dataName - The name of the custom data entry (e.g. ranData)

data - The data to store

Returns:

The custom data map for reference

addDependentEntity

public static void addDependentEntity(Element element,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                               throws CollectorException

Add a dependency relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

element - The element that represents the entity that is required by the dependent

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addDependentEntity

public static void addDependentEntity(Element element,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails,
                                      int dependencyType)
                               throws CollectorException

Add a dependency relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

element - The element that represents the entity that is required by the dependent

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

dependencyType - An integer representing the dependency type

Throws:

CollectorException

addDependentEntity

public static void addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                               throws CollectorException

Add a dependency relationship between two entities

Parameters:

dataHash - Reference to a map within the store. The relationship will be added to this object, which represents the entity that is required by the dependent

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addDependentEntity

public static void addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails,
                                      int dependencyType)
                               throws CollectorException

Add a dependency relationship between two entities

Parameters:

dataHash - Reference to a map within the store. The relationship will be added to this object, which represents the entity that is required by the dependent

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

dependencyType - An integer representing the dependency type

Throws:

CollectorException

addDependentEntity

public static void addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                               throws CollectorException

Add a dependency relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

entityData - The map that represents the entity that is required by the dependent

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addDependentEntity

public static void addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
                                      java.lang.String dataName,
                                      java.util.Map<java.lang.String,java.lang.Object> entityDetails,
                                      int dependencyType)
                               throws CollectorException

Add a dependency relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

entityData - The map that represents the entity that is required by the dependent

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

dependencyType - An integer representing the dependency type

Throws:

CollectorException

addGenericRelationshipData

public static void addGenericRelationshipData(java.util.Map<java.lang.String,java.lang.Object> customData,
                                              java.lang.String relationship,
                                              java.util.Map<java.lang.String,java.lang.Object> relationshipData)
                                       throws CollectorException

Add generic relationship data (e.g. collects, contains, dependency, hostedService) to a custom data entry.

Parameters:

customData - The custom data entry to add the information to (this may be the "root" customData entry, or something more specific, like a "ranData" entry within customData

relationship - The type of relationship (collects, contains, dependency or hostedService)

relationshipData - The relationship data (e.g. the related entity)

Throws:

CollectorException

addGeographicData

public static void addGeographicData(Element element,
                                     java.util.Map<java.lang.String,java.lang.Object> data)

Adds geographical data to a given element. For the format of the data, see CollectorValidationUtils.validateGeographicData(Map)

Parameters:

element - The element to add the geographic data to

data - The geographic location data. Valid fields are:

• locationName (String) - Mandatory name to be assigned to a single geographic location collecting one or more devices.
• longitude (String) - Optional longitude (based on WGS84 standard). Mandatory if latitude is supplied.
• latitude (String) - Optional latitude (based on WGS84 standard). Mandatory if longitude is supplied.
• altitude (String) - Optional altitude (based on WGS84 standard)
• altitudeUnits (String) - Optional units of altitude. Mandatory if altitude is supplied. Valid values are: 'Meters', 'Kilometers', 'Centimeters', 'Feet', 'Yards', 'Miles', 'Inches'
• regionName (String) Optional name to be assigned to a geographic region collecting one or more geographic locations.
• timezoneOffset (String) - Offset of local time from UTC in format UTC-HH:MM or UTC+HH:MM e.g. UTC+10:30, UTC-6:00

See Also:

CollectorValidationUtils.validateGeographicData(Map)

addHostedService

public static void addHostedService(Element element,
                                    java.lang.String dataName,
                                    java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                             throws CollectorException

Add a hostedService relationship between an element and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

element - The element that represents the entity that is the host

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addHostedService

public static void addHostedService(java.util.Map<java.lang.String,java.lang.Object> dataHash,
                                    java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                             throws CollectorException

Add a hostedService relationship between two entities

Parameters:

dataHash - Reference to a map within the store. The relationship will be added to this object, which represents the entity that is the host

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

addHostedService

public static void addHostedService(java.util.Map<java.lang.String,java.lang.Object> entityData,
                                    java.lang.String dataName,
                                    java.util.Map<java.lang.String,java.lang.Object> entityDetails)
                             throws CollectorException

Add a hostedService relationship between some entity data and another entity Note: Adds data under extraInfo or customData -> dataName fields

Parameters:

entityData - The map that represents the entity that is the host

dataName - What kind of data this relationship pertains to (e.g. ranData). If generic, leave as null

entityDetails - Identifying details for the related entity @see CollectorValidationUtils.validateRelationshipData(Map)

Throws:

CollectorException

getCustomData

public static java.lang.Object getCustomData(Element element,
                                             java.lang.String dataName)

Get a custom data entry from some element data

Parameters:

element - The element data from which to fetch the entry

dataName - The name of the custom data entry (e.g. ranData)

Returns:

The custom data entry identified by dataName

getCustomData

public static java.lang.Object getCustomData(java.util.Map<java.lang.String,java.lang.Object> entityData,
                                             java.lang.String dataName)

Get a custom data entry from some entity data

Parameters:

entityData - The entity data from which to fetch the entry

dataName - The name of the custom data entry (e.g. ranData)

Returns:

The custom data entry identified by dataName

getGeographicData

public static java.util.Map<java.lang.String,java.lang.Object> getGeographicData(Element element)

Return the geographic data for a given element as a single map as required for the addGeographicData(Element, Map) method

Parameters:

element - The element for which to get the geographic location

Returns:

A map holding geographic information for that element. For the format, see CollectorValidationUtils.validateGeographicData(Map)