com.ibm.tivoli.nm.collectors.impl.axyom

Class AxyomCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.axyom.AxyomCollector

public class AxyomCollector
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
AxyomCollector(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)
java.lang.String	GetAssociatedAddresses(int dataSourceId, java.lang.String deviceId) Get Associated addresses for a given data source and device ID
java.lang.String	GetDeviceInfo(int dataSourceId, java.lang.String deviceId) Get device info for a given data source and device ID
java.lang.String	GetDeviceList(int dataSourceId, int requestType, java.lang.String address, java.lang.String subnet) Get device list for a given data source
java.lang.String	GetENodeBData(int dataSourceId, java.lang.String deviceId) Get ENodeB data for a given device.
java.lang.String	GetEntities(int dataSourceId, java.lang.String deviceId) Get Entities for a given data source and device ID
java.lang.String	GetGNodeBData(int dataSourceId, java.lang.String deviceId) Get GNodeB data for a given device.
java.lang.String	GetInventory(int dataSourceId, java.lang.String deviceId) Get Inventory for a given data source and device ID
java.lang.String	GetLayer1Connections(int dataSourceId, java.lang.String deviceId) Get Layer1 Connections name for a given data source, device ID and topology type
protected void	initialiseDataStore() Initialise the data store.
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, GetEirData, GetEntities, 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

AxyomCollector

public AxyomCollector(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

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 java.lang.String GetDeviceList(int dataSourceId,
                                      int requestType,
                                      java.lang.String address,
                                      java.lang.String subnet)

Get device list for a given data source

Overrides:

GetDeviceList in class Collector

Parameters:

dataSourceId - The ID of 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.

subnet - Holds the subnet mask, or is not defined

Returns:

An XML String representing all the device list for the given data source ID

GetDeviceInfo

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

Get device info for a given data source and device ID

Overrides:

GetDeviceInfo in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing device info for the given data source ID and device ID

GetInventory

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

Get Inventory for a given data source and device ID

Overrides:

GetInventory in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing inventory for the given data source ID and device ID

GetEntities

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

Get Entities for a given data source and device ID

Overrides:

GetEntities in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing entities for the given data source ID and device ID

GetENodeBData

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

Get ENodeB data for a given device. Implements the XML-RPC method for GetENodeBData() required by the LTE agent. Returns an XML string that represents a ENodeB entity data. Use LTEDataStore to generate the XML String.

Overrides:

GetENodeBData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing all of the LTE data for the given device

GetGNodeBData

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

Get GNodeB data for a given device. Implements the XML-RPC method for GetGNodeBData() required by the N5G agent. Returns an XML string that represents a GNodeB entity data. Use N5GDataStore to generate the XML String.

Overrides:

GetGNodeBData in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing all of the LTE data for the given device

GetAssociatedAddresses

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

Get Associated addresses for a given data source and device ID

Overrides:

GetAssociatedAddresses in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

Returns:

An XML String representing associated addresses for the given data source ID and device ID

GetLayer1Connections

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

Get Layer1 Connections name for a given data source, device ID and topology type

Overrides:

GetLayer1Connections in class Collector

Parameters:

dataSourceId - The ID of the data source

deviceId - The ID of the device

topologyType - The topology type

Returns:

An XML String representing connections for the given data source ID and device ID

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()