com.ibm.tivoli.nm.collectors.sample

Class SampleCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.sample.SampleCollector

public class SampleCollector
extends Collector

Sample use of the Collector super class. This example collector class shows a basic implementation and usage of the collector class and data store.

Author:

Emlyn Whittick

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
SampleCollector(java.lang.String name, java.lang.String desc) Create a sample collector with a given name and description.

Method Summary

Modifier and Type	Method and Description
protected void	collectData(int dataSourceId, java.lang.String address, java.lang.String mask) This method adds some sample data to the collector data store.
protected void	initialiseDataStore() This method calls the super class to initialise the data store, which makes use of the default DataStore implementation and then adds two sample data sources to the data store (one with id 1, another with id 2).
static void	main(java.lang.String[] args) The collector is run by implementing a public static void main(String[] args) method.

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, UpdateData

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleCollector

public SampleCollector(java.lang.String name,
                       java.lang.String desc)

Create a sample collector with a given name and description. This method simply calls the corresponding method in the super class and initialises the logger.

Parameters:

name - The name of the collector

desc - The description for the collector

Method Detail

initialiseDataStore

protected void initialiseDataStore()

This method calls the super class to initialise the data store, which makes use of the default DataStore implementation and then adds two sample data sources to the data store (one with id 1, another with id 2).

Overrides:

initialiseDataStore in class Collector

collectData

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

This method adds some sample data to the collector data store. The following are added to the data store:

1. A new device with ID and address 10.1.1.1, a base name of "Network Hub" and a system object ID of 1.3.6.1.4.1.123.456 and system description of "An example device"
2. Two pieces of address data associated with the above device:
   1. Address with IP 10.1.1.1, ifOperStatus 1 and ifIndex 1
   2. Address with IP 198.1.1.1, ifOperStatus 1 and ifIndex 2

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

main

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

The collector is run by implementing a public static void main(String[] args) method. Here we create a new instance of the SampleCollector and then use CollectorEmbeddedServer#runEmbeddedServer(Collector, String[]) to run the collector on an embedded server. If no port is specified in the command line arguments (-port <port_number>), then the default port of 8080 is used.

Parameters:

args - Command line arguments to the collector, e.g. -port <port_number>