com.ibm.tivoli.nm.collectors.framework.store

Class N5gDataStore

java.lang.Object

com.ibm.tivoli.nm.collectors.framework.store.DataStore

com.ibm.tivoli.nm.collectors.framework.store.RANDataStore

com.ibm.tivoli.nm.collectors.framework.store.LTEDataStore

com.ibm.tivoli.nm.collectors.framework.store.N5gDataStore

All Implemented Interfaces:

CollectorDataStore

public class N5gDataStore
extends LTEDataStore

In memory data store implementation for holding 5G specific data for the ITNM java collector framework. The 5G data store has methods to aid in adding 5G specific data for various devices, such as GNodeB

The add methods not only add add a device to the store, but also add 5G specific data as defined by the 5G NCIM tables. For example, addGNodeB(int dataSourceId, String deviceId, String parentChassisId, String parentChassisDn) adds a device representing an gNodeB to the store. GNodeB data is retrieved from the getGNodeBData(int, String) invocation.

Author:

Mustafa Muzafar

Field Summary

Fields inherited from class com.ibm.tivoli.nm.collectors.framework.store.DataStore

collectorDescription, collectorName, dataSources, readLock, rwLock, writeLock

Constructor Summary

Constructors

Constructor and Description
N5gDataStore(java.lang.String collectorName, java.lang.String collectorDescription) Create a data store for holding 5G data

Method Summary

Modifier and Type	Method and Description
void	add5GAntennaSerial(N5gNRSector parent, java.lang.String serial) Adds an antenna serial number to an Sector's list
void	add5gConnection(N5gFunction parent, N5gFunction.eConnectionType type, java.lang.String nbrName, java.util.Map<java.lang.String,java.lang.Object> data) Adds a connection to an 5G function
void	add5GInterface(N5gFunction parent, java.lang.String ipAddress, java.util.Map<java.lang.String,java.lang.Object> data) Adds an Interface to an 5G function
N5gAF	addAF(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a AF to store
N5gAMF	addAMF(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a AMF to store
LTEAntennaFunction	addAntennaFunction(N5gGNBFunction parent, java.lang.String antennaSerial, java.util.Map<java.lang.String,java.lang.Object> data) Creates and adds an Antenna function to an N5gGNBFunction
N5gAUSF	addAUSF(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a AUSF to store
void	addConnectedMME(N5gGNBFunction parent, java.lang.String mmeName, java.util.Map<java.lang.String,java.lang.Object> data) Adds an mme connection to an ENBFunction
void	addConnectedSGW(N5gGNBFunction parent, java.lang.String sgwName, java.util.Map<java.lang.String,java.lang.Object> data) Adds an SGW connection to an GNBFunction
void	addE1Neighbour(N5gGNBFunction parent, java.lang.String adjGNBId, java.util.Map<java.lang.String,java.lang.Object> data)
void	addF1CNeighbour(N5gGNBFunction parent, java.lang.String adjGNBId, java.util.Map<java.lang.String,java.lang.Object> data)
void	addF1UNeighbour(N5gGNBFunction parent, java.lang.String adjGNBId, java.util.Map<java.lang.String,java.lang.Object> data)
N5gGNodeB	addGNodeB(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a gNodeB to store
N5gNEF	addNEF(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a NEF to store
N5gLogicalElement	addNRCell(N5gLogicalElement.eLogicalType type, N5gGNBFunction parent, java.lang.String cellId, java.util.Map<java.lang.String,java.lang.Object> data) Adds a eUtranCell to an ENBFunction
N5gNRF	addNRF(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a NRF to store
N5gNRSector	addNRSectorCarrier(N5gGNBFunction parent, java.lang.String sectorId, java.util.Map<java.lang.String,java.lang.Object> data) Adds a eUtranSector to an N5gGNBFunction
N5gNSSF	addNSSF(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a NSSF to store
N5gPCF	addPCF(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a PCF to store
void	addPlmn(N5gGNBFunction parent, java.util.Map<java.lang.String,java.lang.Object> data) Adds a Plmn to a GNB function
void	addSectorId(LTEAntennaFunction parent, java.lang.String sectorId) Adds a sectorId to the an Antenna's list
N5gSMF	addSMF(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a SMF to store
N5gUDM	addUDM(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a UDM to store
N5gUPF	addUPF(int dataSourceId, java.lang.String deviceId, java.lang.String parentChassisId, java.lang.String parentChassisDn) Add a UPF to store
void	addX2CNeighbour(N5gGNBFunction parent, java.lang.String adjGNBId, java.util.Map<java.lang.String,java.lang.Object> data) Adds an x2CNeighbour connection to an GNBFunction
void	addX2Neighbour(N5gGNBFunction parent, java.lang.String adjENBId, java.util.Map<java.lang.String,java.lang.Object> data) Adds an x2Neighbour connection to an GNBFunction
void	addX2UNeighbour(N5gGNBFunction parent, java.lang.String adjGNBId, java.util.Map<java.lang.String,java.lang.Object> data) Adds an x2CNeighbour connection to an GNBFunction
java.lang.String	getAFData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given SMF device
java.lang.String	getAMFData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given AMF device
java.lang.String	getAUSFData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given SMF device
java.lang.String	getGNodeBData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given GNodeB device
java.lang.String	getNEFData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given SMF device
java.lang.String	getNRFData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given SMF device
java.lang.String	getNSSFData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given SMF device
java.lang.String	getPCFData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given SMF device
java.lang.String	getSMFData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given SMF device
java.lang.String	getUDMData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given SMF device
java.lang.String	getUPFData(int dataSourceId, java.lang.String deviceId) Get an XML representation of all data stored in the data store for a given SMF device

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.store.LTEDataStore

addAntennaFunction, addAntennaSerial, addConnectedMME, addConnectedSGW, addConnection, addConnection, addConnection, addConnection, addConnection, addConnection, addConnection, addConnection, addEIR, addEIRFunction, addENodeB, addENodeBFunction, addEUtranCell, addEUtranSector, addGBTSFunction, addHSS, addHSSFunction, addListIteratorXML, addListIteratorXMLNoItemTags, addLTEInterface, addLTEInterface, addLTEInterface, addLTEInterface, addLTEInterface, addLTEInterface, addLTEInterface, addLTEInterface, addMME, addMMEFunction, addNodeBFunction, addPCRF, addPCRFFunction, addPGW, addPGWFunction, addPGWFunction, addPlmn, addPlmn, addPlmn, addPlmn, addPlmn, addPlmn, addPlmn, addPlmn, addSAEGateway, addSAEGatewayFunction, addSGW, addSGWFunction, addSGWFunction, addX2Neighbour, getEIRData, getENodeBData, getHSSData, getMMEData, getPCRFData, getPGWData, getSAEData, getSAEGatewayData, getSGWData

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.store.RANDataStore

addBaseStation, addBaseStationController, addGBTSCell, addGbtsGLocalCell, addGGSN, addGSMCell, addGTRXGroup, addLocationInformation, addMediaGateway, addMobileSwitchingCentre, addMSS, addMultiplexer, addNodeB, addNodeBLocalCell, addPacketControlUnit, addRadioNetworkController, addRANConnection, addRANConnection, addSector, addSGSN, addTransceiver, addUtranCell, appendGbtsData, appendRanData, associate, generateRANEntityName, getGBTSDataAsFunctionList, getNodeBLocalCellName, getRANData, getRANDataAsFunctionList, getTransceiverName

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.store.DataStore

addAssociatedAddress, addConnection, addDataSource, addDataSource, addDataSource, addDeviceData, addEntity, addGeographicLocation, addInterface, addL2Vpn, addL3Vpn, addL3VpnInterface, addL3VpnRouteTarget, addLayer1Connection, addLayer2Connection, addLayer3Connection, addLsp, addMplsInterface, deviceCollects, deviceCollects, deviceDependency, deviceDependency, deviceHosts, getAssociatedAddresses, getAssociatedAddresses, getCollectorDescription, getCollectorName, getConnections, getConnections, getDataSource, getDataSources, getDeviceInfo, getDeviceInfo, getDeviceInfo, getDeviceList, getDeviceList, getDeviceList, getDeviceName, getDeviceName, getEntities, getEntities, getInfo, getInterfaceName, getInterfaceName, getInventory, getInventory, getLayer1Connections, getLayer1Connections, getLayer2Connections, getLayer2Connections, getLayer2Vpns, getLayer2Vpns, getLayer3Connections, getLayer3Connections, getLayer3Vpns, getLayer3Vpns, getMplsInterfaces, getMplsInterfaces, interfaceCollects, interfaceCollects, interfaceDependency, interfaceDependency, interfaceHosts, removeAllDeviceData, removeDataSource, removeDeviceData, removeDeviceEntityData, removeDeviceInterfaceData, removeDeviceLayer2ConnectionData, removeDeviceLayer2VpnData, removeDeviceLayer3VpnData, removeDeviceMplsData, resolveAssociatedAddresses, resolveAssociatedAddresses, setCollectorDescription, setCollectorName

Methods inherited from class java.lang.Object

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

Constructor Detail

N5gDataStore

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

Create a data store for holding 5G data

Parameters:

collectorName - The name of the collector

collectorDescription - A description of the collector

Method Detail

getGNodeBData

public java.lang.String getGNodeBData(int dataSourceId,
                                      java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given GNodeB device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the GNodeB

Returns:

An XML string representing the LTE data for this GNodeB

addGNodeB

public N5gGNodeB addGNodeB(int dataSourceId,
                           java.lang.String deviceId,
                           java.lang.String parentChassisId,
                           java.lang.String parentChassisDn)
                    throws CollectorException

Add a gNodeB to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the eNodeB

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gGNodeB

Throws:

CollectorException

addPlmn

public void addPlmn(N5gGNBFunction parent,
                    java.util.Map<java.lang.String,java.lang.Object> data)

Adds a Plmn to a GNB function

Parameters:

parent - The GNBFunction to add to

data - all plmn data

addX2Neighbour

public void addX2Neighbour(N5gGNBFunction parent,
                           java.lang.String adjENBId,
                           java.util.Map<java.lang.String,java.lang.Object> data)

Adds an x2Neighbour connection to an GNBFunction

Parameters:

parent - The GNBFunction to add to

adjENBId - The remote eNodeB

data - All other connection info

addX2CNeighbour

public void addX2CNeighbour(N5gGNBFunction parent,
                            java.lang.String adjGNBId,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Adds an x2CNeighbour connection to an GNBFunction

Parameters:

parent - The GNBFunction to add to

adjENBId - The remote gNodeB

data - All other connection info

addX2UNeighbour

public void addX2UNeighbour(N5gGNBFunction parent,
                            java.lang.String adjGNBId,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Adds an x2CNeighbour connection to an GNBFunction

Parameters:

parent - The GNBFunction to add to

adjENBId - The remote gNodeB

data - All other connection info

addConnectedSGW

public void addConnectedSGW(N5gGNBFunction parent,
                            java.lang.String sgwName,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Adds an SGW connection to an GNBFunction

Parameters:

parent - The GNBFunction to add to

sgwName - Name of nbr SGW

data - All other connection info

addE1Neighbour

public void addE1Neighbour(N5gGNBFunction parent,
                           java.lang.String adjGNBId,
                           java.util.Map<java.lang.String,java.lang.Object> data)

addF1CNeighbour

public void addF1CNeighbour(N5gGNBFunction parent,
                            java.lang.String adjGNBId,
                            java.util.Map<java.lang.String,java.lang.Object> data)

addF1UNeighbour

public void addF1UNeighbour(N5gGNBFunction parent,
                            java.lang.String adjGNBId,
                            java.util.Map<java.lang.String,java.lang.Object> data)

addAntennaFunction

public LTEAntennaFunction addAntennaFunction(N5gGNBFunction parent,
                                             java.lang.String antennaSerial,
                                             java.util.Map<java.lang.String,java.lang.Object> data)

Creates and adds an Antenna function to an N5gGNBFunction

Parameters:

parent - The N5gGNBFunction to add to

antennaSerial - The unique antenna Identifier

data - All other antenna info

Returns:

A reference to the newly created LTEAntennaFunction

add5GInterface

public void add5GInterface(N5gFunction parent,
                           java.lang.String ipAddress,
                           java.util.Map<java.lang.String,java.lang.Object> data)

Adds an Interface to an 5G function

Parameters:

parent - The 5gFunction to add to

ipAddress - ipAddress of interface

data - all other interface data

addNRCell

public N5gLogicalElement addNRCell(N5gLogicalElement.eLogicalType type,
                                   N5gGNBFunction parent,
                                   java.lang.String cellId,
                                   java.util.Map<java.lang.String,java.lang.Object> data)

Adds a eUtranCell to an ENBFunction

Parameters:

parent - The ENBFunction to add to

cellId - The unique cell Identifier

data - All other eUtranCell info

Returns:

A reference to the newly created LTEeUtranCell

addNRSectorCarrier

public N5gNRSector addNRSectorCarrier(N5gGNBFunction parent,
                                      java.lang.String sectorId,
                                      java.util.Map<java.lang.String,java.lang.Object> data)

Adds a eUtranSector to an N5gGNBFunction

Parameters:

parent - The N5gGNBFunction to add to

sectorId - The unique sector Identifier

data - All other eUtranSector info

Returns:

A reference to the newly created LTEeUtranSector

addSectorId

public void addSectorId(LTEAntennaFunction parent,
                        java.lang.String sectorId)

Adds a sectorId to the an Antenna's list

Overrides:

addSectorId in class LTEDataStore

Parameters:

parent - The Antenna to add to

sectorId - The sectorId

addConnectedMME

public void addConnectedMME(N5gGNBFunction parent,
                            java.lang.String mmeName,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Adds an mme connection to an ENBFunction

Parameters:

parent - The ENBFunction to add to

mmeName - Name of nbr MME

data - All other connection info

add5GAntennaSerial

public void add5GAntennaSerial(N5gNRSector parent,
                               java.lang.String serial)

Adds an antenna serial number to an Sector's list

Parameters:

parent - The Sector to add to

serial - The serial number

add5gConnection

public void add5gConnection(N5gFunction parent,
                            N5gFunction.eConnectionType type,
                            java.lang.String nbrName,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Adds a connection to an 5G function

Parameters:

parent - The 5gFunction to add to

eConnectionType - connection Type

nbrName - connected neighbor name

data - all other connection data

addAMF

public N5gAMF addAMF(int dataSourceId,
                     java.lang.String deviceId,
                     java.lang.String parentChassisId,
                     java.lang.String parentChassisDn)
              throws CollectorException

Add a AMF to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the amf

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gAMF

Throws:

CollectorException

addSMF

public N5gSMF addSMF(int dataSourceId,
                     java.lang.String deviceId,
                     java.lang.String parentChassisId,
                     java.lang.String parentChassisDn)
              throws CollectorException

Add a SMF to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the SMF

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gSMF

Throws:

CollectorException

addUPF

public N5gUPF addUPF(int dataSourceId,
                     java.lang.String deviceId,
                     java.lang.String parentChassisId,
                     java.lang.String parentChassisDn)
              throws CollectorException

Add a UPF to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the UPF

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gUPF

Throws:

CollectorException

addPCF

public N5gPCF addPCF(int dataSourceId,
                     java.lang.String deviceId,
                     java.lang.String parentChassisId,
                     java.lang.String parentChassisDn)
              throws CollectorException

Add a PCF to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the PCF

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gPCF

Throws:

CollectorException

addNEF

public N5gNEF addNEF(int dataSourceId,
                     java.lang.String deviceId,
                     java.lang.String parentChassisId,
                     java.lang.String parentChassisDn)
              throws CollectorException

Add a NEF to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the NEF

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gNEF

Throws:

CollectorException

addNRF

public N5gNRF addNRF(int dataSourceId,
                     java.lang.String deviceId,
                     java.lang.String parentChassisId,
                     java.lang.String parentChassisDn)
              throws CollectorException

Add a NRF to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the NRF

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gNRF

Throws:

CollectorException

addAUSF

public N5gAUSF addAUSF(int dataSourceId,
                       java.lang.String deviceId,
                       java.lang.String parentChassisId,
                       java.lang.String parentChassisDn)
                throws CollectorException

Add a AUSF to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the AUSF

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gAUSF

Throws:

CollectorException

addAF

public N5gAF addAF(int dataSourceId,
                   java.lang.String deviceId,
                   java.lang.String parentChassisId,
                   java.lang.String parentChassisDn)
            throws CollectorException

Add a AF to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the AF

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gAF

Throws:

CollectorException

addUDM

public N5gUDM addUDM(int dataSourceId,
                     java.lang.String deviceId,
                     java.lang.String parentChassisId,
                     java.lang.String parentChassisDn)
              throws CollectorException

Add a UDM to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the UDM

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gUDM

Throws:

CollectorException

addNSSF

public N5gNSSF addNSSF(int dataSourceId,
                       java.lang.String deviceId,
                       java.lang.String parentChassisId,
                       java.lang.String parentChassisDn)
                throws CollectorException

Add a NSSF to store

Parameters:

dataSourceId - The id of the datasource

deviceId - The unique id of the NSSF

parentChassisId - Id of chassis

parentChassisDn - Dn of chassis

Returns:

A reference to the newly created N5gNSSF

Throws:

CollectorException

getAMFData

public java.lang.String getAMFData(int dataSourceId,
                                   java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given AMF device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the AMF

Returns:

An XML string representing the 5G data for this AMF

getSMFData

public java.lang.String getSMFData(int dataSourceId,
                                   java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given SMF device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the SMF

Returns:

An XML string representing the 5G data for this SMF

getUPFData

public java.lang.String getUPFData(int dataSourceId,
                                   java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given SMF device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the UPF

Returns:

An XML string representing the 5G data for this UPF

getPCFData

public java.lang.String getPCFData(int dataSourceId,
                                   java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given SMF device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the PCF

Returns:

An XML string representing the 5G data for this PCF

getNEFData

public java.lang.String getNEFData(int dataSourceId,
                                   java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given SMF device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the NEF

Returns:

An XML string representing the 5G data for this NEF

getNRFData

public java.lang.String getNRFData(int dataSourceId,
                                   java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given SMF device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the NRF

Returns:

An XML string representing the 5G data for this NRF

getAUSFData

public java.lang.String getAUSFData(int dataSourceId,
                                    java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given SMF device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the AUSF

Returns:

An XML string representing the 5G data for this AUSF

getAFData

public java.lang.String getAFData(int dataSourceId,
                                  java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given SMF device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the AF

Returns:

An XML string representing the 5G data for this AF

getUDMData

public java.lang.String getUDMData(int dataSourceId,
                                   java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given SMF device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the UDM

Returns:

An XML string representing the 5G data for this UDM

getNSSFData

public java.lang.String getNSSFData(int dataSourceId,
                                    java.lang.String deviceId)

Get an XML representation of all data stored in the data store for a given SMF device

Parameters:

dataSourceId - The ID of the datasource

deviceId - The ID of the NSSF

Returns:

An XML string representing the 5G data for this NSSF