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

Class EquipmentRetrieval

java.lang.Object

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

public class EquipmentRetrieval
extends java.lang.Object

This class retrieves equipment data of a managed element i.e. namely shelf, slot, sublots, modules, fan , PSU , etc.

Author:

Keat Sin

Constructor Summary

Constructors

Constructor and Description
EquipmentRetrieval(MTOSISoapCollectorProperties props) Constructor

Method Summary

Modifier and Type	Method and Description
GetAllEquipmentRequestType	getAllEquipmentRequestBody(java.lang.String meId) Sets up the data request body based on ManagedElement Id
Header	getAllEquipmentRequestHeader() Sets up header for equipment data request
java.lang.String	getEhValue(EquipmentHolderType eqH)
java.lang.String	getEhValue(EquipmentType eq)
GetEquipmentRequest	getEquipmentRequestBody(java.lang.String meId, java.lang.String strEhValue, java.lang.String strEqValue)
Header	getEquipmentRequestHeader()
EquipmentInventoryRetrievalRPC	getEquipmentRetrievalRPC() Returns the initialised EquipmentInventoryRetrievalRPC object
java.lang.String	getEqValue(EquipmentType eq)
java.lang.String	getMtosiInterfaceName()
java.util.Map<java.lang.String,java.lang.Object>	getShelfSlot(java.lang.String deviceId, EquipmentHolderType eqH, EquipmentHolderEnumType enumType, MTOSISoapDataMap dataMap) Returns a map containing shelf and slots data formatted to Collector DataStore format
java.util.Map<java.lang.String,java.lang.Object>	getSlotsModules(java.lang.String deviceId, EquipmentType eq, MTOSISoapDataMap dataMap) Returns a Map containing shelf and slots data formatted to Collector DataStore format.
void	init()

Methods inherited from class java.lang.Object

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

Constructor Detail

EquipmentRetrieval

public EquipmentRetrieval(MTOSISoapCollectorProperties props)

Constructor

Parameters:

props - MTOSISoapCollectorProperties instance

Method Detail

init

public void init()

getEquipmentRetrievalRPC

public EquipmentInventoryRetrievalRPC getEquipmentRetrievalRPC()

Returns the initialised EquipmentInventoryRetrievalRPC object

getMtosiInterfaceName

public java.lang.String getMtosiInterfaceName()

Returns:

getAllEquipmentRequestHeader

public Header getAllEquipmentRequestHeader()

Sets up header for equipment data request

Returns:

Header the SOAP request

getAllEquipmentRequestBody

public GetAllEquipmentRequestType getAllEquipmentRequestBody(java.lang.String meId)

Sets up the data request body based on ManagedElement Id

Parameters:

meId - The ManagedElement Id of the equipments

Returns:

Body for SOAP request

getEquipmentRequestHeader

public Header getEquipmentRequestHeader()

Returns:

getEquipmentRequestBody

public GetEquipmentRequest getEquipmentRequestBody(java.lang.String meId,
                                                   java.lang.String strEhValue,
                                                   java.lang.String strEqValue)

Parameters:

meId -

strEhRef -

Returns:

getShelfSlot

public java.util.Map<java.lang.String,java.lang.Object> getShelfSlot(java.lang.String deviceId,
                                                                     EquipmentHolderType eqH,
                                                                     EquipmentHolderEnumType enumType,
                                                                     MTOSISoapDataMap dataMap)

Returns a map containing shelf and slots data formatted to Collector DataStore format

Parameters:

deviceId - The device Id

eqH - The EquipmentHolderType object which holds equipment holder data such as Shelf, Slot and Subslots.

enumType - Enumeration of the equipment holder type.

dataMap - Data map of device and their entities added to Collector DataStore.

Returns:

a map processed to Collector DataStore format

Throws:

CollectorException

getSlotsModules

public java.util.Map<java.lang.String,java.lang.Object> getSlotsModules(java.lang.String deviceId,
                                                                        EquipmentType eq,
                                                                        MTOSISoapDataMap dataMap)

Returns a Map containing shelf and slots data formatted to Collector DataStore format.

Parameters:

deviceId - The device Id of ManagedElement.

eq - The EquipmentType object which holds equipment data such as modules(cards), power supply, fan, etc.

dataMap - Data map of device and their entities added to Collector DataStore.

Returns:

getEhValue

public java.lang.String getEhValue(EquipmentHolderType eqH)

Parameters:

eqH -

Returns:

getEhValue

public java.lang.String getEhValue(EquipmentType eq)

Parameters:

eq -

Returns:

getEqValue

public java.lang.String getEqValue(EquipmentType eq)

Parameters:

eq -

Returns: