com.ibm.tivoli.nm.collectors.impl.nokiaoms1350rest

Class NokiaOMS1350RestCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.nokiaoms1350rest.NokiaOMS1350RestCollector

public class NokiaOMS1350RestCollector
extends Collector

Field Summary

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

collectorDescription, collectorName, collectorPort, dataStore, propsFileName, running

Constructor Summary

Constructors

Constructor and Description
NokiaOMS1350RestCollector(java.lang.String collectorName, java.lang.String collectorDescription) Constructor

Method Summary

Modifier and Type	Method and Description
void	AddTopologicalConnection(TopologicalLink topologicalLink, java.lang.String neId) Load AddTopologicalConnection class attributes into hashmap to be used for creating entity
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.
protected void	doFullDiscovery(java.lang.String nodeId) Performs a Full Discovery operation
protected NetworkEquipment	getAllEquipment() Performs a getAllEquipment operation
protected java.util.List<Elements>	getAllNetworkElements() Performs a getAllNetworkElements operation
protected java.util.ArrayList<PhysicalPorts>	getAllPhysicalPorts() Performs a getAllPhysicalPorts operation
protected java.util.ArrayList<TopologicalLinks>	getAllTopologicalLinks() Performs a getAllNetworkElements operation
static java.lang.String	getBasicAuthorization(java.lang.String username, java.lang.String password)
protected java.util.ArrayList<TopologicalLink>	getTopologicalLink() Performs a getTopologicalLink operation
boolean	HTTPClientInitialzation()
protected void	initDataStore() Initializes data source as specified in the properties file
protected boolean	initialise() Initialize collector with data gather from properties file
protected boolean	isGetEntities()
protected boolean	isGetLayer1Connections()
protected boolean	isGetLayer2Connections()
protected boolean	isGetLayer3Connections()
void	loadAndAddTopologicalConnections(java.util.ArrayList<TopologicalLinks> alTopologicalLinks, java.lang.String NEName, java.lang.String neId) Load loadAndAddTopologicalConnections class attributes into hashmap to be used for creating entity
void	loadEquipmentNodeCard(EquipmentNode equipNode, NetworkDevice neElement) Load EquipmentNode class attributes into hashmap to be used for creating entity
void	loadEquipmentNodeShelf(EquipmentNode equipNode, NetworkDevice neElement) Load EquipmentNode class attributes into hashmap to be used for creating entity
void	loadEquipmentNodeSlot(EquipmentNode equipNode, NetworkDevice neElement) Load EquipmentNode class attributes into hashmap to be used for creating entity
void	loadEquipmentPort(PhysicalPort physicalPort, NetworkDevice neElement) Load Equipment Port class attributes into hashmap to be used for creating entity
static void	main(java.lang.String[] args) Runs the Nokia OMS 1350 collector
boolean	oms1350Authenticate() Authenticate to Nokia OMS 130 while performing a Full Discovery operation 3 - Level Authentication to Nokia OMS 1350
java.util.List<NetworkDevice>	parseNetworkDeviceData(java.util.List<Elements> nodeList)
protected void	processPhysicalInventoryData(java.util.List<Elements> processNodeList, NetworkEquipment netwEquipment, java.util.ArrayList<TopologicalLinks> alTopoConnections, java.util.ArrayList<TopologicalLink> allTopologyConnections) Process data for Physical Inventory add the Entities/Interfaces to the Datastore
void	processTopologicalLink(java.util.List<TopologicalLink> allTopoLinks, java.lang.String NEName, java.lang.String neId)
java.util.ArrayList<TopologicalLink>	readallTopologicalDataFromServer() Reads GetAllTopological data from server
java.lang.String	readJsonData(java.lang.String fileName) Reads readJsonData data from server
java.util.List<Elements>	readNetworkElementsDataFromServer() Reads NetworkElements data from server
NetworkEquipment	readNetworkEquipDataFromServer() Reads NetworkEquipment data from server
java.util.ArrayList<PhysicalPorts>	readPhysicalPortsDataFromServer() Reads NetworkElements data from server
java.util.ArrayList<TopologicalLinks>	readTopologicalDataFromServer() Reads Topological data from server
protected boolean	setConnectionParameters(WebSocketTransport webSocketTransport, java.lang.String remoteUsername, java.lang.String remotePassword, java.lang.String remoteHost, java.lang.String remoteServiceName, java.lang.String remotePreHostname, java.lang.String remotePreUserName, java.lang.String remotePrePassword, java.lang.Integer remotePort, java.lang.String remotekeyStoreFileName, java.lang.String remotekeyStorePassword, java.lang.String remoteHTTPversion, java.lang.String remoteResponseTimeout, java.lang.Integer remoteRefreshInterval, java.lang.Boolean remoteEnableSSL, java.lang.String pathToKeyStoreFile, java.lang.String setProtocolValue, boolean enableManualST, java.lang.String serviceTicket, int maxBufferSize, boolean isSingleAuthentication) Setting up websocket connection parameters for REST
protected boolean	setConnectionParametersHTTP(WebSocketTransport webSocketTransport, java.lang.String remoteHost, java.lang.String remoteHTTPversion, java.lang.String remoteResponseTimeout) Setting up websocket connection parameters for REST
protected void	setGetEntities(java.lang.String getEntitiesFlag)
protected void	setGetLayer1Connections(java.lang.String getLayer1Connections)
protected void	setGetLayer2Connections(java.lang.String getLayer2Connections)
protected void	setGetLayer3Connections(java.lang.String getLayer3Connections)
static void	setPropsFile(java.util.Properties propsFile)
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, GetAmfData, GetAssociatedAddresses, GetAssociatedAddresses, GetAusfData, getCommandLineArgument, GetConnections, GetConnections, GetDeviceInfo, GetDeviceInfo, GetDeviceInfo, GetDeviceList, GetEirData, GetENodeBData, GetEntities, GetEntities, GetGNodeBData, GetHssData, GetInfo, GetInventory, GetInventory, GetLayer1Connections, GetLayer1Connections, GetLayer2Connections, GetLayer2Connections, GetLayer2Vpns, GetLayer2Vpns, GetLayer3Connections, GetLayer3Connections, GetLayer3Vpns, GetLayer3Vpns, GetMmeData, GetMplsInterfaces, GetMplsInterfaces, GetNefData, GetNrfData, GetNssfData, GetPcfData, GetPcrfData, GetPgwData, getPortNumberArgument, getPropertiesFileNameArgument, getPropertyValue, GetRanData, GetSAEGatewayData, GetSgwData, GetSmfData, GetUdmData, GetUpfData, initialiseDataStore, 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

Constructor Detail

NokiaOMS1350RestCollector

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

Constructor

Parameters:

collectorName - The name of the collector

collectorDescription - A description of the collector

Method Detail

main

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

Runs the Nokia OMS 1350 collector

Parameters:

args - Command line arguments, e.g. -propsFile <props file name>

oms1350Authenticate

public boolean oms1350Authenticate()

Authenticate to Nokia OMS 130 while performing a Full Discovery operation 3 - Level Authentication to Nokia OMS 1350

Parameters:

None -

Returns:

Connections status true if successful else false. IsConnected will be set to True

HTTPClientInitialzation

public boolean HTTPClientInitialzation()

initialise

protected boolean initialise()

Initialize collector with data gather from properties file

Returns:

Successful/True if all the properties are initialized else False

initDataStore

protected void initDataStore()

Initializes data source as specified in the properties file

setConnectionParametersHTTP

protected boolean setConnectionParametersHTTP(WebSocketTransport webSocketTransport,
                                              java.lang.String remoteHost,
                                              java.lang.String remoteHTTPversion,
                                              java.lang.String remoteResponseTimeout)

Setting up websocket connection parameters for REST

Parameters:

webSocketTransport - webSocketTransport class

remoteUsername - Nokia OMS 1350 username

remotePassword - Nokia OMS 1350 password

remoteHost - Nokia OMS 1350 ip address

remoteServiceName - Nokia OMS 1350 Service Name

remotePreUsername - Nokia OMS 1350 Presentation Server username

remotePrePassword - Nokia OMS 1350 Presentation Server password

remotePreHost - Nokia OMS 1350 Presentation Server ip address

remotePort - Nokia OMS 1350 port

remotekeyStoreFileName - Nokia OMS 1350 username

remotekeyStorePassword - keyStorePassword

remoteHTTPversion - HTTP version

remoteResponseTimeout - Response Timeout in seconds

setRefreshInterval - Refresh Interval in seconds

Returns:

Successful or Failed

setConnectionParameters

protected boolean setConnectionParameters(WebSocketTransport webSocketTransport,
                                          java.lang.String remoteUsername,
                                          java.lang.String remotePassword,
                                          java.lang.String remoteHost,
                                          java.lang.String remoteServiceName,
                                          java.lang.String remotePreHostname,
                                          java.lang.String remotePreUserName,
                                          java.lang.String remotePrePassword,
                                          java.lang.Integer remotePort,
                                          java.lang.String remotekeyStoreFileName,
                                          java.lang.String remotekeyStorePassword,
                                          java.lang.String remoteHTTPversion,
                                          java.lang.String remoteResponseTimeout,
                                          java.lang.Integer remoteRefreshInterval,
                                          java.lang.Boolean remoteEnableSSL,
                                          java.lang.String pathToKeyStoreFile,
                                          java.lang.String setProtocolValue,
                                          boolean enableManualST,
                                          java.lang.String serviceTicket,
                                          int maxBufferSize,
                                          boolean isSingleAuthentication)

Setting up websocket connection parameters for REST

Parameters:

webSocketTransport - webSocketTransport class

remoteUsername - Nokia OMS 1350 username

remotePassword - Nokia OMS 1350 password

remoteHost - Nokia OMS 1350 ip address

remoteServiceName - Nokia OMS 1350 Service Name

remotePreUsername - Nokia OMS 1350 Presentation Server username

remotePrePassword - Nokia OMS 1350 Presentation Server password

remotePreHost - Nokia OMS 1350 Presentation Server ip address

remotePort - Nokia OMS 1350 port

remotekeyStoreFileName - Nokia OMS 1350 username

remotekeyStorePassword - keyStorePassword

remoteHTTPversion - HTTP version

remoteResponseTimeout - Response Timeout in seconds

setRefreshInterval - Refresh Interval in seconds

Returns:

Successful or Failed

getBasicAuthorization

public static java.lang.String getBasicAuthorization(java.lang.String username,
                                                     java.lang.String password)

Parameters:

username -

password -

Returns:

encoded credentials

doFullDiscovery

protected void doFullDiscovery(java.lang.String nodeId)
                        throws java.io.IOException

Performs a Full Discovery operation

Parameters:

nodeId - Node Id for Partial Discovery operation. When a non-zero value is supplied, Partial Discovery is performed, else Full Discovery is performed instead

Throws:

java.io.IOException - ,TolAttributeException,TolCommunicationException

readJsonData

public java.lang.String readJsonData(java.lang.String fileName)

Reads readJsonData data from server

Parameters:

fileName -

Returns:

readNetworkEquipDataFromServer

public NetworkEquipment readNetworkEquipDataFromServer()

Reads NetworkEquipment data from server

readNetworkElementsDataFromServer

public java.util.List<Elements> readNetworkElementsDataFromServer()
                                                           throws JsonParseException,
                                                                  java.io.IOException

Reads NetworkElements data from server

Throws:

java.io.IOException

JsonParseException

readPhysicalPortsDataFromServer

public java.util.ArrayList<PhysicalPorts> readPhysicalPortsDataFromServer()

Reads NetworkElements data from server

readTopologicalDataFromServer

public java.util.ArrayList<TopologicalLinks> readTopologicalDataFromServer()

Reads Topological data from server

readallTopologicalDataFromServer

public java.util.ArrayList<TopologicalLink> readallTopologicalDataFromServer()

Reads GetAllTopological data from server

getAllEquipment

protected NetworkEquipment getAllEquipment()
                                    throws java.io.IOException

Performs a getAllEquipment operation

Parameters:

None - It will get all the list of Equipments from OMS. First it will return the location of JSON file and next send the request to download the JSON file

Throws:

java.io.IOException - ,TolAttributeException,TolCommunicationException

getAllNetworkElements

protected java.util.List<Elements> getAllNetworkElements()
                                                  throws java.io.IOException

Performs a getAllNetworkElements operation

Parameters:

None - It will get all the list of Elements from OMS. First it will return the location of JSON file and next send the request to download the JSON file

Throws:

java.io.IOException - ,TolAttributeException,TolCommunicationException

getAllPhysicalPorts

protected java.util.ArrayList<PhysicalPorts> getAllPhysicalPorts()
                                                          throws java.io.IOException

Performs a getAllPhysicalPorts operation

Parameters:

None - It will get all the list of Elements from OMS. First it will return the location of JSON file and next send the request to download the JSON file

Throws:

java.io.IOException - ,TolAttributeException,TolCommunicationException

getAllTopologicalLinks

protected java.util.ArrayList<TopologicalLinks> getAllTopologicalLinks()
                                                                throws java.io.IOException

Performs a getAllNetworkElements operation

Parameters:

None - It will get all the list of Topological Links from OMS. First it will return the location of JSON file and next send the request to download the JSON file

Throws:

java.io.IOException - ,TolAttributeException,TolCommunicationException

getTopologicalLink

protected java.util.ArrayList<TopologicalLink> getTopologicalLink()
                                                           throws java.io.IOException

Performs a getTopologicalLink operation

Parameters:

None - It will get all the list of Topological Links from OMS. First it will return the location of JSON file and next send the request to download the JSON file

Throws:

java.io.IOException - ,TolAttributeException,TolCommunicationException

collectData

protected 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

UpdateData

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.

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 IP of the device to refresh, or else it holds the subnet to refresh

mask - Holds the subnet mask, or is not defined

Returns:

A message to acknowledge that the update has been completed e.g. <updateResponse></updateResponse>

processPhysicalInventoryData

protected void processPhysicalInventoryData(java.util.List<Elements> processNodeList,
                                            NetworkEquipment netwEquipment,
                                            java.util.ArrayList<TopologicalLinks> alTopoConnections,
                                            java.util.ArrayList<TopologicalLink> allTopologyConnections)
                                     throws java.io.IOException

Process data for Physical Inventory add the Entities/Interfaces to the Datastore

Parameters:

processNodeList - List of nodes

NetworkEquipment - NetworkEquipment List of Network Equipment

Throws:

java.io.IOException

loadAndAddTopologicalConnections

public void loadAndAddTopologicalConnections(java.util.ArrayList<TopologicalLinks> alTopologicalLinks,
                                             java.lang.String NEName,
                                             java.lang.String neId)

Load loadAndAddTopologicalConnections class attributes into hashmap to be used for creating entity

Parameters:

ArrayList - List of items belong to TopologicalLinks

processTopologicalLink

public void processTopologicalLink(java.util.List<TopologicalLink> allTopoLinks,
                                   java.lang.String NEName,
                                   java.lang.String neId)

AddTopologicalConnection

public void AddTopologicalConnection(TopologicalLink topologicalLink,
                                     java.lang.String neId)

Load AddTopologicalConnection class attributes into hashmap to be used for creating entity

Parameters:

TopologicalLinks - item belong to TopologicalLink

loadEquipmentNodeSlot

public void loadEquipmentNodeSlot(EquipmentNode equipNode,
                                  NetworkDevice neElement)

Load EquipmentNode class attributes into hashmap to be used for creating entity

Parameters:

EquipmentNode - List of items belong to EquipmentNode

neName - The ID of Network Element

loadEquipmentNodeCard

public void loadEquipmentNodeCard(EquipmentNode equipNode,
                                  NetworkDevice neElement)

Load EquipmentNode class attributes into hashmap to be used for creating entity

Parameters:

EquipmentNode - List of items belong to EquipmentNode

neName - The ID of Network Element

loadEquipmentNodeShelf

public void loadEquipmentNodeShelf(EquipmentNode equipNode,
                                   NetworkDevice neElement)

Load EquipmentNode class attributes into hashmap to be used for creating entity

Parameters:

EquipmentNode - List of items belong to EquipmentNode

neName - The ID of Network Element

loadEquipmentPort

public void loadEquipmentPort(PhysicalPort physicalPort,
                              NetworkDevice neElement)

Load Equipment Port class attributes into hashmap to be used for creating entity

Parameters:

PhysicalPort - List of items belong to Physical Port

Elements - The Network Element data

parseNetworkDeviceData

public java.util.List<NetworkDevice> parseNetworkDeviceData(java.util.List<Elements> nodeList)

Parameters:

nodeList -

Returns:

isGetEntities

protected boolean isGetEntities()

Returns:

the getEntities

setGetEntities

protected void setGetEntities(java.lang.String getEntitiesFlag)

Parameters:

getEntities - the getEntities to set

isGetLayer1Connections

protected boolean isGetLayer1Connections()

Returns:

the getLayer1Connections

setGetLayer1Connections

protected void setGetLayer1Connections(java.lang.String getLayer1Connections)

Parameters:

getLayer1Connections - the getLayer1Connections to set

isGetLayer2Connections

protected boolean isGetLayer2Connections()

Returns:

the getLayer2Connections

setGetLayer2Connections

protected void setGetLayer2Connections(java.lang.String getLayer2Connections)

Parameters:

getLayer2Connections - the getLayer2Connections to set

isGetLayer3Connections

protected boolean isGetLayer3Connections()

Returns:

the getLayer3Connections

setGetLayer3Connections

protected void setGetLayer3Connections(java.lang.String getLayer3Connections)

Parameters:

getLayer3Connections - the getLayer3Connections to set

setPropsFile

public static void setPropsFile(java.util.Properties propsFile)