com.ibm.tivoli.nm.collectors.impl.huaweim2k

Class HuaweiM2KCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.huaweim2k.HuaweiM2KCollector

public class HuaweiM2KCollector
extends Collector

This Collector retrieves 2G/3G/RAN/LTE data from a Huawei EMS by processing XML dump files.

Author:

Yeo Eng Seng

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
HuaweiM2KCollector(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.
void	configureCollector(java.lang.String[] args) Configures all Collector properties using both command-line arguments and settings from the Properties file.
java.lang.String	GetEirData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetENodeBData(int dataSourceId, int deviceId)
java.lang.String	GetENodeBData(int dataSourceId, java.lang.String deviceId) Returns eNodeB data represented in an XML string
java.lang.String	GetGNodeBData(int dataSourceId, int deviceId) * @param dataSourceId * @param deviceId * @return
java.lang.String	GetGNodeBData(int dataSourceId, java.lang.String deviceId) * Returns gNodeB data represented in an XML string * * @param dataSourceId * Data source identifier * @param deviceId * gNodeB device identifier * * @return gNodeB data as XML string
java.lang.String	GetHssData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetMmeData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetPcrfData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetPgwData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetRanData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetSgwData(int dataSourceId, java.lang.String deviceId)
void	initDataStore() Initialises the Collector DataStore
static void	main(java.lang.String[] args) Runs the collector by using the CollectorEmbeddedServer#runEmbeddedServer(Collector, int) method to run the collector on a port specified either on the command line or in a supplied properties file.
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, GetEntities, GetEntities, GetInfo, GetInventory, GetInventory, GetLayer1Connections, GetLayer1Connections, GetLayer2Connections, GetLayer2Connections, GetLayer2Vpns, GetLayer2Vpns, GetLayer3Connections, GetLayer3Connections, GetLayer3Vpns, GetLayer3Vpns, GetMplsInterfaces, GetMplsInterfaces, GetNefData, GetNrfData, GetNssfData, GetPcfData, getPortNumberArgument, getPropertiesFileNameArgument, getPropertyValue, GetSAEGatewayData, GetSmfData, GetUdmData, GetUpfData, initialiseDataStore, 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

HuaweiM2KCollector

public HuaweiM2KCollector(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

GetENodeBData

public java.lang.String GetENodeBData(int dataSourceId,
                                      int deviceId)

Parameters:

dataSourceId -

deviceId -

Returns:

GetGNodeBData

public java.lang.String GetGNodeBData(int dataSourceId,
                                      int deviceId)

* @param dataSourceId * @param deviceId * @return

GetENodeBData

public java.lang.String GetENodeBData(int dataSourceId,
                                      java.lang.String deviceId)

Returns eNodeB data represented in an XML string

Overrides:

GetENodeBData in class Collector

Parameters:

dataSourceId - Data source identifier

deviceId - eNodeB device identifier

Returns:

eNodeB data as XML string

GetGNodeBData

public java.lang.String GetGNodeBData(int dataSourceId,
                                      java.lang.String deviceId)

* Returns gNodeB data represented in an XML string * * @param dataSourceId * Data source identifier * @param deviceId * gNodeB device identifier * * @return gNodeB data as XML string

Overrides:

GetGNodeBData in class Collector

GetMmeData

public java.lang.String GetMmeData(int dataSourceId,
                                   java.lang.String deviceId)

Overrides:

GetMmeData in class Collector

Parameters:

dataSourceId -

deviceId -

Returns:

GetPgwData

public java.lang.String GetPgwData(int dataSourceId,
                                   java.lang.String deviceId)

Overrides:

GetPgwData in class Collector

Parameters:

dataSourceId -

deviceId -

Returns:

GetRanData

public java.lang.String GetRanData(int dataSourceId,
                                   java.lang.String deviceId)

Overrides:

GetRanData in class Collector

Parameters:

dataSourceId -

deviceId -

Returns:

GetSgwData

public java.lang.String GetSgwData(int dataSourceId,
                                   java.lang.String deviceId)

Overrides:

GetSgwData in class Collector

Parameters:

dataSourceId -

deviceId -

Returns:

GetPcrfData

public java.lang.String GetPcrfData(int dataSourceId,
                                    java.lang.String deviceId)

Overrides:

GetPcrfData in class Collector

Parameters:

dataSourceId -

deviceId -

Returns:

GetHssData

public java.lang.String GetHssData(int dataSourceId,
                                   java.lang.String deviceId)

Overrides:

GetHssData in class Collector

Parameters:

dataSourceId -

deviceId -

Returns:

GetEirData

public java.lang.String GetEirData(int dataSourceId,
                                   java.lang.String deviceId)

Overrides:

GetEirData in class Collector

Parameters:

dataSourceId -

deviceId -

Returns:

configureCollector

public void configureCollector(java.lang.String[] args)
                        throws CollectorException

Configures all Collector properties using both command-line arguments and settings from the Properties file.

Parameters:

args - Command-line arguments

Throws:

CollectorException

initDataStore

public void initDataStore()
                   throws CollectorException

Initialises the Collector DataStore

Throws:

CollectorException

main

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

Runs the collector by using the CollectorEmbeddedServer#runEmbeddedServer(Collector, int) method to run the collector on a port specified either on the command line or in a supplied properties file.

Parameters:

args - Command line arguments, e.g. -propsFile <props file name>