com.ibm.tivoli.nm.collectors.impl.netact

Class NetActCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.netact.NetActCollector

public class NetActCollector
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
NetActCollector(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.lang.String	GetRanData(int dataSourceId, java.lang.String deviceId) Get RAN data for a given device.
protected void	initialiseDataStore() Initialise the data store.
static void	main(java.lang.String[] args) Entry point for this class
static java.util.Properties	reLoadPropertiesFile()
static void	setDATA_SOURCE_ID(int dATA_SOURCE_ID)
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, 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

NetActCollector

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

reLoadPropertiesFile

public static java.util.Properties reLoadPropertiesFile()

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

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.

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

setPropsFile

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

setDATA_SOURCE_ID

public static void setDATA_SOURCE_ID(int dATA_SOURCE_ID)