com.ibm.tivoli.nm.collectors.impl.ecilightsoft

Class EciLightsoftCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.ecilightsoft.EciLightsoftCollector

public class EciLightsoftCollector
extends Collector

This ECI LightSoft Collector supports optical data retrieval from an ECI LightSoft EMS supporting the CORBA TMF814 v2.1 implementation.

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
EciLightsoftCollector(java.lang.String collectorName, java.lang.String collectorDescription, DataTracker data, DataProcessor processor) 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	endCorbaSession() Ends the CORBA session
TMF814CorbaIterator	getAllEquipment(NameAndStringValue_T[] meName, int intResultSize, boolean blnDestroyIterator) Invokes the getAllEquipment() CORBA method
TMF814CorbaIterator	getAllManagedElements(int intResultSize, boolean blnDestroyIterator) Invokes the getAllManagedElements() CORBA method
TMF814CorbaIterator	getAllPTPs(NameAndStringValue_T[] meName, int intResultSize, boolean blnDestroyIterator) Invokes the getAllPTPs() CORBA method
TMF814CorbaIterator	getAllTopologicalLinks(NameAndStringValue_T[] snName, int intResultSize, boolean blnDestroyIterator) Invokes the getAllTopologicalLinks() CORBA method
TMF814CorbaIterator	getContainedInUseTPs(NameAndStringValue_T[] ptpName, int intResultSize, boolean blnDestroyIterator) Invokes the getContainedInUseTPs() CORBA method
TMF814CorbaIterator	getContainedPotentialTPs(NameAndStringValue_T[] ptpName, int intResultSize, boolean blnDestroyIterator) Invokes the getContainedPotentialTPs() method on the target EMS
java.util.List<java.lang.Object>	getContainingSubnetworkNames(NameAndStringValue_T[] meName) Invokes the getContainingSubnetworkNames() CORBA method
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.
java.util.List<org.omg.CORBA.portable.IDLEntity>	getManagedElement(NameAndStringValue_T[] meName) Invokes the getManagedElement() CORBA method
boolean	haveCorbaSession() Checks if the CORBA session is active
static void	main(java.lang.String[] args) Entry point for this class
void	reconnect() Reconnects the CORBA session
void	startCorbaSession() Starts the CORBA session
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, 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

EciLightsoftCollector

public EciLightsoftCollector(java.lang.String collectorName,
                             java.lang.String collectorDescription,
                             DataTracker data,
                             DataProcessor processor)

Constructor

Parameters:

collectorName - Collector name

collectorDescription - Collector description

data - DataTracker instance

processor - DataProcessor instance

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>
 

startCorbaSession

public void startCorbaSession()
                       throws CorbaCollectorException

Starts the CORBA session

Throws:

CorbaCollectorException

endCorbaSession

public void endCorbaSession()

Ends the CORBA session

haveCorbaSession

public boolean haveCorbaSession()

Checks if the CORBA session is active

Returns:

true if the CORBA session is active, otherwise false

reconnect

public void reconnect()
               throws CorbaCollectorException

Reconnects the CORBA session

Throws:

CorbaCollectorException

getAllManagedElements

public TMF814CorbaIterator getAllManagedElements(int intResultSize,
                                                 boolean blnDestroyIterator)
                                          throws CorbaCollectorException

Invokes the getAllManagedElements() CORBA method

Parameters:

intResultSize - The number of results to be returned by the iterator for each iteration set

blnDestroyIterator - Flag to destroy the iterator object

Returns:

TMF814CorbaIterator instance

Throws:

CorbaCollectorException

getManagedElement

public java.util.List<org.omg.CORBA.portable.IDLEntity> getManagedElement(NameAndStringValue_T[] meName)
                                                                   throws CorbaCollectorException

Invokes the getManagedElement() CORBA method

Parameters:

meName - Managed Element as NameAndStringValue_T[]

Returns:

List containing a single ManagedElement_T object

Throws:

CorbaCollectorException

getAllEquipment

public TMF814CorbaIterator getAllEquipment(NameAndStringValue_T[] meName,
                                           int intResultSize,
                                           boolean blnDestroyIterator)
                                    throws CorbaCollectorException

Invokes the getAllEquipment() CORBA method

Parameters:

meName - Managed Element as NameAndStringValue_T[]

intResultSize - Flag to toggle whether the iterator object on the EMS side should be destroyed after all results have been processed by the CORBA Iterator.

blnDestroyIterator - Flag to toggle whether the iterator object on the EMS side should be destroyed after all results have been processed by the CORBA Iterator.

Returns:

TMF814CorbaIterator instance

Throws:

CorbaCollectorException

getAllPTPs

public TMF814CorbaIterator getAllPTPs(NameAndStringValue_T[] meName,
                                      int intResultSize,
                                      boolean blnDestroyIterator)
                               throws CorbaCollectorException

Invokes the getAllPTPs() CORBA method

Parameters:

meName - Managed Element as NameAndStringValue_T[]

intResultSize - Flag to toggle whether the iterator object on the EMS side should be destroyed after all results have been processed by the CORBA Iterator.

blnDestroyIterator - Flag to toggle whether the iterator object on the EMS side should be destroyed after all results have been processed by the CORBA Iterator.

Returns:

TMF814CorbaIterator instance

Throws:

CorbaCollectorException

getContainedPotentialTPs

public TMF814CorbaIterator getContainedPotentialTPs(NameAndStringValue_T[] ptpName,
                                                    int intResultSize,
                                                    boolean blnDestroyIterator)
                                             throws CorbaCollectorException

Invokes the getContainedPotentialTPs() method on the target EMS

Parameters:

ptpName - Physical Termination Point name as NameAndStringValue_T[]

intResultSize - The number of results to be returned by the iterator for each iteration set

blnDestroyIterator - Flag to toggle whether the iterator object on the EMS side should be destroyed after all results have been processed by the CORBA Iterator.

Returns:

TMF814CorbaIterator instance

Throws:

CorbaCollectorException

getContainedInUseTPs

public TMF814CorbaIterator getContainedInUseTPs(NameAndStringValue_T[] ptpName,
                                                int intResultSize,
                                                boolean blnDestroyIterator)
                                         throws CorbaCollectorException

Invokes the getContainedInUseTPs() CORBA method

Parameters:

ptpName - Physical Termination Point name as NameAndStringValue_T[]

intResultSize - Flag to toggle whether the iterator object on the EMS side should be destroyed after all results have been processed by the CORBA Iterator.

blnDestroyIterator - Flag to toggle whether the iterator object on the EMS side should be destroyed after all results have been processed by the CORBA Iterator.

Returns:

TMF814CorbaIterator instance

Throws:

CorbaCollectorException

getContainingSubnetworkNames

public java.util.List<java.lang.Object> getContainingSubnetworkNames(NameAndStringValue_T[] meName)
                                                              throws CorbaCollectorException

Invokes the getContainingSubnetworkNames() CORBA method

Parameters:

meName - Managed Element as NameAndStringValue_T[]

Returns:

List containing the subnetwork names

Throws:

CorbaCollectorException

getAllTopologicalLinks

public TMF814CorbaIterator getAllTopologicalLinks(NameAndStringValue_T[] snName,
                                                  int intResultSize,
                                                  boolean blnDestroyIterator)
                                           throws CorbaCollectorException

Invokes the getAllTopologicalLinks() CORBA method

Parameters:

snName - Subnetwork as NameAndStringValue_T[]

intResultSize - The number of results to be returned by the iterator for each iteration set

blnDestroyIterator - Flag to toggle whether the iterator object on the EMS side should be destroyed after all results have been processed by the CORBA Iterator.

Returns:

TMF814CorbaIterator instance

Throws:

CorbaCollectorException

main

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

Entry point for this class

Parameters:

args - The following are acceptable arguments for this Collector:

• -port (Port to run this Collector XML-RPC server)
• -propsFile (Path to this Collector's properties file)

If no arguments are specified, the default values will be used.