com.ibm.tivoli.nm.collectors.impl.alcatelnr8

Class AlcatelNR8PLIooIsnCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.alcatelnr8.AlcatelNR8PLIooIsnCollector

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

Method Summary

Modifier and Type	Method and Description
boolean	CheckEntityExists(java.lang.String userLabel, java.lang.String tomid, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> entityList) Checks if an entity exists in the provided entity list based on userLabel and tomid.
protected void	collectData(int arg0, 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	GenerateTomId(java.lang.String userLabel) Generates tom-id based on the format of userLabels passed on as parameter.
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	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(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetInventory(int dataSourceId, java.lang.String deviceId) Get LTE Inventory for a given data source and device ID
java.lang.String	GetLayer1Connections(int dataSourceId, java.lang.String deviceId) Optional - The Collector implementation of GetLayer1Connections() is responsible for gathering and returning all resolved layer 1 link information for the supplied device id and data source.
protected void	initialiseDataStore() Initialise the data store.
java.util.Map<java.lang.String,java.lang.Object>	ISNCall(java.lang.String abstractRequest) Constructs and performs an Alcatel ISN call for ISN report request.
void	loadEmsDeviceList(DataStore store, int dataSourceId) Updates the store to hold sufficient data to respond to the GetDeviceList and GetDeviceInfo Precision Collector Interface calls.
void	loadLayer1ConnectionData(DataStore store, int dataSourceId) Retrieve Layer 1 connection data from the EMS and add it to the supplied store.
int	logout() Logging out from ALU EMS 1353NM.
static void	main(java.lang.String[] args)
void	parseDeviceList(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> responses, DataStore store, int dataSourceId) Parses the loaded data into the supplied Collector.Store object.
void	ParsePhysicalEntityList(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> response, DataStore dataStore, int dataSourceId) Parses the loaded data into the supplied Collector.Store object.
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, GetInfo, GetInventory, 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

AlcatelNR8PLIooIsnCollector

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

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

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>
 

GetInfo

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

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>
 

GetLayer1Connections

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

Description copied from class: Collector

Optional - The Collector implementation of GetLayer1Connections() is responsible for gathering and returning all resolved layer 1 link information for the supplied device id and data source.

ITNM will process this data, via its CollectorIPLayer.stch stitcher, resulting in layer 1 connectivity information in the GUI.

Overrides:

GetLayer1Connections in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String describing all layer 1 connections for the device e.g.

  <layer1Connections>
   <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>
 </layer1Connections>
 

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

collectData

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

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

ISNCall

public java.util.Map<java.lang.String,java.lang.Object> ISNCall(java.lang.String abstractRequest)

Constructs and performs an Alcatel ISN call for ISN report request.

Parameters:

reportFilter - ISN Report Filter, i.e., which values we want

abstractRequest - Abstract request, i.e., the class to query

Returns:

Response from the ISN report contents

loadLayer1ConnectionData

public void loadLayer1ConnectionData(DataStore store,
                                     int dataSourceId)

Retrieve Layer 1 connection data from the EMS and add it to the supplied store. ISN Report 4, physicalConn has only 1 filter, which is {connecTechnology=sdh}. May not use the filter now.

Parameters:

store - Pointer to a Collector.Store object. Updated with loaded data

sourceId - Data source ID under which to store the data in store

targetDevices - Restricts data to the specified device IDs

GenerateTomId

public java.lang.String GenerateTomId(java.lang.String userLabel)

Generates tom-id based on the format of userLabels passed on as parameter.

Parameters:

userLabel - The user label, direct from source

Returns:

tomid The ID of the entity based on the telecom-object-model ID

CheckEntityExists

public boolean CheckEntityExists(java.lang.String userLabel,
                                 java.lang.String tomid,
                                 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> entityList)

Checks if an entity exists in the provided entity list based on userLabel and tomid.

Parameters:

userLabel - The user label to check

tomid - The tomid to check

entityList - The list of entities to search

Returns:

0 if found, otherwise 1

ParsePhysicalEntityList

public void ParsePhysicalEntityList(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> response,
                                    DataStore dataStore,
                                    int dataSourceId)

Parses the loaded data into the supplied Collector.Store object.

Parameters:

response - IOO response holding the loaded data

store - Pointer to a Collector.Store object. Updated with loaded data

sourceId - Data source ID under which to store the data in store

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>
 

loadEmsDeviceList

public void loadEmsDeviceList(DataStore store,
                              int dataSourceId)

Updates the store to hold sufficient data to respond to the GetDeviceList and GetDeviceInfo Precision Collector Interface calls.

Parameters:

store - Pointer to a Collector.Store object. Updated with loaded data

sourceId - Data source ID under which to store the data in store

deviceId - (optional) restricts data to the specified device ID

parseDeviceList

public void parseDeviceList(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> responses,
                            DataStore store,
                            int dataSourceId)

Parses the loaded data into the supplied Collector.Store object.

Parameters:

responses - IOOAgentReqRes reference holding the loaded data

store - Pointer to a Collector.Store object. Updated with loaded data

sourceId - Data source ID under which to store the data in store

logout

public int logout()

Logging out from ALU EMS 1353NM.

Returns:

1 if logged out successfully, else 0

main

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