com.ibm.tivoli.nm.collectors.sample

Class SampleRANCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.sample.SampleRANCollector

public class SampleRANCollector
extends Collector

Sample class for a java based ITNM collector that handles RAN data. This collector is very similar to SampleCollector but makes use of the RANDataStore in order to store RAN specific data. It also implements a GetRanData(int, String) method to respond to the GetRanData XML-RPC request from the RAN agent.

Author:

Emlyn Whittick

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
SampleRANCollector(java.lang.String collectorName, java.lang.String collectorDescription) Create a new instance of the RAN collector.

Method Summary

Modifier and Type	Method and Description
protected void	collectData(int dataSourceId, java.lang.String address, java.lang.String mask) This method adds some sample data to the collector RAN data store.
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) The collector is run by implementing a public static void main(String[] args) method.

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, UpdateData

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleRANCollector

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

Create a new instance of the RAN collector. This method simply calls the corresponding method in the super class and initialises the logger.

Parameters:

collectorName - The name of the collector

collectorDescription - A description of the collector

Method Detail

collectData

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

This method adds some sample data to the collector RAN data store. The following are added to the data store:

1. A base station with ID baseStation1 and a parent base station controller with ID controller1. The base station has a logical RAN connection to the base station controller.
2. A second base station with ID baseStation2 and a parent base station controller with ID controller1. The base station has a logical RAN connection to the base station controller.
3. An SGSN with ID sgsn1 with a single interface, that has a logical RAN connection to the base station controller with ID controller1.
4. A transceiver with ID trx1 under baseStation1 which is collected by GSMCell1.
5. A second transceiver with ID trx2 under baseStation1 which is collected by GSMCell1.
6. A third transceiver with ID trx3 under baseStation1.
7. A fourth transceiver with ID trx4 under baseStation2 which is collected by GSMCell2.
8. A GSM cell with ID GSMCell1, with a dependency on baseStation1.
9. A GSM cell with ID GSMCell2, with a dependency on baseStation2.
10. A RAN sector with ID sector1 under trx1
11. A RAN sector with ID sector2 under trx2
12. A RAN Node B with ID nodeB1 and a parent radio network controller with ID "My Radio Network Controller"
13. A RAN Node B local cell with ID ranNodeBLocalCell1 under nodeB1
14. A multiplexer with ID multiplexer1

This would generate the following data model:

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

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

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)

The collector is run by implementing a public static void main(String[] args) method. Here we create a new instance of the SampleRANCollector and then use CollectorEmbeddedServer#runEmbeddedServer(Collector, String[]) to run the collector on an embedded server. If no port is specified in the command line arguments (-port <port_number>), then the default port of 8080 is used.

Parameters:

args - Command line arguments to the collector, e.g. -port <port_number>