com.ibm.tivoli.nm.collectors.impl.opticalblackbox

Class OpticalBlackBoxXmlCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.opticalblackbox.OpticalBlackBoxXmlCollector

public class OpticalBlackBoxXmlCollector
extends Collector

Field Summary

Fields inherited from class com.ibm.tivoli.nm.collectors.framework.collector.Collector

collectData, collectorDescription, collectorName, collectorPort, dataStore, running

Constructor Summary

Constructors

Constructor and Description
OpticalBlackBoxXmlCollector(java.lang.String collectorName, java.lang.String collectorDescription)

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)
static java.util.Map<java.lang.String,java.lang.Object>	createCollector(java.lang.String[] args)
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) The Collector implementation of GetDeviceInfo() is responsible for gathering and returning basic device level information for a specified device and data source.
static java.lang.Object	GetDeviceList(int dataSourceId, java.lang.String requestType, java.lang.String address, java.lang.String subnet)
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, 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.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.
static java.util.Map<java.lang.String,java.lang.Object>	loadConfigFile(java.lang.String configFile)
static java.util.Map<java.lang.String,java.lang.Object>	loadConfigurationOptions(java.lang.String[] args)
void	loadData(int source)
void	loadFirstRun()
static void	main(java.lang.String[] args)
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

OpticalBlackBoxXmlCollector

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

Method Detail

main

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

initialiseDataStore

protected void initialiseDataStore()

Description copied from class: Collector

Initialise the data store. Uses an in memory data store @see DataStore . Should be overridden if a different kind of data store is to be used.

Overrides:

initialiseDataStore in class Collector

createCollector

public static java.util.Map<java.lang.String,java.lang.Object> createCollector(java.lang.String[] args)

loadConfigurationOptions

public static java.util.Map<java.lang.String,java.lang.Object> loadConfigurationOptions(java.lang.String[] args)

loadConfigFile

public static java.util.Map<java.lang.String,java.lang.Object> loadConfigFile(java.lang.String configFile)

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>
 

GetDeviceList

public static java.lang.Object GetDeviceList(int dataSourceId,
                                             java.lang.String requestType,
                                             java.lang.String address,
                                             java.lang.String subnet)

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>
 

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>
 

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>
 

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>
 

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

loadData

public void loadData(int source)

configureCollector

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

Throws:

CollectorException

loadFirstRun

public void loadFirstRun()