com.ibm.tivoli.nm.collectors.impl.ciscoepnmrest

Class CiscoEPNMRestCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.ciscoepnmrest.CiscoEPNMRestCollector

public class CiscoEPNMRestCollector
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
CiscoEPNMRestCollector(java.lang.String collectorName, java.lang.String collectorDescription) Constructor

Method Summary

Modifier and Type	Method and Description
void	AddTopologicalConnection(java.util.List<TopoEndpoint> tEndpoint, java.lang.String neId, java.lang.String NEName) 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
boolean	epnmAuthenticate() Authenticate to Cisco EPNM while performing a Full Discovery operation 3 - Level Authentication to Cisco EPNM
protected java.util.List<NdNode>	getAllNodes() Performs a getAllNodes operation
protected java.util.List<TopoTopologicalLink>	getAllTopologicalLinks() Updated getAllTopologicalLinks for JSON data*****************
protected java.util.List<TpTerminationPoint>	getTerminationPoints() Updated getAllPhysicalTerminationPoints for JSON data******************************************
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.List<TopoTopologicalLink> alTopologicalLinks, java.lang.String NEName, java.lang.String neId) Load loadAndAddTopologicalConnections class attributes into hashmap to be used for creating entity
void	loadEquipmentNodeShelf(EqEquipment equipNode, NetworkDevice neElement) Load EquipmentNode class attributes into hashmap to be used for creating entity
void	loadEquipmentPort(TpTerminationPoint portIter, NetworkDevice neElement) Load Equipment Port class attributes into hashmap to be used for creating entity
static void	main(java.lang.String[] args) Runs the Cisco EPNM rest collector
java.util.List<NetworkDevice>	parseNetworkDeviceData(java.util.List<NdNode> nodeList)
protected void	processPhysicalInventoryData(java.util.List<NdNode> processNodeList, java.util.List<TopoTopologicalLink> alTopoConnections, java.util.List<TpTerminationPoint> processTerminationList) Process data for Physical Inventory add the Entities/Interfaces to the Datastore
java.util.List<NdNode>	readNodeDataFromServer() Reads node data from server
java.util.List<TpTerminationPoint>	readTerminationDataFromServer() Reads Termination data from server
java.util.List<TopoTopologicalLink>	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.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, int maxBufferSize, boolean TrustAll) 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

CiscoEPNMRestCollector

public CiscoEPNMRestCollector(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 Cisco EPNM rest collector

Parameters:

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

epnmAuthenticate

public boolean epnmAuthenticate()

Authenticate to Cisco EPNM while performing a Full Discovery operation 3 - Level Authentication to Cisco EPNM

Parameters:

None -

Returns:

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

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

setConnectionParameters

protected boolean setConnectionParameters(WebSocketTransport webSocketTransport,
                                          java.lang.String remoteUsername,
                                          java.lang.String remotePassword,
                                          java.lang.String remoteHost,
                                          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,
                                          int maxBufferSize,
                                          boolean TrustAll)

Setting up websocket connection parameters for REST

Parameters:

webSocketTransport - webSocketTransport class

remoteUsername - Cisco EPNM username

remotePassword - Cisco EPNM password

remoteHost - Cisco EPNM ip address

remoteServiceName - Cisco EPNM Service Name

remotePreUsername - Cisco EPNM Presentation Server username

remotePrePassword - Cisco EPNM Presentation Server password

remotePreHost - Cisco EPNM Presentation Server ip address

remotePort - Cisco EPNM port

remotekeyStoreFileName - Cisco EPNM username

remotekeyStorePassword - keyStorePassword

remoteHTTPversion - HTTP version

remoteResponseTimeout - Response Timeout in seconds

setRefreshInterval - Refresh Interval in seconds

Returns:

Successful or Failed

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

readNodeDataFromServer

public java.util.List<NdNode> readNodeDataFromServer()

Reads node data from server

readTerminationDataFromServer

public java.util.List<TpTerminationPoint> readTerminationDataFromServer()

Reads Termination data from server

readTopologicalDataFromServer

public java.util.List<TopoTopologicalLink> readTopologicalDataFromServer()

Reads Topological data from server

getAllNodes

protected java.util.List<NdNode> getAllNodes()
                                      throws java.io.IOException

Performs a getAllNodes operation

Parameters:

None - It will get all the list of Elements from EPNM. 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.List<TopoTopologicalLink> getAllTopologicalLinks()
                                                              throws java.io.IOException

Updated getAllTopologicalLinks for JSON data*****************

Throws:

java.io.IOException

getTerminationPoints

protected java.util.List<TpTerminationPoint> getTerminationPoints()
                                                           throws java.io.IOException

Updated getAllPhysicalTerminationPoints for JSON data******************************************

Throws:

java.io.IOException

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<NdNode> processNodeList,
                                            java.util.List<TopoTopologicalLink> alTopoConnections,
                                            java.util.List<TpTerminationPoint> processTerminationList)
                                     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.List<TopoTopologicalLink> 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

AddTopologicalConnection

public void AddTopologicalConnection(java.util.List<TopoEndpoint> tEndpoint,
                                     java.lang.String neId,
                                     java.lang.String NEName)

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

Parameters:

TopologicalLinks - item belong to TopologicalLink

loadEquipmentNodeShelf

public void loadEquipmentNodeShelf(EqEquipment 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(TpTerminationPoint portIter,
                              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<NdNode> 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)