com.ibm.tivoli.nm.collectors.impl.huaweitl1

Class HuaweiTL1Collector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.huaweitl1.HuaweiTL1Collector

public class HuaweiTL1Collector
extends Collector

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

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	GetAssociatedAddresses(int dataSourceId, java.lang.String deviceId) The Collector implementation of GetAssociatedAddresses() is responsible for gathering and returning all IP addresses configured on a given device id 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	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	GetInfo() The Collector implementation of GetInfo() is responsible for responding with information on the Collector and its supported data sources.
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
protected void	initialiseDataStore() Initialise the data store.
static void	main(java.lang.String[] args)
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, GetAusfData, getCommandLineArgument, GetConnections, GetConnections, GetDeviceInfo, GetDeviceInfo, GetDeviceList, GetEirData, GetENodeBData, GetEntities, GetGNodeBData, GetHssData, 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

HuaweiTL1Collector

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

Method Detail

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

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

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)

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

GetInfo

public java.lang.String GetInfo()

Description copied from class: Collector

The Collector implementation of GetInfo() is responsible for responding with information on the Collector and its supported data sources.

This method is called by ITNM's Collector Finder to determine which Collectors are valid and which data sources they support. ITNM will subsequently issue RPC calls for data from the listed data sources.

The Collector is responsible for ensuring that each data source has a unique identifier.

Overrides:

GetInfo in class Collector

Returns:

An XML String describing the collector and listing its data sources e.g.

  <collectorInfo>
   <name>CollectorsName</name>
   <descr>Collectors Description</descr>
   <datasources>
     <datasource>
       <id>1</id>
       <descr>Example data source</descr>
     </datasource>
     .. other data sources ..
   </datasources>
 </collectorInfo>
 

GetAssociatedAddresses

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

Description copied from class: Collector

The Collector implementation of GetAssociatedAddresses() is responsible for gathering and returning all IP addresses configured on a given device id and data source.

This method is used by the CollectorInventory agents to produce a list of associated IP addresses to allow ITNM to perform address translation.

Overrides:

GetAssociatedAddresses in class Collector

Parameters:

dataSourceId - The ID for the data source

deviceId - The ID for the device

Returns:

An XML String listing all IP addresses configured on a given device id and data source e.g.

  <associatedAddressList>
   <addressEntry>
     <ifOperStatus>1</ifOperStatus>
     <ifIndex>10</ifIndex>
     <ipAddress>10.1.4.1</ipAddress>
   </addressEntry>
   <addressEntry>
     <ifOperStatus>1</ifOperStatus>
     <interfaceId> MyUniqueInterfaceIdFor19</interfaceId>
     <ipAddress>10.1.4.1</ipAddress>
   </addressEntry>
   .. other entries ..
 </associatedAddressList>
 

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

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>
 

main

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