com.ibm.tivoli.nm.collectors.impl.switchcommander.util

Class SwitchCommanderCollectorXMLProcessor

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.ibm.tivoli.nm.collectors.impl.switchcommander.util.SwitchCommanderCollectorXMLProcessor

All Implemented Interfaces:

SwitchCommanderCollectorDataProvider, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class SwitchCommanderCollectorXMLProcessor
extends org.xml.sax.helpers.DefaultHandler
implements SwitchCommanderCollectorDataProvider

Author:

Lim Keat Sin, Yeo Eng Seng

Constructor Summary

Constructors

Constructor and Description
SwitchCommanderCollectorXMLProcessor() Constructor

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	clearEntities()
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
java.util.HashMap<java.lang.String,ManagedElement>	getAllManagedElements() Retrieves all managed elements
java.util.HashMap<java.lang.String,Board>	getBoards()
SwitchCommanderCollectorXMLProcessor	getManagedElement(java.lang.String deviceId, java.util.ArrayList<java.lang.String> fileLocationList) Retrieves a managed element
SwitchCommanderCollectorXMLProcessor	parseObjectsFromXML(java.util.ArrayList<java.lang.String> fileLocationList)
protected boolean	readXML(java.lang.String filePath, org.xml.sax.ContentHandler handler) Parses raw XML files
protected java.util.ArrayList<java.lang.String>	retrieveXMLFilesToLocalDir(java.util.ArrayList<java.lang.String> fileLocationList) Retrieve list of of XML files of managed elements to be discovered
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchCommanderCollectorXMLProcessor

public SwitchCommanderCollectorXMLProcessor()

Constructor

Method Detail

retrieveXMLFilesToLocalDir

protected java.util.ArrayList<java.lang.String> retrieveXMLFilesToLocalDir(java.util.ArrayList<java.lang.String> fileLocationList)

Retrieve list of of XML files of managed elements to be discovered

Parameters:

size - Number of files to download at a time //TODO

fileLocationList - List of locations of files

Returns:

List of files downloaded locally

parseObjectsFromXML

public SwitchCommanderCollectorXMLProcessor parseObjectsFromXML(java.util.ArrayList<java.lang.String> fileLocationList)

getAllManagedElements

public java.util.HashMap<java.lang.String,ManagedElement> getAllManagedElements()

Retrieves all managed elements

Specified by:

getAllManagedElements in interface SwitchCommanderCollectorDataProvider

Parameters:

size - Number of files to be downloaded

fileLocationList - List of remote files location

Returns:

Managed elements parsed from downloaded files

getBoards

public java.util.HashMap<java.lang.String,Board> getBoards()

Returns:

the boards

getManagedElement

public SwitchCommanderCollectorXMLProcessor getManagedElement(java.lang.String deviceId,
                                                              java.util.ArrayList<java.lang.String> fileLocationList)

Retrieves a managed element

Specified by:

getManagedElement in interface SwitchCommanderCollectorDataProvider

Parameters:

deviceId - The device Id to retrieve

Returns:

The managed element specified by deviceId

readXML

protected boolean readXML(java.lang.String filePath,
                          org.xml.sax.ContentHandler handler)
                   throws org.xml.sax.SAXException,
                          javax.xml.parsers.ParserConfigurationException,
                          java.io.IOException

Parses raw XML files

Parameters:

filePath - Downloaded local file

handler - XML file handler

Returns:

true if file is parsed

Throws:

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

clearEntities

public void clearEntities()