public class OpticalBlackBoxXmlCollector extends Collector
collectData, collectorDescription, collectorName, collectorPort, dataStore, running| Constructor and Description |
|---|
OpticalBlackBoxXmlCollector(java.lang.String collectorName,
java.lang.String collectorDescription) |
| 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) |
static java.util.Map<java.lang.String,java.lang.Object> |
createCollector(java.lang.String[] args) |
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.
|
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.
|
static java.lang.Object |
GetDeviceList(int dataSourceId,
java.lang.String requestType,
java.lang.String address,
java.lang.String subnet) |
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 |
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,
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.
|
protected void |
initialiseDataStore()
Initialise the data store.
|
static java.util.Map<java.lang.String,java.lang.Object> |
loadConfigFile(java.lang.String configFile) |
static java.util.Map<java.lang.String,java.lang.Object> |
loadConfigurationOptions(java.lang.String[] args) |
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.
|
GetAfData, GetAmfData, GetAssociatedAddresses, GetAusfData, getCommandLineArgument, GetConnections, GetConnections, GetDeviceInfo, GetDeviceInfo, GetDeviceList, GetEirData, GetENodeBData, GetEntities, GetGNodeBData, 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, startuppublic OpticalBlackBoxXmlCollector(java.lang.String collectorName,
java.lang.String collectorDescription)
public static void main(java.lang.String[] args)
protected void initialiseDataStore()
CollectorDataStore . Should be overridden if a
different kind of data store is to be used.initialiseDataStore in class Collectorpublic static java.util.Map<java.lang.String,java.lang.Object> createCollector(java.lang.String[] args)
public static java.util.Map<java.lang.String,java.lang.Object> loadConfigurationOptions(java.lang.String[] args)
public static java.util.Map<java.lang.String,java.lang.Object> loadConfigFile(java.lang.String configFile)
public java.lang.String UpdateData(int dataSourceId,
int requestType,
java.lang.String address,
java.lang.String mask)
CollectorUpdateData 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.
UpdateData in class CollectordataSourceId - 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>
public static java.lang.Object GetDeviceList(int dataSourceId,
java.lang.String requestType,
java.lang.String address,
java.lang.String subnet)
public java.lang.String GetDeviceInfo(int dataSourceId,
java.lang.String deviceId)
CollectorThe Collector implementation of GetDeviceInfo() is responsible for gathering and returning basic device level information for a specified device and data source.
GetDeviceInfo in class CollectordataSourceId - 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 GetInventory(int dataSourceId,
java.lang.String deviceId)
CollectorOptional - The Collector implementation of GetInventory() is responsible for gathering and returning device interface information for a specified device id and data source.
GetInventory in class CollectordataSourceId - 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 GetEntities(int dataSourceId,
java.lang.String deviceId)
CollectorOptional - 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.
GetEntities in class CollectordataSourceId - 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 GetAssociatedAddresses(int dataSourceId,
java.lang.String deviceId)
CollectorThe 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.
GetAssociatedAddresses in class CollectordataSourceId - 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 GetLayer1Connections(int dataSourceId,
java.lang.String deviceId)
CollectorOptional - 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.
GetLayer1Connections in class CollectordataSourceId - 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>
protected void collectData(int dataSourceId,
java.lang.String address,
java.lang.String mask)
CollectorThis 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.
collectData in class CollectordataSourceId - 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 void loadData(int source)
public void configureCollector(java.lang.String[] args)
throws CollectorException
CollectorExceptionpublic void loadFirstRun()