com.ibm.tivoli.nm.collectors.sample

Class SampleLTECollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.sample.SampleLTECollector

public class SampleLTECollector
extends Collector

Sample class for a java based ITNM collector that handles LTE data

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

Method Summary

Modifier and Type	Method and Description
protected void	collectData(int ds, 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) Optional - The Collector implementation of GetConnections() is responsible for gathering and returning all resolved connection information for the supplied topology type and supplied device and data source.
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	GetEirData(int dataSourceId, java.lang.String deviceId) Get LTE EIR data for a given data source and EIR Name
java.lang.String	GetENodeBData(int dataSourceId, java.lang.String deviceId) Get LTE eNodeB data for a given data source and eNodeB ID
java.lang.String	GetEntities(int dataSourceId, java.lang.String deviceId) Optional - The Collector implementation of GetEntities() is responsible for gathering and returning ENTITY-MIB style entity information for a given device id and data source.
java.lang.String	GetHssData(int dataSourceId, java.lang.String deviceId) Get LTE HSS data for a given data source and HSS Name
java.lang.String	GetInterfaceName(int dataSourceId, java.lang.String deviceId, java.lang.String interfaceKey)
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 LTE MME data for a given data source and MME Name
java.lang.String	GetPcrfData(int dataSourceId, java.lang.String deviceId) Get LTE PCRF data for a given data source and PCRF Name
java.lang.String	GetPgwData(int dataSourceId, java.lang.String deviceId) Get LTE PGW data for a given data source and PGW Name
java.lang.String	GetSgwData(int dataSourceId, java.lang.String deviceId) Get LTE SGW data for a given data source and SGW Name
protected void	initialiseDataStore() Initialise the data store.
static void	main(java.lang.String[] args) This is how we run the collector

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

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

SampleLTECollector

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

Create a new instance of the LTE collector

Parameters:

collectorName - The name of the collector

collectorDescription - A description of the collector

Method Detail

collectData

protected void collectData(int ds,
                           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:

ds - 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

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

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

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

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

GetENodeBData

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

Get LTE eNodeB data for a given data source and eNodeB ID

Overrides:

GetENodeBData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

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

GetMmeData

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

Get LTE MME data for a given data source and MME Name

Overrides:

GetMmeData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The Name of the device

Returns:

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

GetSgwData

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

Get LTE SGW data for a given data source and SGW Name

Overrides:

GetSgwData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The Name of the device

Returns:

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

GetPgwData

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

Get LTE PGW data for a given data source and PGW Name

Overrides:

GetPgwData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The Name of the device

Returns:

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

GetHssData

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

Get LTE HSS data for a given data source and HSS Name

Overrides:

GetHssData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The Name of the device

Returns:

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

GetPcrfData

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

Get LTE PCRF data for a given data source and PCRF Name

Overrides:

GetPcrfData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The Name of the device

Returns:

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

GetEirData

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

Get LTE EIR data for a given data source and EIR Name

Overrides:

GetEirData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The Name of the device

Returns:

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

GetEntities

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

Description copied from class: Collector

Optional - The Collector implementation of GetEntities() is responsible for gathering and returning ENTITY-MIB style entity information for a given device id and data source.

This method is used by the CollectorInventory agent to produce a list of entity information for later use in containment modeling.

Overrides:

GetEntities in class Collector

Parameters:

dataSourceId - The ID for the data source

deviceId - The ID for the device

Returns:

An XML String listing all the entities for a given device e.g.

  <entityData>
   <entityList>
     <entity>
       <name>A Vendor 9-slot Chassis System</name>
       <class>3</class>
       <index>1</index>
       <vendorType>1.3.6.1.4.1.0.3.175</vendorType>
       <descr>ACME-2000</descr>
       <parentRelPos>-1</parentRelPos>
     </entity>
     .. other entities ..
   </entityList>
 </entityData>
 

GetInterfaceName

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

GetConnections

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

Description copied from class: Collector

Optional - The Collector implementation of GetConnections() is responsible for gathering and returning all resolved connection information for the supplied topology type and supplied device and data source.

Overrides:

GetConnections in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

topologyType - The connection topology type, for example Layer1, Layer2, Layer3 or Microwave

Returns:

An XML String describing all connections for the specified topology type for the device, for example, for the Microwave topology type:

  <microwaveConnections>
   <connection>
     <dest>10.1.230.1</dest>
     <destIfIndex>22</destIfIndex>
     <srcIfIndex>9</srcIfIndex>
     <src>10.1.254.1</src>
   </connection>
   <connection>
     <dest>10.1.230.1</dest>
     <destInterfaceId>MyUniqueId22</destInterfaceId>
     <srcInterfaceId>MyUniqueId9</srcInterfaceId>
     <src>10.1.254.1</src>
   </connection>
 </microwaveConnections>
 

initialiseDataStore

protected void initialiseDataStore()

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

Overrides:

initialiseDataStore in class Collector

main

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

This is how we run the collector

Parameters:

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