com.ibm.tivoli.nm.collectors.impl.nokiansprest

Class NokiaNSPRestCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.nokiansprest.NokiaNSPRestCollector

public class NokiaNSPRestCollector
extends Collector

Field Summary

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

collectorDescription, collectorName, collectorPort, dataStore, propsFileName, running

Constructor Summary

Constructors

Constructor and Description
NokiaNSPRestCollector(java.lang.String collectorName, java.lang.String collectorDescription) 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.
java.lang.String	GetEntities(int dataSourceId, java.lang.String deviceId) Optional - An override method of the GetEntities() is responsible for gathering device entities information for a specified device id from EMS.
java.lang.String	GetInventory(int dataSourceId, java.lang.String deviceId) Optional - An override method of the GetInventory() is responsible for gathering device interface information for a specified device id from EMS.
protected void	initDataStore() Initializes data source as specified in the properties file
protected boolean	initialiseProperties() Initialize collector with data gather from properties file
static void	main(java.lang.String[] args) Runs the Nokia NSP rest collector
java.lang.String	UpdateData(int dataSourceId, int requestType, java.lang.String address, java.lang.String mask) UpdateData invokes the collectData method which is responsible for ensuring that data is updated as appropriate, that is, the Collector should check the EMS for new data and update any internal stores as appropriate.

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

GetAfData, GetAmfData, GetAssociatedAddresses, GetAssociatedAddresses, GetAusfData, getCommandLineArgument, GetConnections, GetConnections, GetDeviceInfo, GetDeviceInfo, GetDeviceInfo, GetDeviceList, GetEirData, GetENodeBData, GetEntities, GetGNodeBData, GetHssData, GetInfo, GetInventory, GetLayer1Connections, GetLayer1Connections, GetLayer2Connections, GetLayer2Connections, GetLayer2Vpns, GetLayer2Vpns, GetLayer3Connections, GetLayer3Connections, GetLayer3Vpns, GetLayer3Vpns, GetMmeData, GetMplsInterfaces, GetMplsInterfaces, GetNefData, GetNrfData, GetNssfData, GetPcfData, GetPcrfData, GetPgwData, getPortNumberArgument, getPropertiesFileNameArgument, getPropertyValue, GetRanData, GetSAEGatewayData, GetSgwData, GetSmfData, GetUdmData, GetUpfData, initialiseDataStore, isRunning, loadPropertiesFile, setDataStore, setRunning, shutdown, startup, startup

Methods inherited from class java.lang.Object

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

Constructor Detail

NokiaNSPRestCollector

public NokiaNSPRestCollector(java.lang.String collectorName,
                             java.lang.String collectorDescription)
                      throws CollectorException

Constructor

Parameters:

collectorName - The name of the collector

collectorDescription - A description of the collector

Throws:

CollectorException

Method Detail

main

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

Runs the Nokia NSP rest collector

Parameters:

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

initialiseProperties

protected boolean initialiseProperties()

Initialize collector with data gather from properties file

Returns:

Successful/true if all the properties are initialized else false

initDataStore

protected void initDataStore()
                      throws CollectorException

Initializes data source as specified in the properties file

Throws:

CollectorException

collectData

protected void collectData(int dataSourceId,
                           java.lang.String address,
                           java.lang.String mask)

Description copied from class: Collector

This method is responsible for ensuring that data is updated as appropriate, that is, the Collector should check the EMS for new data and update any internal stores as appropriate.

Specified by:

collectData in class Collector

Parameters:

dataSourceId - Holds the ID of the data source which should be updated

address - If mask is not defined then it holds the address (IP or native id) of the device to refresh, or else it holds the subnet to refresh.

mask - Holds the subnet mask, or is not defined

UpdateData

public java.lang.String UpdateData(int dataSourceId,
                                   int requestType,
                                   java.lang.String address,
                                   java.lang.String mask)

UpdateData invokes the collectData method which is responsible for ensuring that data is updated as appropriate, that is, the Collector should check the EMS for new data and update any internal stores as appropriate.

If the Collector does not need to update its data then it does not need to perform any work other than returning the response message "<updateResponse></updateResponse>".

Note: It's the Collector's responsibility to determine which devices the supplied IP relates to; the IP is NOT guaranteed to be the device id.

Overrides:

UpdateData in class Collector

Parameters:

dataSourceId - Holds the ID of the data source which should be updated

requestType - The type of request

address - If mask is not defined then it holds the IP of the device to refresh, or else it holds the subnet to refresh

mask - Holds the subnet mask, or is not defined

Returns:

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

GetEntities

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

Optional - An override method of the GetEntities() is responsible for gathering device entities information for a specified device id from EMS.

Overrides:

GetEntities in class Collector

Parameters:

dataSourceId - The ID for the data source

deviceId - The ID for the device

Returns:

An XML String listing entities for a given device

GetInventory

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

Optional - An override method of the GetInventory() is responsible for gathering device interface information for a specified device id from EMS.

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