com.ibm.tivoli.nm.collectors.impl.tellabsinm8000

Class TellabsINM8000Collector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.tellabsinm8000.TellabsINM8000Collector

public class TellabsINM8000Collector
extends Collector

This collector supports optical data retrieval of Tellabs INM8000 EMS through Tellabs INM8000 Java API

Author:

Lim Keat Sin

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<PhysicalInventory>	nodeList

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
TellabsINM8000Collector(java.lang.String collectorName, java.lang.String collectorDescription) Create a new Tellabs collector

Method Summary

Modifier and Type	Method and Description
protected void	addInterfacesEntityData(java.util.ArrayList<PhysicalInventory> iFaceList, java.util.ArrayList<PhysicalInventory> trunkList, java.util.ArrayList<PhysicalInventory> nodeList) This method add a list of Interface object's entity data to the collector's DataStore for device containment
protected void	addInterfacesId(java.util.ArrayList<PhysicalInventory> iFaceList, java.util.ArrayList<PhysicalInventory> trunkList) This method add a list of Interface object's interface data to the collector's DataStore for connectivity information.
protected void	addModules(java.util.ArrayList<PhysicalInventory> moduleList, java.util.ArrayList<PhysicalInventory> nodeList, java.util.ArrayList<PhysicalInventory> unitList) This method add a list of Module object to the collector's DataStore
protected void	addTrunks(java.util.ArrayList<PhysicalInventory> trunkList, java.lang.String address, java.util.ArrayList<PhysicalInventory> nodeList) This method add a list of Trunk object to the collector's DataStore for connectivity information.
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.
protected void	doFullDiscovery(int nodeId) Performs a Full Discovery operation
protected void	doPartialDiscovery(int dataSource, java.lang.String address) This method performs Partial Discovery by invoking doFullDiscovery(int) method and supplying a node id as parameter.
protected java.lang.String	getNodeName(int nodeId)
protected static java.util.Properties	getPropsFile() Returns the Properties object for this collector
protected void	initDataStore() Initialises data source as specified in the properties file
static void	main(java.lang.String[] args) Run the Tellabs collector
java.util.List<NetworkDevice>	parseNetworkDeviceData(java.util.ArrayList<PhysicalInventory> nodeList) This method takes a list of node objects and parses the raw data in node objects and creates a list of network devices objects based on data in the node object
protected void	populateNodeNameMap(java.util.ArrayList<PhysicalInventory> list)
static void	setDATA_SOURCE_ID(int dATA_SOURCE_ID)
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, 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, 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

Field Detail

nodeList

protected java.util.ArrayList<PhysicalInventory> nodeList

Constructor Detail

TellabsINM8000Collector

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

Create a new Tellabs collector

Parameters:

collectorName - The name of the collector

collectorDescription - A description of the collector

Method Detail

main

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

Run the Tellabs collector

Parameters:

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

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)

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 IP of the device to refresh, or else it holds the subnet to refresh

mask - Holds the subnet mask, or is not defined

Returns:

A message to acknowledge that the update has been completed e.g. <updateResponse></updateResponse>

initDataStore

protected void initDataStore()

Initialises data source as specified in the properties file

parseNetworkDeviceData

public java.util.List<NetworkDevice> parseNetworkDeviceData(java.util.ArrayList<PhysicalInventory> nodeList)

This method takes a list of node objects and parses the raw data in node objects and creates a list of network devices objects based on data in the node object

Parameters:

nodeList - An List of node objects

Returns:

A list of network devices in the node Ids from the node objects

addModules

protected void addModules(java.util.ArrayList<PhysicalInventory> moduleList,
                          java.util.ArrayList<PhysicalInventory> nodeList,
                          java.util.ArrayList<PhysicalInventory> unitList)

This method add a list of Module object to the collector's DataStore

Parameters:

moduleList - A list of initialised Module objects

addInterfacesEntityData

protected void addInterfacesEntityData(java.util.ArrayList<PhysicalInventory> iFaceList,
                                       java.util.ArrayList<PhysicalInventory> trunkList,
                                       java.util.ArrayList<PhysicalInventory> nodeList)

This method add a list of Interface object's entity data to the collector's DataStore for device containment

Parameters:

iFaceList - A list of initialised Interface objects

addInterfacesId

protected void addInterfacesId(java.util.ArrayList<PhysicalInventory> iFaceList,
                               java.util.ArrayList<PhysicalInventory> trunkList)

This method add a list of Interface object's interface data to the collector's DataStore for connectivity information.

Parameters:

iFaceList - A list of initialised Interface objects

addTrunks

protected void addTrunks(java.util.ArrayList<PhysicalInventory> trunkList,
                         java.lang.String address,
                         java.util.ArrayList<PhysicalInventory> nodeList)
                  throws java.io.IOException,
                         TolAttributeException,
                         TolCommunicationException

This method add a list of Trunk object to the collector's DataStore for connectivity information.

Parameters:

trunkList - A list of initialised Trunk objects

Throws:

java.io.IOException - , TolAttributeException, TolCommunicationException

TolAttributeException

TolCommunicationException

populateNodeNameMap

protected void populateNodeNameMap(java.util.ArrayList<PhysicalInventory> list)

getNodeName

protected java.lang.String getNodeName(int nodeId)

doFullDiscovery

protected void doFullDiscovery(int nodeId)
                        throws java.io.IOException,
                               TolAttributeException,
                               TolCommunicationException

Performs a Full Discovery operation

Parameters:

nodeId - Node Id for Partial Discovery operation. When a non-zero value is supplied, Partial Discovery is performed, else Full Discovery is performed instead

Throws:

java.io.IOException - ,TolAttributeException,TolCommunicationException

TolAttributeException

TolCommunicationException

doPartialDiscovery

protected void doPartialDiscovery(int dataSource,
                                  java.lang.String address)
                           throws java.io.IOException,
                                  TolAttributeException,
                                  TolCommunicationException

This method performs Partial Discovery by invoking doFullDiscovery(int) method and supplying a node id as parameter.

Parameters:

dataSource - The DataSource Id that is specified in the properties file

address - IP address of the target device of the partial discovery

Throws:

java.io.IOException - , TolAttributeException, TolCommunicationException

TolAttributeException

TolCommunicationException

getPropsFile

protected static java.util.Properties getPropsFile()

Returns the Properties object for this collector

Returns:

The Properties object of this collector

setDATA_SOURCE_ID

public static void setDATA_SOURCE_ID(int dATA_SOURCE_ID)