com.ibm.tivoli.nm.collectors.impl.switchcommander

Class SwitchCommanderCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.switchcommander.SwitchCommanderCollector

public class SwitchCommanderCollector
extends Collector

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
SwitchCommanderCollector(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.
protected void	doFullDiscovery() Perform Full Discovery
protected void	doPartialDiscovery(java.lang.String address) Perform Partial Discovery
static Corba3GPPProvider	getCorba()
static SwitchCommanderCollectorDataStoreMap	getDataMap()
static java.util.Properties	getPropsFile() Returns the Properties object for this collector
protected void	initialiseDataStore() Initialise the data store.
static void	main(java.lang.String[] args) Entry point for this class
protected void	processBoard() Retrieve, process and add board data to data store
protected void	processManagedElement(java.lang.String address) Process managed element
protected void	processPort() Process port data //TODO This is a placeholder function for processing ports information
protected void	processRack() Retrieve, process and add rack data to data store
protected void	processShelf() Retrieve, process and add shelves data to data store
static void	setCorba(Corba3GPPProvider corba)
static void	setDATA_SOURCE_ID(int dATA_SOURCE_ID)
static void	setPropsFile(java.util.Properties propsFile)
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, GetEntities, GetGNodeBData, GetHssData, GetInfo, GetInventory, 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, 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

SwitchCommanderCollector

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

Constructor

Parameters:

collectorName - Collector name

collectorDescription - Collector description

Method Detail

getDataMap

public static SwitchCommanderCollectorDataStoreMap getDataMap()

Returns:

the dataMap

getPropsFile

public static java.util.Properties getPropsFile()

Returns the Properties object for this collector

Returns:

The Properties object of this collector

getCorba

public static Corba3GPPProvider getCorba()

Returns:

the corba

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)

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>
 

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

processManagedElement

protected void processManagedElement(java.lang.String address)

Process managed element

processRack

protected void processRack()

Retrieve, process and add rack data to data store

processShelf

protected void processShelf()

Retrieve, process and add shelves data to data store

processBoard

protected void processBoard()

Retrieve, process and add board data to data store

processPort

protected void processPort()

Process port data //TODO This is a placeholder function for processing ports information

doFullDiscovery

protected void doFullDiscovery()

Perform Full Discovery

doPartialDiscovery

protected void doPartialDiscovery(java.lang.String address)

Perform Partial Discovery

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.

setPropsFile

public static void setPropsFile(java.util.Properties propsFile)

setDATA_SOURCE_ID

public static void setDATA_SOURCE_ID(int dATA_SOURCE_ID)

setCorba

public static void setCorba(Corba3GPPProvider corba)