Alcatel5620SamCollector (ITNM Collector Framework v4.2 FP24 API)

java.lang.Object
- com.ibm.tivoli.nm.collectors.framework.collector.Collector
- - com.ibm.tivoli.nm.collectors.impl.alcatel5620sam.Alcatel5620SamCollector

```
public class Alcatel5620SamCollector
extends Collector
```
The main class for the Alcatel 5620 SAM collector. This class performs all the preliminary work to start the collector, initialize dependencies, connect to the EMS, run the embedded server, and respond to RPC calls.

Author:

Khalid Alqinyah

Field Summary

Fields
Modifier and Type Field and Description

static int DATASOURCE_ID
- Fields inherited from class com.ibm.tivoli.nm.collectors.framework.collector.Collector
  collectData, collectorDescription, collectorName, collectorPort, dataStore, propsFileName, running

Fields
Modifier and Type	Field and Description
`static int`	`DATASOURCE_ID`

Constructor Summary

Constructors
Constructor and Description
`Alcatel5620SamCollector(java.lang.String collectorName, java.lang.String collectorDescription)` Initialize the collector, connect the EMS, and initialize dependencies

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`collectData()` Takes the device id and perform the necessary loading calls
`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`	`deleteDeviceData(int dataSourceId, java.lang.Object[] deviceArray, java.lang.String reloadType)` Delete device specific data in collector data store
`java.lang.String`	`GetAmfData(int dataSourceId, java.lang.String deviceId)` Get AMF data for a given device.
`static java.util.Map<java.lang.String,java.lang.Integer>`	`getDeviceChanges()`
`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`	`GetENodeBData(int dataSourceId, java.lang.String deviceId)` Get ENodeB data for a given device.
`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.
`static int`	`getlAttempts()`
`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, 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`	`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`	`GetMmeData(int dataSourceId, java.lang.String deviceId)` Get MME data for a given device.
`java.lang.String`	`GetMplsInterfaces(int dataSourceId, java.lang.String deviceId)` Optional - Get a list of MPLS interfaces for a given device
`static boolean`	`getNowPrimary()`
`static boolean`	`getNowSecondary()`
`static java.lang.String`	`getPassword()`
`java.lang.String`	`GetPcrfData(int dataSourceId, java.lang.String deviceId)` Get PCRF data for a given device.
`java.lang.String`	`GetPgwData(int dataSourceId, java.lang.String deviceId)` Get PGW data for a given device.
`static java.lang.String`	`getPrimaryHost()`
`static java.lang.String`	`getPrimaryPort()`
`java.lang.String`	`GetSAEGatewayData(int dataSourceId, java.lang.String deviceId)` Get SAEGateway data for a given device.
`static java.lang.String`	`getSecondaryHost()`
`static java.lang.String`	`getSecondaryPort()`
`java.lang.String`	`GetSgwData(int dataSourceId, java.lang.String deviceId)` Get SGW data for a given device.
`java.lang.String`	`GetSmfData(int dataSourceId, java.lang.String deviceId)`
`java.lang.String`	`GetUpfData(int dataSourceId, java.lang.String deviceId)`
`static void`	`increaselAttempts()`
`protected void`	`initialiseDataStore()` Initialise the data store.
`void`	`initializeConnectionManager(java.lang.Boolean connectSecondary, java.lang.Boolean jmsTriggered)`
`static boolean`	`isDbSwitch()`
`static boolean`	`isHaEnabled()`
`static boolean`	`isInitGetDeviceInfoLoad()`
`static boolean`	`isInitGetENBDataLoad()`
`static boolean`	`isInitGetENBDeviceLoad()`
`static boolean`	`isInitGetEntitiesLoad()`
`static boolean`	`isInitGetEpcLoad()`
`static boolean`	`isInitGetInventoryLoad()`
`static boolean`	`isInitGetLayer2ConnectionsLoad()`
`static boolean`	`isInitGetLayer3VpnsLoad()`
`static boolean`	`isInitGetMmeLoad()`
`static boolean`	`isInitGetMplsIntLoad()`
`static boolean`	`isInitGetPcrfLoad()`
`static boolean`	`isInitGetVllVpnsLoad()`
`static boolean`	`isInitGetVplsVpnsLoad()`
`static boolean`	`isInitLteConnectionLoad()`
`static boolean`	`isInitLteInterfacesLoad()`
`static boolean`	`isInitRANBackHaulLoad()`
`static void`	`main(java.lang.String[] args)`
`void`	`reloadLayer2Vpns(int dataSourceId)` Reload VLL interfaces for partial discovery
`void`	`reloadLayer3Vpns(int dataSourceId)` Delete and reload Layer 3 VPN for partial discovery on per device basis.
`void`	`reloadMplsInterface(int dataSourceId)` Reload MPLS interfaces for partial discovery
`void`	`reloadPhysicalEntities(int dataSourceId)` Reload physical entities for partial discovery
`static void`	`setDbSwitch(boolean dbSwitch)`
`static void`	`setInitGetAmfLoad(boolean initGetAmfLoad)`
`static void`	`setInitGetCloudMmeLoad(boolean initGetCloudMmeLoad)`
`static void`	`setInitGetDeviceInfoLoad(boolean initGetDeviceInfoLoad)`
`static void`	`setInitGetENBDataLoad(boolean initGetENBDataLoad)`
`static void`	`setInitGetENBDeviceLoad(boolean initGetENBDeviceLoad)`
`static void`	`setInitGetEntitiesLoad(boolean initGetEntitiesLoad)`
`static void`	`setInitGetEpcLoad(boolean initGetEpcLoad)`
`static void`	`setInitGetInventoryLoad(boolean initGetInventoryLoad)`
`static void`	`setInitGetLayer2ConnectionsLoad(boolean initGetLayer2ConnectionsLoad)`
`static void`	`setInitGetLayer3VpnsLoad(boolean initGetLayer3VpnsLoad)`
`static void`	`setInitGetMmeLoad(boolean initGetMmeLoad)`
`static void`	`setInitGetMMETAILoad(boolean initGetMMETAILoad)`
`static void`	`setInitGetMplsIntLoad(boolean initGetMplsIntLoad)`
`static void`	`setInitGetPcrfLoad(boolean initGetPcrfLoad)`
`static void`	`setInitGetServiceIPLoad(boolean initGetServiceIPLoad)`
`static void`	`setInitGetSmfLoad(boolean initGetSmfLoad)`
`static void`	`setInitGetSubnetLoad(boolean initGetSubnetLoad)`
`static void`	`setInitGetUpfLoad(boolean initGetUpfLoad)`
`static void`	`setInitGetVllVpnsLoad(boolean initGetVllVpnsLoad)`
`static void`	`setInitGetVplsVpnsLoad(boolean initGetVplsVpnsLoad)`
`static void`	`setInitLteConnectionLoad(boolean initLteConnectionLoad)`
`static void`	`setInitLteInterfacesLoad(boolean initLteInterfacesLoad)`
`static void`	`setInitLteSgiConnectionLoad(boolean initLteSgiConnectionLoad)`
`static void`	`setInitRANBackHaulLoad(boolean initRANBackHaulLoad)`
`static void`	`setlAttempts(int lAttempts)`
`static void`	`setNowPrimary(boolean nowPrimary)`
`static void`	`setNowSecondary(boolean nowSecondary)`
`static void`	`setPassword(java.lang.String password)`
`static void`	`setPrimaryHost(java.lang.String primaryHost)`
`static void`	`setPrimaryPort(java.lang.String primaryPort)`
`static void`	`setReloadLayer2Connection(boolean reloadLayer2Connection)`
`static void`	`setSecondaryHost(java.lang.String secondaryHost)`
`static void`	`setSecondaryPort(java.lang.String secondaryPort)`
`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, GetAssociatedAddresses, GetAssociatedAddresses, GetAusfData, getCommandLineArgument, GetConnections, GetConnections, GetDeviceInfo, GetDeviceInfo, GetDeviceList, GetEirData, GetEntities, GetGNodeBData, GetHssData, GetInfo, GetInventory, GetLayer1Connections, GetLayer1Connections, GetLayer2Connections, GetLayer2Vpns, GetLayer3Connections, GetLayer3Connections, GetLayer3Vpns, GetMplsInterfaces, GetNefData, GetNrfData, GetNssfData, GetPcfData, getPortNumberArgument, getPropertiesFileNameArgument, getPropertyValue, GetRanData, GetUdmData, 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

- Field Detail
  - DATASOURCE_ID
```
public static final int DATASOURCE_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Alcatel5620SamCollector
```
public Alcatel5620SamCollector(java.lang.String collectorName,
                               java.lang.String collectorDescription)
                        throws SOAPException
```
    Initialize the collector, connect the EMS, and initialize dependencies
    
    Parameters:
    
    collectorName - The name of the collector
    
    collectorDescription - A description for the collector
    
    Throws:
    
    SOAPException - If EMS connection fails
    
    CollectorException
- Method Detail
  - getPassword
```
public static java.lang.String getPassword()
```
  - isHaEnabled
```
public static boolean isHaEnabled()
```
  - isDbSwitch
```
public static boolean isDbSwitch()
```
  - setDbSwitch
```
public static void setDbSwitch(boolean dbSwitch)
```
  - getlAttempts
```
public static int getlAttempts()
```
  - setlAttempts
```
public static void setlAttempts(int lAttempts)
```
  - increaselAttempts
```
public static void increaselAttempts()
```
  - isInitGetDeviceInfoLoad
```
public static boolean isInitGetDeviceInfoLoad()
```
  - getDeviceChanges
```
public static java.util.Map<java.lang.String,java.lang.Integer> getDeviceChanges()
```
  - setInitGetDeviceInfoLoad
```
public static void setInitGetDeviceInfoLoad(boolean initGetDeviceInfoLoad)
```
  - isInitGetInventoryLoad
```
public static boolean isInitGetInventoryLoad()
```
  - setInitGetInventoryLoad
```
public static void setInitGetInventoryLoad(boolean initGetInventoryLoad)
```
  - isInitGetEntitiesLoad
```
public static boolean isInitGetEntitiesLoad()
```
  - setInitGetEntitiesLoad
```
public static void setInitGetEntitiesLoad(boolean initGetEntitiesLoad)
```
  - isInitGetMplsIntLoad
```
public static boolean isInitGetMplsIntLoad()
```
  - setInitGetMplsIntLoad
```
public static void setInitGetMplsIntLoad(boolean initGetMplsIntLoad)
```
  - isInitGetLayer2ConnectionsLoad
```
public static boolean isInitGetLayer2ConnectionsLoad()
```
  - setInitGetLayer2ConnectionsLoad
```
public static void setInitGetLayer2ConnectionsLoad(boolean initGetLayer2ConnectionsLoad)
```
  - isInitGetVllVpnsLoad
```
public static boolean isInitGetVllVpnsLoad()
```
  - setInitGetVllVpnsLoad
```
public static void setInitGetVllVpnsLoad(boolean initGetVllVpnsLoad)
```
  - isInitGetVplsVpnsLoad
```
public static boolean isInitGetVplsVpnsLoad()
```
  - setInitGetVplsVpnsLoad
```
public static void setInitGetVplsVpnsLoad(boolean initGetVplsVpnsLoad)
```
  - isInitGetLayer3VpnsLoad
```
public static boolean isInitGetLayer3VpnsLoad()
```
  - setInitGetLayer3VpnsLoad
```
public static void setInitGetLayer3VpnsLoad(boolean initGetLayer3VpnsLoad)
```
  - isInitGetENBDeviceLoad
```
public static boolean isInitGetENBDeviceLoad()
```
  - setInitGetENBDeviceLoad
```
public static void setInitGetENBDeviceLoad(boolean initGetENBDeviceLoad)
```
  - isInitGetENBDataLoad
```
public static boolean isInitGetENBDataLoad()
```
  - setInitGetENBDataLoad
```
public static void setInitGetENBDataLoad(boolean initGetENBDataLoad)
```
  - isInitGetMmeLoad
```
public static boolean isInitGetMmeLoad()
```
  - setInitGetMmeLoad
```
public static void setInitGetMmeLoad(boolean initGetMmeLoad)
```
  - isInitGetEpcLoad
```
public static boolean isInitGetEpcLoad()
```
  - setInitGetEpcLoad
```
public static void setInitGetEpcLoad(boolean initGetEpcLoad)
```
  - isInitGetPcrfLoad
```
public static boolean isInitGetPcrfLoad()
```
  - setInitGetPcrfLoad
```
public static void setInitGetPcrfLoad(boolean initGetPcrfLoad)
```
  - isInitLteInterfacesLoad
```
public static boolean isInitLteInterfacesLoad()
```
  - setInitLteInterfacesLoad
```
public static void setInitLteInterfacesLoad(boolean initLteInterfacesLoad)
```
  - isInitLteConnectionLoad
```
public static boolean isInitLteConnectionLoad()
```
  - setInitLteConnectionLoad
```
public static void setInitLteConnectionLoad(boolean initLteConnectionLoad)
```
  - isInitRANBackHaulLoad
```
public static boolean isInitRANBackHaulLoad()
```
  - setInitRANBackHaulLoad
```
public static void setInitRANBackHaulLoad(boolean initRANBackHaulLoad)
```
  - setReloadLayer2Connection
```
public static void setReloadLayer2Connection(boolean reloadLayer2Connection)
```
  - 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>
  - collectData
```
public 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
  - reloadPhysicalEntities
```
public void reloadPhysicalEntities(int dataSourceId)
```
    Reload physical entities for partial discovery
    
    Parameters:
    
    dataSourceId - Collector data source id
  - reloadMplsInterface
```
public void reloadMplsInterface(int dataSourceId)
```
    Reload MPLS interfaces for partial discovery
    
    Parameters:
    
    dataSourceId - Collector data source id
  - reloadLayer2Vpns
```
public void reloadLayer2Vpns(int dataSourceId)
```
    Reload VLL interfaces for partial discovery
    
    Parameters:
    
    dataSourceId - Collector data source id
  - reloadLayer3Vpns
```
public void reloadLayer3Vpns(int dataSourceId)
```
    Delete and reload Layer 3 VPN for partial discovery on per device basis. The collector will only delete and reload devices that has changes since last full or partial discovery. The device list is populated based from the JMS message from SAM 5620.
    
    Parameters:
    
    dataSourceId - Collector data source id
  - deleteDeviceData
```
public void deleteDeviceData(int dataSourceId,
                             java.lang.Object[] deviceArray,
                             java.lang.String reloadType)
```
    Delete device specific data in collector data store
    
    Parameters:
    
    deviceId - The id of the device to load data for, or null to load all devices
  - collectData
```
public void collectData()
```
    Takes the device id and perform the necessary loading calls
    
    Parameters:
    
    deviceId - The id of the device to load data for, or null to load all devices
  - GetDeviceInfo
```
public java.lang.String GetDeviceInfo(int dataSourceId,
                                      java.lang.String deviceId)
```
    Description copied from class: Collector
    
    The Collector implementation of GetDeviceInfo() is responsible for gathering and returning basic device level information for a specified device and data source.
    Overrides:
    
    GetDeviceInfo in class Collector
    
    Parameters:
    
    dataSourceId - The ID for the data source
    
    deviceId - The ID for the device
    
    Returns:
    An XML String describing the device e.g.
    <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>
  - GetInventory
```
public java.lang.String GetInventory(int dataSourceId,
                                     java.lang.String deviceId)
```
    Description copied from class: Collector
    
    Optional - The Collector implementation of GetInventory() is responsible for gathering and returning device interface information for a specified device id and data source.
    Overrides:
    
    GetInventory in class Collector
    
    Parameters:
    
    dataSourceId - The ID for the data source
    
    deviceId - The ID for the device
    
    Returns:
    An XML String listing interfaces for a given device, e.g.
    <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>
  - GetMplsInterfaces
```
public java.lang.String GetMplsInterfaces(int dataSourceId,
                                          java.lang.String deviceId)
```
    Description copied from class: Collector
    
    Optional - Get a list of MPLS interfaces for a given device
    Overrides:
    
    GetMplsInterfaces in class Collector
    
    Parameters:
    
    dataSourceId - The ID of the data source
    
    deviceId - The ID of the device
    
    Returns:
    An XML String listing all the MPLS interfaces for a given device e.g.
    <mplsInterfaceData> <deviceId>10.1.1.1</deviceId> <interfaceList> <interface> <ifIndex>1</ifIndex> </interface> </interfaceList> </mplsInterfaceData>
  - GetLayer2Connections
```
public java.lang.String GetLayer2Connections(int dataSourceId,
                                             java.lang.String deviceId)
```
    Description copied from class: Collector
    
    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.
    Overrides:
    
    GetLayer2Connections in class Collector
    
    Parameters:
    
    dataSourceId - The ID of the data source
    
    deviceId - The ID of the device
    
    Returns:
    An XML String describing all layer 2 connections for the device e.g.
    <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>
  - GetEntities
```
public java.lang.String GetEntities(int dataSourceId,
                                    java.lang.String deviceId)
```
    Description copied from class: Collector
    
    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.
    Overrides:
    
    GetEntities in class Collector
    
    Parameters:
    
    dataSourceId - The ID for the data source
    
    deviceId - The ID for the device
    
    Returns:
    An XML String listing all the entities for a given device e.g.
    <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>
  - GetLayer2Vpns
```
public java.lang.String GetLayer2Vpns(int dataSourceId,
                                      java.lang.String deviceId)
```
    Description copied from class: Collector
    
    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.
    Overrides:
    
    GetLayer2Vpns in class Collector
    
    Parameters:
    
    dataSourceId - The ID of the data source
    
    deviceId - The ID of the device
    
    Returns:
    An XML String listing all layer 2 VPNs configured on a given device e.g.
    <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>
  - GetLayer3Vpns
```
public java.lang.String GetLayer3Vpns(int dataSourceId,
                                      java.lang.String deviceId)
```
    Description copied from class: Collector
    
    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.
    Overrides:
    
    GetLayer3Vpns in class Collector
    
    Parameters:
    
    dataSourceId - The ID of the data source
    
    deviceId - The ID of the device
    
    Returns:
    An XML String listing all layer 3 VPNs configured on a given device e.g.
    <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>
  - 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 N5gDataStore 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
  - GetAmfData
```
public java.lang.String GetAmfData(int dataSourceId,
                                   java.lang.String deviceId)
```
    Get AMF data for a given device. Implements the gRPC method for GetAmfData() required by the LTE agent. Returns an XML string that represents a ENodeB entity data. Use N5gDataStore to generate the XML String.
    
    Overrides:
    
    GetAmfData 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
  - GetSmfData
```
public java.lang.String GetSmfData(int dataSourceId,
                                   java.lang.String deviceId)
```
    Overrides:
    
    GetSmfData in class Collector
  - GetUpfData
```
public java.lang.String GetUpfData(int dataSourceId,
                                   java.lang.String deviceId)
```
    Overrides:
    
    GetUpfData in class Collector
  - GetMmeData
```
public java.lang.String GetMmeData(int dataSourceId,
                                   java.lang.String deviceId)
```
    Get MME data for a given device. Implements the XML-RPC method for GetMmeData() required by the LTE agent. Returns an XML string that represents a MME entity data. Use N5gDataStore to generate the XML String.
    
    Overrides:
    
    GetMmeData 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
  - GetPgwData
```
public java.lang.String GetPgwData(int dataSourceId,
                                   java.lang.String deviceId)
```
    Get PGW data for a given device. Implements the XML-RPC method for GetMmeData() required by the LTE agent. Returns an XML string that represents a PGW entity data. Use N5gDataStore to generate the XML String.
    
    Overrides:
    
    GetPgwData 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
  - GetSgwData
```
public java.lang.String GetSgwData(int dataSourceId,
                                   java.lang.String deviceId)
```
    Get SGW data for a given device. Implements the XML-RPC method for GetSgwData() required by the LTE agent. Returns an XML string that represents a SGW entity data. Use N5gDataStore to generate the XML String.
    
    Overrides:
    
    GetSgwData 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
  - GetSAEGatewayData
```
public java.lang.String GetSAEGatewayData(int dataSourceId,
                                          java.lang.String deviceId)
```
    Get SAEGateway data for a given device. Implements the XML-RPC method for GetSAEGateway() required by the LTE agent. Returns an XML string that represents a SAEGateway entity data. Use N5gDataStore to generate the XML String.
    
    Overrides:
    
    GetSAEGatewayData 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
  - GetPcrfData
```
public java.lang.String GetPcrfData(int dataSourceId,
                                    java.lang.String deviceId)
```
    Get PCRF data for a given device. Implements the XML-RPC method for GetPcrfData() required by the LTE agent. Returns an XML string that represents a PCRF entity data. Use N5gDataStore to generate the XML String.
    
    Overrides:
    
    GetPcrfData 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
  - initializeConnectionManager
```
public void initializeConnectionManager(java.lang.Boolean connectSecondary,
                                        java.lang.Boolean jmsTriggered)
                                 throws SOAPException
```
    Throws:
    
    SOAPException
  - main
```
public static void main(java.lang.String[] args)
```
    Parameters:
    
    args -
    
    Throws:
    
    CollectorException
  - getNowPrimary
```
public static boolean getNowPrimary()
```
  - setNowPrimary
```
public static void setNowPrimary(boolean nowPrimary)
```
  - getNowSecondary
```
public static boolean getNowSecondary()
```
  - setNowSecondary
```
public static void setNowSecondary(boolean nowSecondary)
```
  - getPrimaryHost
```
public static java.lang.String getPrimaryHost()
```
  - getPrimaryPort
```
public static java.lang.String getPrimaryPort()
```
  - getSecondaryHost
```
public static java.lang.String getSecondaryHost()
```
  - getSecondaryPort
```
public static java.lang.String getSecondaryPort()
```
  - setInitGetCloudMmeLoad
```
public static void setInitGetCloudMmeLoad(boolean initGetCloudMmeLoad)
```
  - setInitGetServiceIPLoad
```
public static void setInitGetServiceIPLoad(boolean initGetServiceIPLoad)
```
  - setInitGetSubnetLoad
```
public static void setInitGetSubnetLoad(boolean initGetSubnetLoad)
```
  - setInitGetMMETAILoad
```
public static void setInitGetMMETAILoad(boolean initGetMMETAILoad)
```
  - setInitLteSgiConnectionLoad
```
public static void setInitLteSgiConnectionLoad(boolean initLteSgiConnectionLoad)
```
  - setPrimaryHost
```
public static void setPrimaryHost(java.lang.String primaryHost)
```
  - setPrimaryPort
```
public static void setPrimaryPort(java.lang.String primaryPort)
```
  - setSecondaryHost
```
public static void setSecondaryHost(java.lang.String secondaryHost)
```
  - setSecondaryPort
```
public static void setSecondaryPort(java.lang.String secondaryPort)
```
  - setPassword
```
public static void setPassword(java.lang.String password)
```
  - setInitGetAmfLoad
```
public static void setInitGetAmfLoad(boolean initGetAmfLoad)
```
  - setInitGetSmfLoad
```
public static void setInitGetSmfLoad(boolean initGetSmfLoad)
```
  - setInitGetUpfLoad
```
public static void setInitGetUpfLoad(boolean initGetUpfLoad)
```

Class Alcatel5620SamCollector

Field Summary

Fields inherited from class com.ibm.tivoli.nm.collectors.framework.collector.Collector

Constructor Summary

Method Summary

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.collector.Collector

Methods inherited from class java.lang.Object

Field Detail

DATASOURCE_ID

Constructor Detail

Alcatel5620SamCollector

Method Detail

getPassword

isHaEnabled

isDbSwitch

setDbSwitch

getlAttempts

setlAttempts

increaselAttempts

isInitGetDeviceInfoLoad

getDeviceChanges

setInitGetDeviceInfoLoad

isInitGetInventoryLoad

setInitGetInventoryLoad

isInitGetEntitiesLoad

setInitGetEntitiesLoad

isInitGetMplsIntLoad

setInitGetMplsIntLoad

isInitGetLayer2ConnectionsLoad

setInitGetLayer2ConnectionsLoad

isInitGetVllVpnsLoad

setInitGetVllVpnsLoad

isInitGetVplsVpnsLoad

setInitGetVplsVpnsLoad

isInitGetLayer3VpnsLoad

setInitGetLayer3VpnsLoad

isInitGetENBDeviceLoad

setInitGetENBDeviceLoad

isInitGetENBDataLoad

setInitGetENBDataLoad

isInitGetMmeLoad

setInitGetMmeLoad

isInitGetEpcLoad

setInitGetEpcLoad

isInitGetPcrfLoad

setInitGetPcrfLoad

isInitLteInterfacesLoad

setInitLteInterfacesLoad

isInitLteConnectionLoad

setInitLteConnectionLoad

isInitRANBackHaulLoad

setInitRANBackHaulLoad

setReloadLayer2Connection

initialiseDataStore

UpdateData

collectData

reloadPhysicalEntities

reloadMplsInterface

reloadLayer2Vpns

reloadLayer3Vpns

deleteDeviceData

collectData

GetDeviceInfo

GetInventory

GetMplsInterfaces

GetLayer2Connections

GetEntities

GetLayer2Vpns

GetLayer3Vpns

GetENodeBData

GetAmfData

GetSmfData

GetUpfData

GetMmeData

GetPgwData

GetSgwData

GetSAEGatewayData

GetPcrfData

initializeConnectionManager

main