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

Class Collector

java.lang.Object

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

Direct Known Subclasses:

Alcatel5620SamCollector, AlcatelNR8PLIooIsnCollector, AxyomCollector, CalixRestCollector, CiscoApicRestCollector, CiscoDNARestCollector, CiscoEPNMRestCollector, CiscoLMSCollector, CSVCollector, EciLightsoftCollector, HuaweiCorbaTMF814Collector, HuaweiM2KCollector, HuaweiTL1Collector, MTOSISoapCollector, NetActCMDumpCollector, NetActCollector, NetActCsvCollector, NetViewerCollector, Nokia5529IdmCollector, NokiaAltiplanoRestCollector, NokiaNSPRestCollector, NokiaOMS1350RestCollector, OpticalBlackBoxXmlCollector, SampleCollector, SampleLTECollector, SampleRANCollector, Samsung820USMXmlCollector, SwitchCommanderCollector, TellabsINM8000Collector

public abstract class Collector
extends java.lang.Object

Class to be extended to create a java based ITNM collector. The Collector abstract class is the base class for any ITNM collector implementation, which must implement the collectData(int, String, String) and provide a public static void main(String[] args) method to run the collector implementation.

The collector class provides implementations for all of the supported XML-RPC methods (signified by the methods starting with a capital letter:

• UpdateData()
• GetInfo()
• GetDeviceList()
• GetDeviceInfo()
• GetAssociatedAddresses()
• GetInventory()
• GetEntities()
• GetLayer2Vpns()
• GetLayer3Vpns()
• GetLayer1Connections()
• GetLayer2Connections()
• GetLayer3Connections()
• GetMplsInterfaces()

To add a new XML-RPC method to the Collector, all that is required is to provide a public method that returns a String, where the returned String is the XML that is to be returned by the XML-RPC invocation. For an example, see SampleRANCollector.GetRanData(int, String).

Each collector has an associated CollectorDataStore which stores the collected network data. The default implementation of initialiseDataStore() uses an instance of the in-memory data store DataStore to store data, with no DataSources added. To use an alternative CollectorDataStore implementation, the initialiseDataStore() method can be overridden.

The Collector class also parses up to two properties file for configuration purposes, making use of loadPropertiesFile(String):

1. A default, collector.properties file which provides default configuration for the framework
2. A collector specific properties file e.g. csvcollector.properties which provides configuration specific to a collector implementation. Any properties in this file override the same properties specified in the collector.properties file.

The configuration files follow the standard Properties standard. The configuration properties supported in the collector.properties file are as follows:

• port - the port on which to run the collector
• log.directory - base directory where log files should be stored
• log.filename - pattern of the log file name, see FileHandler
• log.level - one of: NONE, FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALL
• log.maxsize - maximum size of the log file, once it's reached, file is renamed and kept as a backup
• log.count - number of backup log files to keep
• log.messageprefix - log message prefix
• trace.filename - pattern of the trace file name
• trace.level - one of: NONE, FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALL
• trace.maxsize - maximum size of the trace file, once it's reached, file is renamed and kept as a backup
• trace.count - number of backup trace files to keep

Author:

Emlyn Whittick

See Also:

SampleCollector, SampleRANCollector, CSVCollector

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	collectData Whether or not to re-collect data when updateData is called.
protected static java.lang.String	collectorDescription The description for this collector
protected static java.lang.String	collectorName The name of the collector
protected static int	collectorPort The port on which the collector should be run
protected static CollectorDataStore	dataStore The data store used to store all the data collected
protected static java.lang.String	propsFileName The name of the properties file for this collector
protected static boolean	running Whether or not the collector is currently running.

Constructor Summary

Constructors

Constructor and Description
Collector(java.lang.String collectorName, java.lang.String collectorDescription) Create a new instance of the collector, providing a name and description and parse the properties file(s) for this collector.

Method Summary

Modifier and Type	Method and Description
protected abstract 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.
java.lang.String	GetAfData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetAmfData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetAssociatedAddresses(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 GetAssociatedAddresses method
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	GetAusfData(int dataSourceId, java.lang.String deviceId)
protected static java.lang.String	getCommandLineArgument(java.lang.String argumentName, java.lang.String[] args) Extract a given command line argument from command line arguments passed to the collector
java.lang.String	GetConnections(int dataSourceId, int deviceId, java.lang.String topologyType) Handler for deviceId in integer and converts deviceId in integer to string allowing collector to respond to ncp_query_collector Invokes main GetConnections method
java.lang.String	GetConnections(int dataSourceId, java.lang.String deviceId, java.lang.String topologyType) Optional - The Collector implementation of GetConnections() is responsible for gathering and returning all resolved connection information for the supplied topology type and supplied device and data source.
java.lang.String	GetDeviceInfo(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 GetDeviceInfo method
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.
java.lang.String	GetDeviceInfo(java.lang.String dataSourceId, java.lang.String deviceId) Handler for deviceId in integer and converts deviceId in integer to string allowing collector to respond to ncp_query_collector Invokes main GetDeviceInfo method
java.lang.String	GetDeviceList(int dataSourceId, int requestType, java.lang.String address, java.lang.String subnetMask) The Collector implementation of GetDeviceList() is responsible for determining and returning the addresses and ids of all devices that are managed by the Collector within the specified data source.
java.lang.String	GetEirData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetENodeBData(int dataSourceId, java.lang.String deviceId)
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	GetGNodeBData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetHssData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetInfo() The Collector implementation of GetInfo() is responsible for responding with information on the Collector and its supported data sources.
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.lang.String	GetLayer1Connections(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 GetLayer1Connections method
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.
java.lang.String	GetLayer2Connections(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 GetLayer2Connections method
java.lang.String	GetLayer2Connections(int dataSourceId, java.lang.String deviceId) Optional - The Collector implementation of GetLayer2Connections() is responsible for gathering and returning all resolved layer 2 connection information for the supplied device data source.
java.lang.String	GetLayer2Vpns(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 GetLayer2Vpns method
java.lang.String	GetLayer2Vpns(int dataSourceId, java.lang.String deviceId) Optional - The Collector implementation of GetLayer2Vpns() is responsible for gathering and returning all layer 2 VPNs configured on a given device id and data source.
java.lang.String	GetLayer3Connections(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 GetLayer3Connections method
java.lang.String	GetLayer3Connections(int dataSourceId, java.lang.String deviceId) Optional - The Collector implementation of GetLayer3Connections() is responsible for gathering and returning all resolved layer 3 link information for the supplied device id and data source.
java.lang.String	GetLayer3Vpns(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 GetLayer3Vpns method
java.lang.String	GetLayer3Vpns(int dataSourceId, java.lang.String deviceId) Optional - The Collector implementation of GetLayer3Vpns() is responsible for gathering and returning all layer 3 VPNs configured on a given device id and data source.
java.lang.String	GetMmeData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetMplsInterfaces(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 GetMplsInterfaces method
java.lang.String	GetMplsInterfaces(int dataSourceId, java.lang.String deviceId) Optional - Get a list of MPLS interfaces for a given device
java.lang.String	GetNefData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetNrfData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetNssfData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetPcfData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetPcrfData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetPgwData(int dataSourceId, java.lang.String deviceId)
protected static int	getPortNumberArgument(java.lang.String[] args, int defaultValue) Get the -port argument value given some command line arguments
protected static java.lang.String	getPropertiesFileNameArgument(java.lang.String[] args, java.lang.String defaultValue) Get the -propsFile argument value given some command line arguments
protected static java.lang.String	getPropertyValue(java.lang.String propertyName, java.util.Properties frameworkProps, java.util.Properties collectorProps) Get a value for a given property from one of the properties file.
java.lang.String	GetRanData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetSAEGatewayData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetSgwData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetSmfData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetUdmData(int dataSourceId, java.lang.String deviceId)
java.lang.String	GetUpfData(int dataSourceId, java.lang.String deviceId)
protected void	initialiseDataStore() Initialise the data store.
boolean	isRunning() Check whether or not the collector is running and whether or not it has been told to shut down
protected static java.util.Properties	loadPropertiesFile(java.lang.String propsFileName) Attempt to load a properties file containing configuration data for the collector
static void	setDataStore(CollectorDataStore dataStore)
static void	setRunning(boolean running)
java.lang.String	shutdown() Can be invoked using XML-RPC to shut down the collector process
protected static void	startup(java.lang.String[] args) Start up the collector framework, parse any command line arguments such as the property file location and port number and initialise the logging framework.
protected static void	startup(java.lang.String[] args, java.lang.String defaultPropertyFileName) Start up the collector framework, parse any command line arguments such as the property file location and port number and initialise the logging framework.
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 java.lang.Object

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

Field Detail

collectData

protected static boolean collectData

Whether or not to re-collect data when updateData is called. Can be set by the collectData property in a .properties file

running

protected static volatile boolean running

Whether or not the collector is currently running. Used to shutdown the collector process remotely

collectorDescription

protected static java.lang.String collectorDescription

The description for this collector

collectorName

protected static java.lang.String collectorName

The name of the collector

collectorPort

protected static int collectorPort

The port on which the collector should be run

dataStore

protected static CollectorDataStore dataStore

The data store used to store all the data collected

propsFileName

protected static java.lang.String propsFileName

The name of the properties file for this collector

Constructor Detail

Collector

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

Create a new instance of the collector, providing a name and description and parse the properties file(s) for this collector. The constructor will look for a collector.properties file and another properties file specified by propsFileName (if the name differs) to load collector configuration options (e.g. port and logging). It will also look to see if the port or properties file name has been provided as a command line argument, and if so, use the appropriate values.

Parameters:

collectorName - The name of the collector

collectorDescription - A description of the collector

Method Detail

getCommandLineArgument

protected static java.lang.String getCommandLineArgument(java.lang.String argumentName,
                                                         java.lang.String[] args)

Extract a given command line argument from command line arguments passed to the collector

Parameters:

argumentName - The name of the argument to look for, e.g. -port will look for the command line argument after -port: -port 8080 will return 8080

args - The command line arguments to parse

Returns:

The corresponding value for the given argument, if present/valid. If not specified, then will return null

getPortNumberArgument

protected static int getPortNumberArgument(java.lang.String[] args,
                                           int defaultValue)

Get the -port argument value given some command line arguments

Parameters:

args - The command line arguments

defaultValue - The default value of the port if not specified on the command line

Returns:

The port number for the collector service to run on

getPropertiesFileNameArgument

protected static java.lang.String getPropertiesFileNameArgument(java.lang.String[] args,
                                                                java.lang.String defaultValue)

Get the -propsFile argument value given some command line arguments

Parameters:

args - The command line arguments

defaultValue - The default value of the properties file if not specified on the command line

Returns:

The name/path to the properties file for the collector

getPropertyValue

protected static java.lang.String getPropertyValue(java.lang.String propertyName,
                                                   java.util.Properties frameworkProps,
                                                   java.util.Properties collectorProps)

Get a value for a given property from one of the properties file. The collector properties file take precedence (and overrides) the framework properties file

Parameters:

propertyName - The name of the property to fetch

frameworkProps - The framework properties file

collectorProps - The collector properties file

Returns:

The String value for the property, if defined, or null if no value was found in either file

loadPropertiesFile

protected static java.util.Properties loadPropertiesFile(java.lang.String propsFileName)

Attempt to load a properties file containing configuration data for the collector

Parameters:

propsFileName - The name of the properties file to load

Returns:

The properties file if present, or if not, null

startup

protected static void startup(java.lang.String[] args)

Start up the collector framework, parse any command line arguments such as the property file location and port number and initialise the logging framework. This method must be called prior to creating a collector instance. Use this version of the method when there is no implementation specific properties file to be specified (e.g. there are no configurable options for your collector implementation).

Parameters:

args - Command line arguments used in starting up the collector framework

startup

protected static void startup(java.lang.String[] args,
                              java.lang.String defaultPropertyFileName)

Start up the collector framework, parse any command line arguments such as the property file location and port number and initialise the logging framework. This method must be called prior to creating a collector instance.

Parameters:

args - Command line arguments used in starting up the collector framework

defaultPropertyFileName - The default name of the collector implementation properties file

collectData

protected abstract 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.

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

GetAssociatedAddresses

public 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.

This method is used by the CollectorInventory agents to produce a list of associated IP addresses to allow ITNM to perform address translation.

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>
 

GetAssociatedAddresses

public java.lang.String GetAssociatedAddresses(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 GetAssociatedAddresses method

Returns:

Calls main GetAssociatedAddresses method

GetConnections

public java.lang.String GetConnections(int dataSourceId,
                                       java.lang.String deviceId,
                                       java.lang.String topologyType)

Optional - The Collector implementation of GetConnections() is responsible for gathering and returning all resolved connection information for the supplied topology type and supplied device and data source.

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

topologyType - The connection topology type, for example Layer1, Layer2, Layer3 or Microwave

Returns:

An XML String describing all connections for the specified topology type for the device, for example, for the Microwave topology type:

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

GetConnections

public java.lang.String GetConnections(int dataSourceId,
                                       int deviceId,
                                       java.lang.String topologyType)

Handler for deviceId in integer and converts deviceId in integer to string allowing collector to respond to ncp_query_collector Invokes main GetConnections method

Returns:

Calls main GetConnections method

GetDeviceInfo

public 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.

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>
 

GetDeviceInfo

public java.lang.String GetDeviceInfo(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 GetDeviceInfo method

Returns:

Calls main GetDeviceInfo method

GetDeviceInfo

public java.lang.String GetDeviceInfo(java.lang.String dataSourceId,
                                      java.lang.String deviceId)

Handler for deviceId in integer and converts deviceId in integer to string allowing collector to respond to ncp_query_collector Invokes main GetDeviceInfo method

Returns:

Calls main GetDeviceInfo method

GetDeviceList

public java.lang.String GetDeviceList(int dataSourceId,
                                      int requestType,
                                      java.lang.String address,
                                      java.lang.String subnetMask)

The Collector implementation of GetDeviceList() is responsible for determining and returning the addresses and ids of all devices that are managed by the Collector within the specified data source.

The device id <id> should uniquely identify the device within the Collector/data source.

ITNM will supply the device ids returned by GetDeviceList() in further calls to the Collector.

Parameters:

dataSourceId - The ID for the data source

requestType - The type of request - 0 (no address or mask), 1 (address no mask), 2 (all)

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.

subnetMask - Holds the subnet mask, or is not defined

Returns:

An XML String listing all of the devices for the given data source e.g.

  <deviceList>
   <device>
     <id>10.1.230.3</id>
     <ip>10.1.230.3</ip>
     <addressSpace></addressSpace>
   </device>
   .. other devices ..
 </deviceList>
 

GetEntities

public 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.

This method is used by the CollectorInventory agent to produce a list of entity information for later use in containment modeling.

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>
 

GetEntities

public 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

Returns:

Calls main GetEntities method

GetInfo

public java.lang.String GetInfo()

The Collector implementation of GetInfo() is responsible for responding with information on the Collector and its supported data sources.

This method is called by ITNM's Collector Finder to determine which Collectors are valid and which data sources they support. ITNM will subsequently issue RPC calls for data from the listed data sources.

The Collector is responsible for ensuring that each data source has a unique identifier.

Returns:

An XML String describing the collector and listing its data sources e.g.

  <collectorInfo>
   <name>CollectorsName</name>
   <descr>Collectors Description</descr>
   <datasources>
     <datasource>
       <id>1</id>
       <descr>Example data source</descr>
     </datasource>
     .. other data sources ..
   </datasources>
 </collectorInfo>
 

GetInventory

public 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.

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>
 

GetInventory

public 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

Returns:

Calls main GetInventory method

GetLayer1Connections

public 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.

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

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>
 

GetLayer1Connections

public java.lang.String GetLayer1Connections(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 GetLayer1Connections method

Returns:

Calls main GetLayer1Connections method

GetLayer2Connections

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

Optional - The Collector implementation of GetLayer2Connections() is responsible for gathering and returning all resolved layer 2 connection information for the supplied device data source.

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

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

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

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

GetLayer2Connections

public java.lang.String GetLayer2Connections(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 GetLayer2Connections method

Returns:

Calls main GetLayer2Connections method

GetLayer2Vpns

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

Optional - The Collector implementation of GetLayer2Vpns() is responsible for gathering and returning all layer 2 VPNs configured on a given device id and data source.

ITNM will process this data with its standard MPLS stitchers to generate VPN membership information for display in the GUI.

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String listing all layer 2 VPNs configured on a given device e.g.

  <layer2Vpns>
   <vpn>
     <vpnName>50</vpnName>
     <localLabel>26</localLabel>
     <vcId>50</vcId>
     <localIfIndex>32</localIfIndex>
     <topologyType>5</topologyType>
     <vcType>4</vcType>
     <peerLabel>28</peerLabel>
     <status>1</status>
     <peerIp>10.1.254.2</peerIp>
     <peerIfIndex>5</peerIfIndex>
   </vpn>
   <vpn>
     <vpnName>50</vpnName>
     <localLabel>26</localLabel>
     <vcId>50</vcId>
     <localInterfaceId>MyInterfaceId32</localInterfaceI>
     <topologyType>5</topologyType>
     <vcType>4</vcType>
     <peerLabel>28</peerLabel>
     <status>1</status>
     <peerIp>10.1.254.2</peerIp>
     <peerInterfaceId>MyInterfaceId5</peerInterfaceId>
   </vpn>
   .. other vpns ..
 </layer2Vpns>
 

GetLayer2Vpns

public java.lang.String GetLayer2Vpns(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 GetLayer2Vpns method

Returns:

Calls main GetLayer2Vpns method

GetLayer3Connections

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

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

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

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

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

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

GetLayer3Connections

public java.lang.String GetLayer3Connections(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 GetLayer3Connections method

Returns:

Calls main GetLayer3Connections method

GetLayer3Vpns

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

Optional - The Collector implementation of GetLayer3Vpns() is responsible for gathering and returning all layer 3 VPNs configured on a given device id and data source.

ITNM will process this data with its standard MPLS stitchers to generate VPN membership information for display in the GUI.

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String listing all layer 3 VPNs configured on a given device e.g.

  <layer3Vpns>
   <vpn>
     <descr>my blue VPN</descr>
     <vrfName>blue</vrfName>
     <vpnName>blue</vpnName>
     <rd>10:401</rd>
     <status>1</status>
     <importRTs>
       <rt>10:401</rt>
     </importRTs>
     <exportRTs>
       <rt>10:601</rt>
     </exportRTs>
     <interfaces>
       <interface>
         <customerName>A Company</customerName>
         <ceIp>10.0.0.1</ceIp>
         <ifIndex>10</ifIndex>
         <customerDescr> A Company</customerDescr>
         <protocol>2</protocol>
       </interface>
       <interface>
         <customerName>A Company</customerName>
         <ceIp>10.0.0.1</ceIp>
         <interfaceId>MyeIdFor19</interfaceId>
         <customerDescr> A Company</customerDescr>
         <protocol>2</protocol>
       </interface>
       .. other interfaces ..
     </interfaces>
   </vpn>
   .. other vpns ..
 </layer3Vpns>
 

GetLayer3Vpns

public java.lang.String GetLayer3Vpns(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 GetLayer3Vpns method

Returns:

Calls main GetLayer3Vpns method

GetMplsInterfaces

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

Optional - Get a list of MPLS interfaces for a given device

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String listing all the MPLS interfaces for a given device e.g.

  <mplsInterfaceData>
   <deviceId>10.1.1.1</deviceId>
   <interfaceList>
     <interface>
       <ifIndex>1</ifIndex>
     </interface>
   </interfaceList>
 </mplsInterfaceData>
 

GetMplsInterfaces

public java.lang.String GetMplsInterfaces(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 GetMplsInterfaces method

Returns:

Calls main GetMplsInterfaces method

initialiseDataStore

protected void initialiseDataStore()

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.

isRunning

public boolean isRunning()

Check whether or not the collector is running and whether or not it has been told to shut down

Returns:

Whether or not the collector should be running. False if the collector should be shut down.

shutdown

public java.lang.String shutdown()

Can be invoked using XML-RPC to shut down the collector process

Returns:

Whether or not the collector is now running

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.

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>
 

setDataStore

public static void setDataStore(CollectorDataStore dataStore)

setRunning

public static void setRunning(boolean running)

GetENodeBData

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

GetGNodeBData

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

GetSgwData

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

GetSAEGatewayData

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

GetPcrfData

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

GetMmeData

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

GetPgwData

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

GetRanData

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

GetEirData

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

GetHssData

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

GetAmfData

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

GetSmfData

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

GetUpfData

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

GetPcfData

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

GetNefData

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

GetNrfData

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

GetAusfData

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

GetAfData

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

GetUdmData

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

GetNssfData

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