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

Class TellabsINM8000DataProvider

java.lang.Object

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

public class TellabsINM8000DataProvider
extends java.lang.Object

This class handles the interaction between TellabsINM8000 collector and TellabsINM8000 EMS and provide methods to retrieve and process records

Author:

Lim Keat Sin, Sheikh Naziruddin

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	REGIONID
protected boolean	REGIONIDENABLE
protected boolean	USEALIASNAME
protected boolean	USEFILTERNODEDISCOVERY
protected boolean	USEINTERFACEIFMSG

Constructor Summary

Constructors

Constructor and Description
TellabsINM8000DataProvider() Constructor of the class

Method Summary

Modifier and Type	Method and Description
static java.lang.String	bytesToHex(byte[] in)
protected void	closeSession() Disconnect the current connection to TellabsINM8000 EMS
java.lang.String	convertIpAddressv4(byte[] rawBytes) Utility method to convert raw IPv4 address to String format
java.net.InetAddress	convertIpAddressv6(byte[] rawBytes) Utility method to convert raw IPv6 address to String format
protected java.lang.String	convertIpv4ToRawBytesString(java.lang.String ipaddr) Returns a converted IPv4 address in bytes format
void	displayAllAttributeDataType()
void	displayNbifAttr(int attribute, int data)
void	displayNbifAttr(int attribute, java.lang.String data)
protected TolResultSet	getAllData(int entityId, java.util.ArrayList<java.lang.Integer> attr) Helper method to returns all records of an TellabsINM8000 EMS entity with a set of attributes.
protected java.util.ArrayList<PhysicalInventory>	getAllPhysicalInventory(TellabsINM8000InventoryType type, int entityId, java.util.ArrayList<java.lang.Integer> entityAtrr, java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilterSubRack, java.lang.String METHOD_NAME) Helper method to return all records of a physical inventory e.g.
void	getAttrDataTypeDesc(int attribute)
protected int	getBATCHINTERFACESIZE()
protected int	getBATCHMODULESIZE()
protected int	getBATCHSUBRACKSIZE()
protected int	getBATCHUNITSIZE()
protected boolean	getConnection() Establishes connection to TellabsINM8000 EMS
protected TolResultSet	getFilteredData(int entityId, java.util.ArrayList<java.lang.Integer> attr, java.lang.String filterStr) Helper method to returns a set of records based on filter
protected int	getIfOperStatusInstalled()
protected int	getIfOperStatusInUse()
protected int	getIfOperStatusPlanned()
protected int	getIfOperStatusUndefined()
protected java.util.ArrayList<PhysicalInventory>	getInterfaces(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilter, java.util.ArrayList<PhysicalInventory> nodes) Retrieve a list of Interface
protected java.util.ArrayList<PhysicalInventory>	getModules(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilter, java.util.ArrayList<PhysicalInventory> nodes) Retrieve a list of Module
protected java.util.ArrayList<PhysicalInventory>	getNodes(int[] regionId) Retrieves a list of Node objects by region id
protected java.util.ArrayList<PhysicalInventory>	getOneNode(int nodeID) Return a single Node object
protected java.util.ArrayList<PhysicalInventory>	getPhysicalInventoryByRegionId(TellabsINM8000InventoryType type, int entityId, java.util.ArrayList<java.lang.Integer> entityAtrr, java.util.ArrayList<PhysicalInventory> objPhysInventoryList, java.lang.String METHOD_NAME) Helper method to return records of a physical inventory e.g.
protected java.util.Properties	getPropfile()
static java.lang.String	getStackTraceMessage(java.lang.Exception ex) Returns stacktrace exception messages
protected java.util.ArrayList<PhysicalInventory>	getSubRacks(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilter, java.util.ArrayList<PhysicalInventory> nodes) Retrieve a list of Subracks
protected java.lang.String	getTopologyType(int typeNum)
protected Trunk	getTrunk(long intTrunkId) Returns a list of populated Trunk objects
protected java.util.ArrayList<PhysicalInventory>	getTrunks(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilter, java.util.ArrayList<PhysicalInventory> nodes) Retrieve a list of Trunk
protected java.util.ArrayList<PhysicalInventory>	getUnits(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilter, java.util.ArrayList<PhysicalInventory> nodes) Retrieve a list of Unit
java.lang.Boolean	getUseNameAlias() Return the useNameAlias flag status of the setUseNameAlias from property file
void	initialise() Creates a new connection session, loads and initialises properties values from properties file
protected boolean	isCollectData() Returns the collectData flag status of the collector
protected boolean	isGetEntities()
protected boolean	isGetLayer1Connections()
protected boolean	isGetLayer2Connections()
protected boolean	isGetLayer3Connections()
protected java.util.ArrayList<PhysicalInventory>	populateInterfaces(TolResultSet tolResultSet) Returns a list of populated Interface objects
protected java.util.ArrayList<PhysicalInventory>	populateModules(TolResultSet tolResultSet) Returns a list of populated Module objects
protected java.util.ArrayList<PhysicalInventory>	populateNodes(TolResultSet tolResultSet) Returns a list of populated Node objects
protected java.util.ArrayList<PhysicalInventory>	populateSubRacks(TolResultSet tolResultSet) Returns a list of populated Subrack objects
protected Trunk	populateTrunk(TolResultSet tolResultSet) Returns a list of populated Trunk objects
protected java.util.ArrayList<PhysicalInventory>	populateTrunks(TolResultSet tolResultSet) Returns a list of populated Trunk objects
protected java.util.ArrayList<PhysicalInventory>	populateUnits(TolResultSet tolResultSet) Returns a list of populated Unit objects
java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>>	setBoundaryFilter(java.util.List<PhysicalInventory> nodeList, int batchSize) Sets "boundaries" of records to retrieve based on batch sizes in properties file.
protected void	setGetEntities(java.lang.String getEntitiesFlag)
protected void	setGetLayer1Connections(java.lang.String getLayer1Connections)
protected void	setGetLayer2Connections(java.lang.String getLayer2Connections)
protected void	setGetLayer3Connections(java.lang.String getLayer3Connections)
void	setUseNameAlias(java.lang.Boolean useNameAlias) Set the useNameAlias flag status of the setUseNameAlias from property file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REGIONID

protected int[] REGIONID

REGIONIDENABLE

protected boolean REGIONIDENABLE

USEALIASNAME

protected boolean USEALIASNAME

USEINTERFACEIFMSG

protected boolean USEINTERFACEIFMSG

USEFILTERNODEDISCOVERY

protected boolean USEFILTERNODEDISCOVERY

Constructor Detail

TellabsINM8000DataProvider

public TellabsINM8000DataProvider()

Constructor of the class

Method Detail

initialise

public void initialise()

Creates a new connection session, loads and initialises properties values from properties file

getConnection

protected boolean getConnection()

Establishes connection to TellabsINM8000 EMS

closeSession

protected void closeSession()

Disconnect the current connection to TellabsINM8000 EMS

getAllData

protected TolResultSet getAllData(int entityId,
                                  java.util.ArrayList<java.lang.Integer> attr)
                           throws TolAttributeException,
                                  java.io.IOException,
                                  TolCommunicationException

Helper method to returns all records of an TellabsINM8000 EMS entity with a set of attributes. Attributes is analogous to a column in RDBMS

Parameters:

entityId - The Id number of the type of entity type e.g. Node, Subrack, Unit, Interface, etc.

attr - The attibutes(columns) of the record

Returns:

Resultset containing all records of the entity

Throws:

TolAttributeException - , IOException, TolCommunicationException

java.io.IOException

TolCommunicationException

getFilteredData

protected TolResultSet getFilteredData(int entityId,
                                       java.util.ArrayList<java.lang.Integer> attr,
                                       java.lang.String filterStr)
                                throws TolAttributeException,
                                       java.io.IOException,
                                       TolCommunicationException

Helper method to returns a set of records based on filter

Parameters:

entityId - The Id number of the type of entity type e.g. Node, Subrack, Unit, Interface, etc.

attr - The attibutes(columns) of the record

filterStr - Filter to retrieve records based on specific criteria. Analogous to "WHERE" statement in SQL query

Returns:

Resultset containing all records of the entity

Throws:

TolAttributeException - , IOException, TolCommunicationException

java.io.IOException

TolCommunicationException

getAllPhysicalInventory

protected java.util.ArrayList<PhysicalInventory> getAllPhysicalInventory(TellabsINM8000InventoryType type,
                                                                         int entityId,
                                                                         java.util.ArrayList<java.lang.Integer> entityAtrr,
                                                                         java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilterSubRack,
                                                                         java.lang.String METHOD_NAME)

Helper method to return all records of a physical inventory e.g. Node,Unit,Subrack, etc. , controlled by a batch size when retrieving all data. The batch size defined in the propeties file is used to create "boundaries" of lower end and upper end record (e.g. nodeId>=1234, nodeId<=2000) which is stored in a HashMap. Records are retrieved by batches using the boundaries one at a time until all "boundaries" are looped through

Parameters:

entityId - The Id number of the type of entity type e.g. Node, Subrack, Unit, Interface, etc.

entityAtrr - The attibutes(columns) of the record

boundaryFilterSubRack - HashMap containing "boundaries" to retrieve a batch of record

METHOD_NAME - Name of the method that invokes this helper method

getPhysicalInventoryByRegionId

protected java.util.ArrayList<PhysicalInventory> getPhysicalInventoryByRegionId(TellabsINM8000InventoryType type,
                                                                                int entityId,
                                                                                java.util.ArrayList<java.lang.Integer> entityAtrr,
                                                                                java.util.ArrayList<PhysicalInventory> objPhysInventoryList,
                                                                                java.lang.String METHOD_NAME)

Helper method to return records of a physical inventory e.g. Node,Unit,Subrack, etc. by Region id

Parameters:

type - Entity type

entityId - The Id number of the type of entity type e.g. Node, Subrack, Unit, Interface, etc.

entityAtrr - The attibutes(columns) of the record

objPhysInventoryList - List of Node objects

METHOD_NAME - Name of the method that invokes this helper method

Returns:

A list of entity as specified by entityId

getNodes

protected java.util.ArrayList<PhysicalInventory> getNodes(int[] regionId)
                                                   throws java.io.IOException

Retrieves a list of Node objects by region id

Parameters:

regionId - Region id number(s)

Returns:

A list of nodes by region Ids

Throws:

java.io.IOException

populateNodes

protected java.util.ArrayList<PhysicalInventory> populateNodes(TolResultSet tolResultSet)
                                                        throws TolAttributeException,
                                                               java.io.IOException

Returns a list of populated Node objects

Parameters:

tolResultSet - Resultset of entity records

Returns:

A list of populated Node objects

Throws:

TolAttributeException - , IOException

java.io.IOException

getSubRacks

protected java.util.ArrayList<PhysicalInventory> getSubRacks(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilter,
                                                             java.util.ArrayList<PhysicalInventory> nodes)

Retrieve a list of Subracks

Parameters:

boundaryFilter - "Boundaries" for retrieving records in batches

nodes - A list of Node object

populateSubRacks

protected java.util.ArrayList<PhysicalInventory> populateSubRacks(TolResultSet tolResultSet)
                                                           throws TolAttributeException,
                                                                  java.io.IOException

Returns a list of populated Subrack objects

Parameters:

tolResultSet - Resultset of entity records

Returns:

A list of populated Subrack objects

Throws:

TolAttributeException - , IOException

java.io.IOException

getUnits

protected java.util.ArrayList<PhysicalInventory> getUnits(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilter,
                                                          java.util.ArrayList<PhysicalInventory> nodes)

Retrieve a list of Unit

Parameters:

boundaryFilter - "Boundaries" for retrieving records in batches

nodes - A list of Unit object

populateUnits

protected java.util.ArrayList<PhysicalInventory> populateUnits(TolResultSet tolResultSet)
                                                        throws TolAttributeException,
                                                               java.io.IOException

Returns a list of populated Unit objects

Parameters:

tolResultSet - Resultset of entity records

Returns:

A list of populated Unit objects

Throws:

TolAttributeException - , IOException

java.io.IOException

getModules

protected java.util.ArrayList<PhysicalInventory> getModules(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilter,
                                                            java.util.ArrayList<PhysicalInventory> nodes)

Retrieve a list of Module

Parameters:

boundaryFilter - "Boundaries" for retrieving records in batches

nodes - A list of Module object

populateModules

protected java.util.ArrayList<PhysicalInventory> populateModules(TolResultSet tolResultSet)
                                                          throws TolAttributeException,
                                                                 java.io.IOException

Returns a list of populated Module objects

Parameters:

tolResultSet - Resultset of entity records

Returns:

A list of populated Module objects

Throws:

TolAttributeException - , IOException

java.io.IOException

getInterfaces

protected java.util.ArrayList<PhysicalInventory> getInterfaces(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilter,
                                                               java.util.ArrayList<PhysicalInventory> nodes)

Retrieve a list of Interface

Parameters:

boundaryFilter - "Boundaries" for retrieving records in batches

nodes - A list of Interface object

populateInterfaces

protected java.util.ArrayList<PhysicalInventory> populateInterfaces(TolResultSet tolResultSet)
                                                             throws TolAttributeException,
                                                                    java.io.IOException

Returns a list of populated Interface objects

Parameters:

tolResultSet - Resultset of entity records

Returns:

A list of populated Interface objects

Throws:

TolAttributeException - , IOException

java.io.IOException

getTrunks

protected java.util.ArrayList<PhysicalInventory> getTrunks(java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> boundaryFilter,
                                                           java.util.ArrayList<PhysicalInventory> nodes)
                                                    throws java.io.IOException

Retrieve a list of Trunk

Parameters:

boundaryFilter - "Boundaries" for retrieving records in batches

nodes - A list of Trunk object

Throws:

java.io.IOException

populateTrunks

protected java.util.ArrayList<PhysicalInventory> populateTrunks(TolResultSet tolResultSet)
                                                         throws TolAttributeException,
                                                                java.io.IOException

Returns a list of populated Trunk objects

Parameters:

tolResultSet - Resultset of entity records

Returns:

A list of populated Trunk objects

Throws:

TolAttributeException - , IOException

java.io.IOException

getTrunk

protected Trunk getTrunk(long intTrunkId)
                  throws java.io.IOException

Returns a list of populated Trunk objects

Parameters:

tolResultSet - Resultset of entity records

Returns:

A list of populated Trunk objects

Throws:

TolAttributeException - , IOException

java.io.IOException

populateTrunk

protected Trunk populateTrunk(TolResultSet tolResultSet)
                       throws TolAttributeException,
                              java.io.IOException

Returns a list of populated Trunk objects

Parameters:

tolResultSet - Resultset of entity records

Returns:

A list of populated Trunk objects

Throws:

TolAttributeException - , IOException

java.io.IOException

getOneNode

protected java.util.ArrayList<PhysicalInventory> getOneNode(int nodeID)
                                                     throws java.io.IOException

Return a single Node object

Parameters:

Node - Id of the node

Returns:

A list containing the single Node object

Throws:

java.io.IOException

setBoundaryFilter

public java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Integer>> setBoundaryFilter(java.util.List<PhysicalInventory> nodeList,
                                                                                                                    int batchSize)

Sets "boundaries" of records to retrieve based on batch sizes in properties file. Each "boundary" consists of "lower end" and "upper end". These boundaries are node ids which are to be used in filter string to retrieve batches of records (e.g. nid>=1234;nid<=2000)

Parameters:

nodeList - List of node objects

batchSize - Batch size of records to be retrieved at one time

Returns:

A HashMap of boundaries with Node Id as the key and values as "boundaries"

getPropfile

protected java.util.Properties getPropfile()

convertIpv4ToRawBytesString

protected java.lang.String convertIpv4ToRawBytesString(java.lang.String ipaddr)

Returns a converted IPv4 address in bytes format

Parameters:

String - String of IPv4 address

Returns:

A String of IPv4 address in bytes format

convertIpAddressv4

public java.lang.String convertIpAddressv4(byte[] rawBytes)

Utility method to convert raw IPv4 address to String format

Parameters:

rawBytes - IPv4 address in bytes

Returns:

IPv4 address in plain text

convertIpAddressv6

public java.net.InetAddress convertIpAddressv6(byte[] rawBytes)
                                        throws java.io.IOException

Utility method to convert raw IPv6 address to String format

Parameters:

rawBytes - IPv6 address in bytes

Returns:

IPv6 address in plain text

Throws:

java.io.IOException

isGetLayer1Connections

protected boolean isGetLayer1Connections()

Returns:

the getLayer1Connections

setGetLayer1Connections

protected void setGetLayer1Connections(java.lang.String getLayer1Connections)

Parameters:

getLayer1Connections - the getLayer1Connections to set

isGetLayer2Connections

protected boolean isGetLayer2Connections()

Returns:

the getLayer2Connections

setGetLayer2Connections

protected void setGetLayer2Connections(java.lang.String getLayer2Connections)

Parameters:

getLayer2Connections - the getLayer2Connections to set

isGetLayer3Connections

protected boolean isGetLayer3Connections()

Returns:

the getLayer3Connections

setGetLayer3Connections

protected void setGetLayer3Connections(java.lang.String getLayer3Connections)

Parameters:

getLayer3Connections - the getLayer3Connections to set

getTopologyType

protected java.lang.String getTopologyType(int typeNum)

getBATCHSUBRACKSIZE

protected int getBATCHSUBRACKSIZE()

Returns:

the bATCHSUBRACKSIZE

getBATCHUNITSIZE

protected int getBATCHUNITSIZE()

Returns:

the bATCHUNITSIZE

getBATCHMODULESIZE

protected int getBATCHMODULESIZE()

Returns:

the bATCHMODULESIZE

getBATCHINTERFACESIZE

protected int getBATCHINTERFACESIZE()

Returns:

the bATCHINTERFACESIZE

isGetEntities

protected boolean isGetEntities()

Returns:

the getEntities

setGetEntities

protected void setGetEntities(java.lang.String getEntitiesFlag)

Parameters:

getEntities - the getEntities to set

getIfOperStatusInUse

protected int getIfOperStatusInUse()

Returns:

the ifOperStatusInUse

getIfOperStatusPlanned

protected int getIfOperStatusPlanned()

Returns:

the ifOperStatusPlanned

getIfOperStatusInstalled

protected int getIfOperStatusInstalled()

Returns:

the ifOperStatusInstalled

getIfOperStatusUndefined

protected int getIfOperStatusUndefined()

Returns:

the ifOperStatusUndefined

isCollectData

protected boolean isCollectData()

Returns the collectData flag status of the collector

Returns:

TRUE if collectData in collector properties file is set to "true", FALSE otherwise

setUseNameAlias

public void setUseNameAlias(java.lang.Boolean useNameAlias)

Set the useNameAlias flag status of the setUseNameAlias from property file

getUseNameAlias

public java.lang.Boolean getUseNameAlias()

Return the useNameAlias flag status of the setUseNameAlias from property file

Returns:

TRUE if setUseNameAlias in collector properties file is set to "true", FALSE otherwise

getAttrDataTypeDesc

public void getAttrDataTypeDesc(int attribute)
                         throws TolAttributeException,
                                java.io.IOException,
                                TolCommunicationException

Throws:

TolAttributeException

java.io.IOException

TolCommunicationException

displayNbifAttr

public void displayNbifAttr(int attribute,
                            int data)
                     throws TolAttributeException,
                            java.io.IOException,
                            TolCommunicationException

Throws:

TolAttributeException

java.io.IOException

TolCommunicationException

displayNbifAttr

public void displayNbifAttr(int attribute,
                            java.lang.String data)
                     throws TolAttributeException,
                            java.io.IOException,
                            TolCommunicationException

Throws:

TolAttributeException

java.io.IOException

TolCommunicationException

displayAllAttributeDataType

public void displayAllAttributeDataType()
                                 throws TolAttributeException,
                                        java.io.IOException,
                                        TolCommunicationException

Throws:

TolAttributeException

java.io.IOException

TolCommunicationException

bytesToHex

public static java.lang.String bytesToHex(byte[] in)

getStackTraceMessage

public static java.lang.String getStackTraceMessage(java.lang.Exception ex)

Returns stacktrace exception messages

Parameters:

ex - The exception that is thrown

Returns:

The stacktrace message