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:
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 DataSource
s 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)
:
collector.properties
file which provides default configuration for the frameworkcsvcollector.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 collectorlog.directory
- base directory where log files should be storedlog.filename
- pattern of the log file name, see FileHandler
log.level
- one of: NONE, FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALLlog.maxsize
- maximum size of the log file, once it's reached, file is renamed and kept as a backuplog.count
- number of backup log files to keeplog.messageprefix
- log message prefixtrace.filename
- pattern of the trace file nametrace.level
- one of: NONE, FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALLtrace.maxsize
- maximum size of the trace file, once it's reached, file is renamed and kept as a backuptrace.count
- number of backup trace files to keepSampleCollector
,
SampleRANCollector
,
CSVCollector
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 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.
|
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 |
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.
|
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 |
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 |
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 |
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
|
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.
|
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
|
boolean |
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.
|
protected static boolean collectData
protected static volatile boolean running
protected static java.lang.String collectorDescription
protected static java.lang.String collectorName
protected static int collectorPort
protected static CollectorDataStore dataStore
protected static java.lang.String propsFileName
public Collector(java.lang.String collectorName, java.lang.String collectorDescription)
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.collectorName
- The name of the collectorcollectorDescription
- A description of the collectorprotected static java.lang.String getCommandLineArgument(java.lang.String argumentName, java.lang.String[] args)
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 parseprotected static int getPortNumberArgument(java.lang.String[] args, int defaultValue)
args
- The command line argumentsdefaultValue
- The default value of the port if not specified on the command lineprotected static java.lang.String getPropertiesFileNameArgument(java.lang.String[] args, java.lang.String defaultValue)
args
- The command line argumentsdefaultValue
- The default value of the properties file if not specified on the command lineprotected static java.lang.String getPropertyValue(java.lang.String propertyName, java.util.Properties frameworkProps, java.util.Properties collectorProps)
propertyName
- The name of the property to fetchframeworkProps
- The framework properties filecollectorProps
- The collector properties fileprotected static java.util.Properties loadPropertiesFile(java.lang.String propsFileName)
propsFileName
- The name of the properties file to loadprotected 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).
args
- Command line arguments used in starting up the collector frameworkprotected 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.
args
- Command line arguments used in starting up the collector frameworkdefaultPropertyFileName
- The default name of the collector implementation properties fileprotected 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.
dataSourceId
- Holds the ID of the data source which should be updatedaddress
- 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 definedpublic 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.
dataSourceId
- The ID for the data sourcedeviceId
- The ID for the device
<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>
public java.lang.String GetAssociatedAddresses(int dataSourceId, int deviceId)
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.
dataSourceId
- The ID of the data sourcedeviceId
- The ID of the devicetopologyType
- The connection topology type, for example Layer1, Layer2, Layer3 or Microwave
<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>
public java.lang.String GetConnections(int dataSourceId, int deviceId, java.lang.String topologyType)
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.
dataSourceId
- The ID for the data sourcedeviceId
- The ID for the device
<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>
public java.lang.String GetDeviceInfo(int dataSourceId, int deviceId)
public java.lang.String GetDeviceInfo(java.lang.String dataSourceId, java.lang.String deviceId)
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.
dataSourceId
- The ID for the data sourcerequestType
- 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
<deviceList>
<device>
<id>10.1.230.3</id>
<ip>10.1.230.3</ip>
<addressSpace></addressSpace>
</device>
.. other devices ..
</deviceList>
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.
dataSourceId
- The ID for the data sourcedeviceId
- The ID for the device
<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>
public java.lang.String GetEntities(int dataSourceId, int deviceId)
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.
<collectorInfo>
<name>CollectorsName</name>
<descr>Collectors Description</descr>
<datasources>
<datasource>
<id>1</id>
<descr>Example data source</descr>
</datasource>
.. other data sources ..
</datasources>
</collectorInfo>
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.
dataSourceId
- The ID for the data sourcedeviceId
- The ID for the device
<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>
public java.lang.String GetInventory(int dataSourceId, int deviceId)
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.
dataSourceId
- The ID of the data sourcedeviceId
- The ID of the device
<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>
public java.lang.String GetLayer1Connections(int dataSourceId, int deviceId)
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.
dataSourceId
- The ID of the data sourcedeviceId
- The ID of the device
<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>
public java.lang.String GetLayer2Connections(int dataSourceId, int deviceId)
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.
dataSourceId
- The ID of the data sourcedeviceId
- The ID of the device
<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>
public java.lang.String GetLayer2Vpns(int dataSourceId, int deviceId)
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.
dataSourceId
- The ID of the data sourcedeviceId
- The ID of the device
<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>
public java.lang.String GetLayer3Connections(int dataSourceId, int deviceId)
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.
dataSourceId
- The ID of the data sourcedeviceId
- The ID of the device
<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>
public java.lang.String GetLayer3Vpns(int dataSourceId, int deviceId)
public java.lang.String GetMplsInterfaces(int dataSourceId, java.lang.String deviceId)
Optional - Get a list of MPLS interfaces for a given device
dataSourceId
- The ID of the data sourcedeviceId
- The ID of the device
<mplsInterfaceData>
<deviceId>10.1.1.1</deviceId>
<interfaceList>
<interface>
<ifIndex>1</ifIndex>
</interface>
</interfaceList>
</mplsInterfaceData>
public java.lang.String GetMplsInterfaces(int dataSourceId, int deviceId)
protected void initialiseDataStore()
DataStore
. Should be overridden if a
different kind of data store is to be used.public boolean isRunning()
public boolean shutdown()
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.
dataSourceId
- Holds the ID of the data source which should be updatedrequestType
- The type of requestaddress
- 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
<updateResponse></updateResponse>