com.ibm.tivoli.nm.collectors.impl.nokia5529idm

Class Nokia5529IdmCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.nokia5529idm.Nokia5529IdmCollector

public class Nokia5529IdmCollector
extends Collector

Nokia 5529 IDM Collector

Author:

Yeo Eng Seng

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
Nokia5529IdmCollector(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.
void	configureCollector(java.lang.String[] args) Configures all Collector properties using both command-line arguments and settings from the Properties file.
java.lang.String	GetDeviceInfo(int dataSourceId, java.lang.String deviceId) The Collector implementation of GetDeviceInfo() is responsible for gathering and returning basic device level information for a specified device and data source.
java.lang.String	GetEntities(int dataSourceId, int deviceId) Handler for deviceId in integer and converts deviceId in integer to string allowing collector to respond to ncp_query_collector Invokes main GetEntities method
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	GetInventory(int dataSourceId, int deviceId) Handler for deviceId in integer and converts deviceId in integer to string allowing collector to respond to ncp_query_collector Invokes main GetInventory method
java.lang.String	GetInventory(int dataSourceId, java.lang.String deviceId) Optional - The Collector implementation of GetInventory() is responsible for gathering and returning device interface information for a specified device id and data source.
void	initDataStore(int intDataSource) Initialises the Collector DataStore
static boolean	isInitGetLayer2ConnectionsLoad()
static void	main(java.lang.String[] args) Runs the collector by using the CollectorGrpcEmbeddedServer.runEmbeddedServer(Collector, int) method to run the collector on a port specified either on the command line or in a supplied properties file.
static void	setInitGetLayer2ConnectionsLoad(boolean initGetLayer2ConnectionsLoad)
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, GetDeviceList, GetEirData, GetENodeBData, GetGNodeBData, GetHssData, GetInfo, 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, initialiseDataStore, 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

Nokia5529IdmCollector

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

GetEntities

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

Description copied from class: Collector

Handler for deviceId in integer and converts deviceId in integer to string allowing collector to respond to ncp_query_collector Invokes main GetEntities method

Overrides:

GetEntities in class Collector

Returns:

Calls main GetEntities method

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>
 

GetInventory

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

Description copied from class: Collector

Handler for deviceId in integer and converts deviceId in integer to string allowing collector to respond to ncp_query_collector Invokes main GetInventory method

Overrides:

GetInventory in class Collector

Returns:

Calls main GetInventory method

GetInventory

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

Description copied from class: Collector

Optional - The Collector implementation of GetInventory() is responsible for gathering and returning device interface information for a specified device id and data source.

Overrides:

GetInventory in class Collector

Parameters:

dataSourceId - The ID for the data source

deviceId - The ID for the device

Returns:

An XML String listing interfaces for a given device, e.g.

   <deviceInventory>
    <deviceId>10.1.254.1</deviceId>
    <interfaceList>
      <interface>
        <ifPhysAddress>00:99:00:E5:C4:06</ifPhysAddress>
        <ifDescr>FastEthernet0/1.10</ifDescr>
        <ifOperStatus>1</ifOperStatus>
        <ifIndex>19</ifIndex>
        <interfaceId>MyUniqueInterfaceIdFor19</interfaceId>
        <ifType>135</ifType>
        <ipAddress></ipAddress>
        <ifName>Fa0/1.10</ifName>
      </interface>
      .. other interfaces ..
    </interfaceList>
 </deviceInventory>
 

GetDeviceInfo

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

Description copied from class: Collector

The Collector implementation of GetDeviceInfo() is responsible for gathering and returning basic device level information for a specified device and data source.

Overrides:

GetDeviceInfo in class Collector

Parameters:

dataSourceId - The ID for the data source

deviceId - The ID for the device

Returns:

An XML String describing the device e.g.

  <deviceInfo>
   <sysObjectId>1.3.6.1.4.1.0.1.94</sysObjectId>
   <descr>Vendor Device Description (sysDescr)</descr>
   <name>10.1.254.1</name>
 </deviceInfo>
 

configureCollector

public void configureCollector(java.lang.String[] args)
                        throws CollectorException

Configures all Collector properties using both command-line arguments and settings from the Properties file.

Parameters:

args - Command-line arguments

Throws:

CollectorException

initDataStore

public void initDataStore(int intDataSource)
                   throws CollectorException

Initialises the Collector DataStore

Parameters:

intDataSource - The Data Source Id

Throws:

CollectorException

main

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

Runs the collector by using the CollectorGrpcEmbeddedServer.runEmbeddedServer(Collector, int) method to run the collector on a port specified either on the command line or in a supplied properties file.

Parameters:

args - Command line arguments, e.g. -propsFile <props file name>

isInitGetLayer2ConnectionsLoad

public static boolean isInitGetLayer2ConnectionsLoad()

setInitGetLayer2ConnectionsLoad

public static void setInitGetLayer2ConnectionsLoad(boolean initGetLayer2ConnectionsLoad)