com.ibm.tivoli.nm.collectors.impl.ciscodnarest

Class CiscoDNARestCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.ciscodnarest.CiscoDNARestCollector

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

Method Summary

Modifier and Type	Method and Description
void	addL2TopologicalConnection(L2Link links)
void	addL3TopologicalConnection(L3OSPFLink links)
void	addTopologicalConnection(L1Link links)
boolean	authenticate() Authenticate to Cisco DNA while performing a Full Discovery operation 3 - Level Authentication to Cisco DNA
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 java.util.List<InterfaceResponse>	getAllInterfaces(java.lang.String deviceId, java.lang.String BaseName, int elementCount) Performs a getAllInterfaces operation
protected java.util.List<VlanResponse>	getAllVlans(java.lang.String deviceId, java.lang.String BaseName, int elementCount) Performs a getAllVlans operation
protected java.util.List<Response>	getDeviceList() Performs a getDeviceList operation
static javax.xml.parsers.DocumentBuilderFactory	getDocumentBuilder()
protected void	getL2TopologyDetails(java.util.List<VlanResponse> vList)
protected java.util.List<L3OSPFLink>	getL3OSPFTopology()
protected java.util.List<ModuleResponse>	getModule(java.lang.String deviceId, java.lang.String BaseName, int elementCount) Performs a getModule operation
protected java.util.List<OSPFResponse>	getOSPFInterfaces() Performs a getOSPF operation
protected java.util.List<L1Link>	getPhysicalTopology()
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	loadEquipmentNodeShelf(ModuleResponse processModuleList, java.lang.String deviceId) Load EquipmentNode class attributes into hashmap to be used for creating entity
void	loadEquipmentPort(InterfaceResponse processInterfaceList, java.lang.String deviceId) Load Equipment Port class attributes into hashmap to be used for creating entity
static void	main(java.lang.String[] args) Runs the Cisco DNA rest collector
protected void	parseL2Connection(java.util.List<L2Link> l2Link)
java.util.List<NetworkDevice>	parseNetworkDeviceData(java.util.List<Response> responseList)
protected void	processPhysicalInventoryData(java.util.List<Response> processResponseList) Process data for Physical Inventory add the Entities/Interfaces to the Datastore
java.util.List<InterfaceResponse>	readInterfaceDataFromServer(java.lang.String BaseName) Reads Interface data from server
java.util.List<L2Link>	readL2DataFromServer(java.lang.String vlanName) Reads L2 data from server
java.util.List<L3OSPFLink>	readL3OSPFDataFromServer()
java.util.List<ModuleResponse>	readModuleDataFromServer(java.lang.String BaseName) Reads Module data from server
java.util.List<Response>	readNodeDataFromServer(int repetetions) Reads node data from server
java.util.List<OSPFResponse>	readOSPFDataFromServer() Reads OSPF data from server
java.util.List<L1Link>	readPhysicalLinkDataFromServer() Reads L1 data from server
java.util.List<VlanResponse>	readVlanDataFromServer(java.lang.String BaseName) Reads VLAN 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 TrustStorePath, java.lang.String TrustStorePassword, java.lang.String setProtocolValue, int maxBufferSize) 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)
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

CiscoDNARestCollector

public CiscoDNARestCollector(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 DNA rest collector

Parameters:

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

authenticate

public boolean authenticate()

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

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 TrustStorePath,
                                          java.lang.String TrustStorePassword,
                                          java.lang.String setProtocolValue,
                                          int maxBufferSize)

Setting up websocket connection parameters for REST

Parameters:

webSocketTransport - webSocketTransport class

remoteUsername - Cisco DNA username

remotePassword - Cisco DNA password

remoteHost - Cisco DNA ip address

remoteServiceName - Cisco DNA Service Name

remotePreUsername - Cisco DNA Presentation Server username

remotePrePassword - Cisco DNA Presentation Server password

remotePreHost - Cisco DNA Presentation Server ip address

remotePort - Cisco DNA port

remotekeyStoreFileName - Cisco DNA 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<Response> readNodeDataFromServer(int repetetions)

Reads node data from server

readModuleDataFromServer

public java.util.List<ModuleResponse> readModuleDataFromServer(java.lang.String BaseName)

Reads Module data from server

readInterfaceDataFromServer

public java.util.List<InterfaceResponse> readInterfaceDataFromServer(java.lang.String BaseName)

Reads Interface data from server

readVlanDataFromServer

public java.util.List<VlanResponse> readVlanDataFromServer(java.lang.String BaseName)

Reads VLAN data from server

readL2DataFromServer

public java.util.List<L2Link> readL2DataFromServer(java.lang.String vlanName)

Reads L2 data from server

readOSPFDataFromServer

public java.util.List<OSPFResponse> readOSPFDataFromServer()

Reads OSPF data from server

readPhysicalLinkDataFromServer

public java.util.List<L1Link> readPhysicalLinkDataFromServer()

Reads L1 data from server

readL3OSPFDataFromServer

public java.util.List<L3OSPFLink> readL3OSPFDataFromServer()

getDeviceList

protected java.util.List<Response> getDeviceList()
                                          throws java.io.IOException

Performs a getDeviceList operation

Parameters:

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

Throws:

java.io.IOException

getModule

protected java.util.List<ModuleResponse> getModule(java.lang.String deviceId,
                                                   java.lang.String BaseName,
                                                   int elementCount)
                                            throws java.io.IOException

Performs a getModule operation

Parameters:

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

Throws:

java.io.IOException

getAllInterfaces

protected java.util.List<InterfaceResponse> getAllInterfaces(java.lang.String deviceId,
                                                             java.lang.String BaseName,
                                                             int elementCount)
                                                      throws java.io.IOException

Performs a getAllInterfaces operation

Parameters:

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

Throws:

java.io.IOException

getAllVlans

protected java.util.List<VlanResponse> getAllVlans(java.lang.String deviceId,
                                                   java.lang.String BaseName,
                                                   int elementCount)
                                            throws java.io.IOException

Performs a getAllVlans operation

Parameters:

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

Throws:

java.io.IOException

getL2TopologyDetails

protected void getL2TopologyDetails(java.util.List<VlanResponse> vList)
                             throws java.io.IOException

Throws:

java.io.IOException

parseL2Connection

protected void parseL2Connection(java.util.List<L2Link> l2Link)

getOSPFInterfaces

protected java.util.List<OSPFResponse> getOSPFInterfaces()
                                                  throws java.io.IOException

Performs a getOSPF operation

Parameters:

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

Throws:

java.io.IOException

getPhysicalTopology

protected java.util.List<L1Link> getPhysicalTopology()
                                              throws java.io.IOException

Throws:

java.io.IOException

getL3OSPFTopology

protected java.util.List<L3OSPFLink> getL3OSPFTopology()
                                                throws java.io.IOException

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<Response> processResponseList)
                                     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

addTopologicalConnection

public void addTopologicalConnection(L1Link links)

addL3TopologicalConnection

public void addL3TopologicalConnection(L3OSPFLink links)

addL2TopologicalConnection

public void addL2TopologicalConnection(L2Link links)

loadEquipmentNodeShelf

public void loadEquipmentNodeShelf(ModuleResponse processModuleList,
                                   java.lang.String deviceId)

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(InterfaceResponse processInterfaceList,
                              java.lang.String deviceId)

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

Parameters:

processInterfaceList - List of items belong to InterfaceResponse

deviceId -

parseNetworkDeviceData

public java.util.List<NetworkDevice> parseNetworkDeviceData(java.util.List<Response> responseList)

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

getDocumentBuilder

public static javax.xml.parsers.DocumentBuilderFactory getDocumentBuilder()