com.ibm.tivoli.nm.collectors.impl.mtosisoap.util

Class MTOSISoapDataMap

java.lang.Object

com.ibm.tivoli.nm.collectors.impl.mtosisoap.util.MTOSISoapDataMap

public class MTOSISoapDataMap
extends java.lang.Object

Author:

Keat Sin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MTOSISoapDataMap.MTOSISoapEntityType

Constructor Summary

Constructors

Constructor and Description
MTOSISoapDataMap() Constructor

Method Summary

Modifier and Type	Method and Description
void	addDevice(java.lang.String ipAddress, java.lang.String deviceId)
void	addEntity(MTOSISoapDataMap.MTOSISoapEntityType type, java.lang.String deviceId, java.lang.String name) Adds entity data to map that keep tracks of the entity data in Collector DataStore associated with the device Id
protected java.lang.String	convertToSlotTypeName(java.lang.String entityName) This method converts slot name to include '#' e.g Change a subslot name from '2345235~/shelf=1/slot=2/sub_slot=3' to '2345235~/shelf=1/slot=2#/sub_slot=3#'
void	deleteAllEntity() Removes all data in data map
void	deleteEntity(java.lang.String deviceId) Remove all entity data associated with a device Id
boolean	deviceExist(java.lang.String deviceId) Check if device exists in map
boolean	entityExist(MTOSISoapDataMap.MTOSISoapEntityType type, java.lang.String deviceId, java.lang.String name) Check if the entity already exists in map
java.lang.String	getEntityRelPos(java.lang.String strEntityName, java.lang.String cdmType) Returns the value of an entity's relative position to its parent Call this method to find entityParentRelPos for other physical entities such as slot sub_slot fan psu excluding PTP FTP CTP
java.lang.String	getEntityRelPosTP(java.lang.String strEntityName, java.lang.String tpType) Returns the value of TP relative position to its parent Call this method to find entityParentRelPos for PTP, FTP, CTP
java.util.Map<java.lang.String,java.lang.String>	getManagedElementMap() Returns the data map for ManagedElement
java.lang.String	getParentEntity(java.lang.String entityType, java.lang.String entityName, java.lang.String deviceId) Returns the parent of an entity
void	removeDevice(java.lang.String deviceId)

Methods inherited from class java.lang.Object

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

Constructor Detail

MTOSISoapDataMap

public MTOSISoapDataMap()

Constructor

Method Detail

entityExist

public boolean entityExist(MTOSISoapDataMap.MTOSISoapEntityType type,
                           java.lang.String deviceId,
                           java.lang.String name)

Check if the entity already exists in map

Parameters:

type - Entity type

deviceId - Device Id

name - The name of the entity

Returns:

TRUE if entity exist, else FALSE

deviceExist

public boolean deviceExist(java.lang.String deviceId)

Check if device exists in map

Parameters:

deviceId - The Device Id of the device

Returns:

TRUE if exists, else FALSE

addDevice

public void addDevice(java.lang.String ipAddress,
                      java.lang.String deviceId)

removeDevice

public void removeDevice(java.lang.String deviceId)

addEntity

public void addEntity(MTOSISoapDataMap.MTOSISoapEntityType type,
                      java.lang.String deviceId,
                      java.lang.String name)

Adds entity data to map that keep tracks of the entity data in Collector DataStore associated with the device Id

Parameters:

type - Entity Type e.g. SHELF, SLOT, SUBSLOT, etc.

deviceId - Device Id

name - The name of the entity

deleteEntity

public void deleteEntity(java.lang.String deviceId)

Remove all entity data associated with a device Id

Parameters:

deviceId - Device Id

deleteAllEntity

public void deleteAllEntity()

Removes all data in data map

getManagedElementMap

public java.util.Map<java.lang.String,java.lang.String> getManagedElementMap()

Returns the data map for ManagedElement

Returns:

the managedElementMap

getParentEntity

public java.lang.String getParentEntity(java.lang.String entityType,
                                        java.lang.String entityName,
                                        java.lang.String deviceId)

Returns the parent of an entity

Parameters:

entityType - The entity type

entityName - The entity name

deviceId - Device Id of the managed element where the entity resides

Returns:

the name of entity's parent

getEntityRelPosTP

public java.lang.String getEntityRelPosTP(java.lang.String strEntityName,
                                          java.lang.String tpType)

Returns the value of TP relative position to its parent Call this method to find entityParentRelPos for PTP, FTP, CTP

Parameters:

strEntityName - The entity name in either these formats : "GigabitEthernet7/5/2.112"; "Serial7/3/2.235"; "GigabitEthernet7/5/2"; "E1 7/3/2";

tpType - tpType of the entity either PTP, FTP, CTP

Returns:

the entity's relative position to its parent

getEntityRelPos

public java.lang.String getEntityRelPos(java.lang.String strEntityName,
                                        java.lang.String cdmType)

Returns the value of an entity's relative position to its parent Call this method to find entityParentRelPos for other physical entities such as slot sub_slot fan psu excluding PTP FTP CTP

Parameters:

strEntityName - The entity name

Returns:

the entity's relative position to its parent

convertToSlotTypeName

protected java.lang.String convertToSlotTypeName(java.lang.String entityName)

This method converts slot name to include '#' e.g Change a subslot name from '2345235~/shelf=1/slot=2/sub_slot=3' to '2345235~/shelf=1/slot=2#/sub_slot=3#'

Parameters:

entityName - Name of the slot/subslot

Returns:

Name of the slot/subslot with '#' appended