com.ibm.tivoli.nm.collectors.impl.ciscoapicrest

Class CiscoApicRestCollector

java.lang.Object

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

com.ibm.tivoli.nm.collectors.impl.ciscoapicrest.CiscoApicRestCollector

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

Method Summary

Modifier and Type	Method and Description
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 void	doPartialDiscovery(int dataSource, java.lang.String nodeId) This method performs Partial Discovery by invoking doFullDiscovery(int) method and supplying a node id as parameter.
protected java.util.ArrayList<Node>	getAllRestClass(java.lang.String workingDirectory, java.lang.String topSystemFileName, java.lang.String nodeId, java.lang.Boolean partial) Generate XML or JSON file from REST command output
protected java.lang.String	getTopSystemCmdRest(WebSocketTransport webSocketTransport, java.lang.String restMethod, java.lang.String command) Sending REST 'topSystem' Class to get all available list of nodes Output from REST command is in xml based format
protected static java.lang.Boolean	individualPerNodeRestCmd(WebSocketTransport webSocketTransport, java.lang.String restCommand, java.lang.String absoluteFilePath) Prepare REST command per individual nodes to pass to getIndividualCmdRest method
protected void	initDataStore() Initialises data source as specified in the properties file
protected boolean	initialise() Initialise collector with data gather from properties file
protected boolean	isGetEntities()
protected boolean	isGetLayer1Connections()
protected boolean	isGetLayer2Connections()
protected boolean	isGetLayer3Connections()
static void	main(java.lang.String[] args) Runs the Cisco APIC SDN collector
java.util.List<NetworkDevice>	parseNetworkDeviceData(java.util.ArrayList<Node> nodeList)
protected java.util.ArrayList<lldpAdjEp>	processPhysicalInventoryData(java.util.ArrayList<Node> processNodeList, CiscoApicXMLJSONParser XMLJSONParser) Process data for Physical Inventory
protected void	processTopologyData(java.util.ArrayList<Node> processNodeList, java.util.ArrayList<lldpAdjEp> lldpAdjEplist) Process data for Topology
protected void	purgeDirectory(java.io.File file) Delete files from 'data' directory before any new full discovery
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 TLSVersion, 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)
static void	setPropsFile(java.util.Properties propsFile)
protected java.lang.String	testRegex(java.lang.String input, java.lang.String patterns) Test the regex from supplied Distinguish Name (DN) to check pattern
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

CiscoApicRestCollector

public CiscoApicRestCollector(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 APIC SDN collector

Parameters:

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

initDataStore

protected void initDataStore()

Initialises data source as specified in the properties file

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>

doPartialDiscovery

protected void doPartialDiscovery(int dataSource,
                                  java.lang.String nodeId)
                           throws java.io.IOException

This method performs Partial Discovery by invoking doFullDiscovery(int) method and supplying a node id as parameter.

Parameters:

dataSource - The DataSource Id that is specified in the properties file

address - IP address of the target device of the partial discovery

Throws:

java.io.IOException - , TolAttributeException, TolCommunicationException

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

processPhysicalInventoryData

protected java.util.ArrayList<lldpAdjEp> processPhysicalInventoryData(java.util.ArrayList<Node> processNodeList,
                                                                      CiscoApicXMLJSONParser XMLJSONParser)
                                                               throws java.io.IOException

Process data for Physical Inventory

Parameters:

processNodeList - List of nodes

XMLJSONParser - XMLJSONParser Class that handle parser operation

Returns:

lldpAdjEp List of LLDP Neighbor's information to be used for topology

Throws:

java.io.IOException

processTopologyData

protected void processTopologyData(java.util.ArrayList<Node> processNodeList,
                                   java.util.ArrayList<lldpAdjEp> lldpAdjEplist)
                            throws java.io.IOException

Process data for Topology

Parameters:

processNodeList - List of nodes

lldpAdjEplist - LLDP Neighbor list of nodes

Throws:

java.io.IOException

initialise

protected boolean initialise()

Initialise collector with data gather from properties file

Returns:

Successfull or Failed

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

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 TLSVersion,
                                          int maxBufferSize)

Setting up websocket connection parameters for REST

Parameters:

webSocketTransport - webSocketTransport class

remoteUsername - Cisco APIC username

remotePassword - Cisco APIC password

remoteHost - Cisco APIC ip address

remotePort - Cisco APIC port

remotekeyStoreFileName - Cisco APIC username

remotekeyStorePassword - keyStorePassword

remoteHTTPversion - HTTP version

remoteResponseTimeout - Response Timeout in seconds

setRefreshInterval - Refresh Interval in seconds

Returns:

Successful or Failed

getTopSystemCmdRest

protected java.lang.String getTopSystemCmdRest(WebSocketTransport webSocketTransport,
                                               java.lang.String restMethod,
                                               java.lang.String command)

Sending REST 'topSystem' Class to get all available list of nodes Output from REST command is in xml based format

Parameters:

webSocketTransport - webSocketTransport class

restMethod - REST method GET or PUT

command - REST command

Returns:

xmlData output from REST command

individualPerNodeRestCmd

protected static java.lang.Boolean individualPerNodeRestCmd(WebSocketTransport webSocketTransport,
                                                            java.lang.String restCommand,
                                                            java.lang.String absoluteFilePath)

Prepare REST command per individual nodes to pass to getIndividualCmdRest method

Parameters:

webSocketTransport - webSocketTransport class

restCommand - REST command

absoluteFilePath - Absolute path of the file created from this method

Returns:

status Successful or Failed

testRegex

protected java.lang.String testRegex(java.lang.String input,
                                     java.lang.String patterns)

Test the regex from supplied Distinguish Name (DN) to check pattern

Parameters:

input - Distinguish Name (DN) data as input

patterns - Patterns that need to be applied to DN

Returns:

result Filtered DN

purgeDirectory

protected void purgeDirectory(java.io.File file)

Delete files from 'data' directory before any new full discovery

Parameters:

file - Directory

getAllRestClass

protected java.util.ArrayList<Node> getAllRestClass(java.lang.String workingDirectory,
                                                    java.lang.String topSystemFileName,
                                                    java.lang.String nodeId,
                                                    java.lang.Boolean partial)

Generate XML or JSON file from REST command output

Parameters:

workingDirectory - Directory where 'topSystem' class is kept

topSystemFileName - Filename of 'topSystem' class

nodeId - Node Id

partial - Full or Partial discovery

Returns:

ArrayList which carries list of nodes data

parseNetworkDeviceData

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

Parameters:

nodeList -

Returns:

setPropsFile

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