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

Class MTOSISoapCollector

java.lang.Object

com.ibm.tivoli.nm.collectors.framework.collector.Collector

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

public class MTOSISoapCollector
extends Collector

This collector supports data retrieval of EMS using MTOSI through SOAP over HTTP

Author:

Lim Keat Sin

Field Summary

Fields inherited from class com.ibm.tivoli.nm.collectors.framework.collector.Collector

collectData, collectorDescription, collectorName, collectorPort, dataStore, propsFileName, running

Constructor Summary

Constructors

Constructor and Description
MTOSISoapCollector(java.lang.String collectorName, java.lang.String collectorDescription) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	collectData(int dataSourceId, java.lang.String address, java.lang.String mask) This method is responsible for ensuring that data is updated as appropriate, that is, the Collector should check the EMS for new data and update any internal stores as appropriate.
java.util.List<NamingAttributeType>	getAllPhysicalTerminationPointNames(java.lang.String meId) Retrieve all termination points names within a ManagedElement
TerminationPointListType	getContainedTerminationPoint(java.util.List<RelativeDistinguishNameType> listRdType) Retrieves a termination point data
java.util.List<ManagedElementType>	getManagedElement(java.util.List<RelativeDistinguishNameType> listRdType) Returns a list of ManagedElement data from the SOAP response
java.util.List<TerminationPointType>	getTerminationPoint(java.util.List<RelativeDistinguishNameType> listRdType) Retrieves data for a termination point
protected void	initialiseDataStore() Initialise the data store.
static void	main(java.lang.String[] args) Entry point for this class
void	processAllTopologicalLinks(java.util.List<TopologicalLinkType> tlLst, java.util.Set<java.lang.String> tcSet) Process all topological links and add to collector data store
protected void	processManagedElements(java.util.List<NamingAttributeType> meNamesList) Retrieve Managed Element and add to Collector DataStore
void	retrieveAllTerminationPoints(java.lang.String deviceId) Process TerminationPoints data and add to Collector DataStore
static void	setPropsFile(java.util.Properties propsFile)
java.lang.String	UpdateData(int dataSourceId, int requestType, java.lang.String address, java.lang.String mask) UpdateData invokes the collectData method which is responsible for ensuring that data is updated as appropriate, that is, the Collector should check the EMS for new data and update any internal stores as appropriate.

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.collector.Collector

GetAfData, GetAmfData, GetAssociatedAddresses, GetAssociatedAddresses, GetAusfData, getCommandLineArgument, GetConnections, GetConnections, GetDeviceInfo, GetDeviceInfo, GetDeviceInfo, GetDeviceList, GetEirData, GetENodeBData, GetEntities, GetEntities, GetGNodeBData, GetHssData, GetInfo, GetInventory, GetInventory, GetLayer1Connections, GetLayer1Connections, GetLayer2Connections, GetLayer2Connections, GetLayer2Vpns, GetLayer2Vpns, GetLayer3Connections, GetLayer3Connections, GetLayer3Vpns, GetLayer3Vpns, GetMmeData, GetMplsInterfaces, GetMplsInterfaces, GetNefData, GetNrfData, GetNssfData, GetPcfData, GetPcrfData, GetPgwData, getPortNumberArgument, getPropertiesFileNameArgument, getPropertyValue, GetRanData, GetSAEGatewayData, GetSgwData, GetSmfData, GetUdmData, GetUpfData, isRunning, loadPropertiesFile, setDataStore, setRunning, shutdown, startup, startup

Methods inherited from class java.lang.Object

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

Constructor Detail

MTOSISoapCollector

public MTOSISoapCollector(java.lang.String collectorName,
                          java.lang.String collectorDescription)

Constructor

Parameters:

collectorName - Collector name

collectorDescription - Collector description

Method Detail

UpdateData

public java.lang.String UpdateData(int dataSourceId,
                                   int requestType,
                                   java.lang.String address,
                                   java.lang.String mask)

Description copied from class: Collector

UpdateData invokes the collectData method which is responsible for ensuring that data is updated as appropriate, that is, the Collector should check the EMS for new data and update any internal stores as appropriate.

If the Collector does not need to update its data then it does not need to perform any work other than returning the response message "<updateResponse></updateResponse>".

Note: Is it the Collector's responsibility to determine which devices the supplied IP relates to; the IP is NOT guaranteed to be the device id.

Overrides:

UpdateData in class Collector

Parameters:

dataSourceId - Holds the ID of the data source which should be updated

requestType - The type of request

address - If mask is not defined then it holds the address of the device to refresh, or else it holds the subnet to refresh. If requestType is 1 then the address may be an IP or EMS native identifier.

mask - Holds the subnet mask, or is not defined

Returns:

A message to acknowledge that the update has been completed e.g.

          <updateResponse></updateResponse>
 

collectData

protected void collectData(int dataSourceId,
                           java.lang.String address,
                           java.lang.String mask)

Description copied from class: Collector

This method is responsible for ensuring that data is updated as appropriate, that is, the Collector should check the EMS for new data and update any internal stores as appropriate.

Specified by:

collectData in class Collector

Parameters:

dataSourceId - Holds the ID of the data source which should be updated

address - If mask is not defined then it holds the address (IP or native id) of the device to refresh, or else it holds the subnet to refresh.

mask - Holds the subnet mask, or is not defined

initialiseDataStore

protected void initialiseDataStore()

Description copied from class: Collector

Initialise the data store. Uses an in memory data store @see DataStore . Should be overridden if a different kind of data store is to be used.

Overrides:

initialiseDataStore in class Collector

getAllPhysicalTerminationPointNames

public java.util.List<NamingAttributeType> getAllPhysicalTerminationPointNames(java.lang.String meId)
                                                                        throws GetAllPhysicalTerminationPointNamesException

Retrieve all termination points names within a ManagedElement

Parameters:

meId - The device Id of the ManagedElement

Returns:

List of NamingAttributeType objects which contains names of TerminationPoints

Throws:

GetAllPhysicalTerminationPointNamesException

retrieveAllTerminationPoints

public void retrieveAllTerminationPoints(java.lang.String deviceId)
                                  throws CollectorException

Process TerminationPoints data and add to Collector DataStore

Parameters:

deviceId - The device Id of the ManagedElement

Throws:

CollectorException

getTerminationPoint

public java.util.List<TerminationPointType> getTerminationPoint(java.util.List<RelativeDistinguishNameType> listRdType)
                                                         throws GetTerminationPointException

Retrieves data for a termination point

Parameters:

listRdType - List of RelativeDistinguishNameType objects that contains ManagedElement device Id , Management Domain information, name and type of termination point

Returns:

Termination point data in TerminationPointType

Throws:

GetTerminationPointException

getContainedTerminationPoint

public TerminationPointListType getContainedTerminationPoint(java.util.List<RelativeDistinguishNameType> listRdType)

Retrieves a termination point data

Parameters:

listRdType - List of RelativeDistinguishNameType objects that contains ManagedElement device Id , Management Domain information, name and type of termination point

Returns:

A termination point in TerminationPointType

processManagedElements

protected void processManagedElements(java.util.List<NamingAttributeType> meNamesList)

Retrieve Managed Element and add to Collector DataStore

processAllTopologicalLinks

public void processAllTopologicalLinks(java.util.List<TopologicalLinkType> tlLst,
                                       java.util.Set<java.lang.String> tcSet)

Process all topological links and add to collector data store

Parameters:

tlLst -

tcSet -

getManagedElement

public java.util.List<ManagedElementType> getManagedElement(java.util.List<RelativeDistinguishNameType> listRdType)
                                                     throws GetManagedElementException

Returns a list of ManagedElement data from the SOAP response

Returns:

ManagedElementType object from SOAP response

Throws:

GetManagedElementException

main

public static void main(java.lang.String[] args)

Entry point for this class

Parameters:

args - The following are acceptable arguments for this Collector:

• -port (Port to run this Collector XML-RPC server)
• -propsFile (Path to this Collector's properties file)

If no arguments are specified, the default values will be used.

setPropsFile

public static void setPropsFile(java.util.Properties propsFile)