com.ibm.tivoli.nm.collectors.impl.samsung.usm820

Class Samsung820USMXmlCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.samsung.usm820.Samsung820USMXmlCollector

public class Samsung820USMXmlCollector
extends Collector

This Collector supports data retrieval from Ericsson ENM EMS

Author:

Mustafa

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
Samsung820USMXmlCollector(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	extractInventoryFiles(java.lang.String invPath)
java.lang.String	GetENodeBData(int dataSourceId, java.lang.String deviceId) Get ENodeB data for a given device.
java.lang.String	GetGNodeBData(int dataSourceId, java.lang.String deviceId) Get GNodeB data for a given device.
protected void	initialiseDataStore() Initialise the data store.
void	loadFirstRun() Read the LoadFirstRun flag from properties file and perform collect data if the flag is set to TRUE
static void	main(java.lang.String[] args) Entry point for this class
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, GetEntities, GetEntities, 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

Samsung820USMXmlCollector

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

Constructor

Parameters:

collectorName - - collector name

collectorDescription - - collector description

Method Detail

initialiseDataStore

protected void initialiseDataStore()

Initialise the data store. Uses an in memory, LTE specific data store @see LTEDataStore.

Overrides:

initialiseDataStore in class Collector

GetGNodeBData

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

Get GNodeB data for a given device. Implements the gRPC method for GetGNodeBData() required by the 5G agent. Returns an XML string that represents a GNodeB entity data. Use 5GDataStore to generate the XML String.

Overrides:

GetGNodeBData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing all of the 5G data for the given device

GetENodeBData

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

Get ENodeB data for a given device. Implements the gRPC method for GetENodeBData() required by the LTE agent. Returns an XML string that represents a ENodeB entity data. Use LTEDataStore to generate the XML String.

Overrides:

GetENodeBData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing all of the LTE data for the given device

extractInventoryFiles

public void extractInventoryFiles(java.lang.String invPath)

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

loadFirstRun

public void loadFirstRun()

Read the LoadFirstRun flag from properties file and perform collect data if the flag is set to TRUE

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.