com.ibm.tivoli.nm.collectors.impl.netactcmdump

Class NetActCMDumpCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.netactcmdump.NetActCMDumpCollector

public class NetActCMDumpCollector
extends Collector

This Collector supports data retrieval from a NetAct EMS

Author:

An IBMer

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
NetActCMDumpCollector(java.lang.String collectorName, java.lang.String collectorDescription) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	classToProcess(java.lang.String className)
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.lang.String	GetAssociatedAddresses(int dataSourceId, java.lang.String deviceId) Get LTE associated addresses for a given data source and device ID
java.lang.String	GetConnections(int dataSourceId, java.lang.String deviceId, java.lang.String topologyType) Get LTE Connections name for a given data source, device ID and topology type
java.lang.String	GetDeviceInfo(int dataSourceId, java.lang.String deviceId) Get LTE device info for a given data source and device ID
java.lang.String	GetDeviceList(int dataSourceId) Get LTE device list for a given data source
java.lang.String	GetENodeBData(int dataSourceId, java.lang.String deviceId) Get ENodeB data for a given device.
java.lang.String	GetEntities(int dataSourceId, java.lang.String deviceId) Get LTE Entities for a given data source and device ID
java.lang.String	GetInterfaceName(int dataSourceId, java.lang.String deviceId, java.lang.String interfaceKey) Get LTE Interface name for a given data source, device ID and interface key
java.lang.String	GetInventory(int dataSourceId, java.lang.String deviceId) Get LTE Inventory for a given data source and device ID
java.lang.String	GetMmeData(int dataSourceId, java.lang.String deviceId) Get MME data for a given device.
java.lang.String	GetPgwData(int dataSourceId, java.lang.String deviceId) Get PGW data for a given device.
java.util.Set<java.lang.String>	getProcessedEntity()
java.lang.String	GetRanData(int dataSourceId, java.lang.String deviceId) Get RAN data for a given device.
java.lang.String	GetSgwData(int dataSourceId, java.lang.String deviceId) Get SGW data for a given device.
protected void	initialiseDataStore() Initialise the data store.
static void	main(java.lang.String[] args) Entry point for this class
boolean	processInventoryFile(java.lang.String file, java.lang.String dirName, java.lang.String nodeId) Processes all the inventory xml files
static java.util.Properties	reLoadPropertiesFile()
static void	setDATA_SOURCE_ID(int dATA_SOURCE_ID)
static void	setPropsFile(java.util.Properties propsFile)
static void	setRetrieveAllClass(boolean retrieveAllClass)
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.
java.util.List<java.nio.file.Path>	verifyTimeStamp(java.util.List<java.nio.file.Path> validFiles, java.util.Map<java.lang.String,java.nio.file.attribute.FileTime> xmlDataLastModifiedTimes) Verifies the last modified file against the ones in the Map.

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

GetAfData, GetAmfData, GetAssociatedAddresses, GetAusfData, getCommandLineArgument, GetConnections, GetDeviceInfo, GetDeviceInfo, GetDeviceList, GetEirData, GetEntities, GetGNodeBData, GetHssData, GetInfo, GetInventory, GetLayer1Connections, GetLayer1Connections, GetLayer2Connections, GetLayer2Connections, GetLayer2Vpns, GetLayer2Vpns, GetLayer3Connections, GetLayer3Connections, GetLayer3Vpns, GetLayer3Vpns, GetMplsInterfaces, GetMplsInterfaces, GetNefData, GetNrfData, GetNssfData, GetPcfData, GetPcrfData, getPortNumberArgument, getPropertiesFileNameArgument, getPropertyValue, GetSAEGatewayData, 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

NetActCMDumpCollector

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

Constructor

Parameters:

collectorName - Collector name

collectorDescription - Collector description

Method Detail

reLoadPropertiesFile

public static java.util.Properties reLoadPropertiesFile()

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

GetAssociatedAddresses

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

Get LTE associated addresses for a given data source and device ID

Overrides:

GetAssociatedAddresses in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing associated addresses for the given data source ID and device ID

GetConnections

public java.lang.String GetConnections(int dataSourceId,
                                       java.lang.String deviceId,
                                       java.lang.String topologyType)

Get LTE Connections name for a given data source, device ID and topology type

Overrides:

GetConnections in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

topologyType - The topology type

Returns:

An XML String representing connections for the given data source ID and device ID

GetDeviceInfo

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

Get LTE device info for a given data source and device ID

Overrides:

GetDeviceInfo in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing device info for the given data source ID and device ID

GetDeviceList

public java.lang.String GetDeviceList(int dataSourceId)

Get LTE device list for a given data source

Parameters:

dataSourceId - The ID of the data source

Returns:

An XML String representing all the LTE device list for the given data source ID

GetENodeBData

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

Get ENodeB data for a given device. Implements the XML-RPC 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

GetEntities

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

Get LTE Entities for a given data source and device ID

Overrides:

GetEntities in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing entities for the given data source ID and device ID

GetInterfaceName

public java.lang.String GetInterfaceName(int dataSourceId,
                                         java.lang.String deviceId,
                                         java.lang.String interfaceKey)

Get LTE Interface name for a given data source, device ID and interface key

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

interfaceKey - The interface key

Returns:

An XML String representing interface for the given data source ID and device ID

GetInventory

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

Get LTE Inventory for a given data source and device ID

Overrides:

GetInventory in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing inventory for the given data source ID and device ID

GetMmeData

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

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

Overrides:

GetMmeData 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

GetPgwData

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

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

Overrides:

GetPgwData 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

GetRanData

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

Get RAN data for a given device. Implements the XML-RPC method for getting RAN data required by the RAN agent. Returns an XML string that represents all of the custom RAN data (mapping to the appropriate RAN NCIM tables) for the specified device. Invoked the RANDataStore.getRANData(int, String) method of RANDataStore to generate the XML String.

Overrides:

GetRanData 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 RAN data for the given device

GetSgwData

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

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

Overrides:

GetSgwData 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

initialiseDataStore

protected void initialiseDataStore()

Initialise the data store. Uses an in memory, RAN specific data store, RANDataStore instead of the default DataStore. Also adds a single data source (with ID 1) to the data store.

Overrides:

initialiseDataStore in class Collector

processInventoryFile

public boolean processInventoryFile(java.lang.String file,
                                    java.lang.String dirName,
                                    java.lang.String nodeId)

Processes all the inventory xml files

Parameters:

file - The file name

dirName - The directory where the file is available

nodeId - Node id, for partial discovery. Null otherwise

Returns:

true if file is processed, false otherwise

classToProcess

public boolean classToProcess(java.lang.String className)

Parameters:

className -

Returns:

verifyTimeStamp

public java.util.List<java.nio.file.Path> verifyTimeStamp(java.util.List<java.nio.file.Path> validFiles,
                                                          java.util.Map<java.lang.String,java.nio.file.attribute.FileTime> xmlDataLastModifiedTimes)
                                                   throws java.io.IOException

Verifies the last modified file against the ones in the Map. If the timestamp is newer, add it in the list of verified files.

Parameters:

listOfFiles - The list of files in an array list

xmlDataLastModifiedTimes - Map containing the list of files with last modified timestamps

Returns:

ArrayList containing valid files

Throws:

java.io.IOException

getProcessedEntity

public java.util.Set<java.lang.String> getProcessedEntity()

Returns:

the processedEntity

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)

setRetrieveAllClass

public static void setRetrieveAllClass(boolean retrieveAllClass)

setDATA_SOURCE_ID

public static void setDATA_SOURCE_ID(int dATA_SOURCE_ID)