org.opennms.protocols.xml.collector

Class AbstractXmlCollectionHandler

java.lang.Object

org.opennms.protocols.xml.collector.AbstractXmlCollectionHandler

All Implemented Interfaces:

XmlCollectionHandler

Direct Known Subclasses:

AbstractJsonCollectionHandler, AbstractVTDXmlCollectionHandler, DefaultXmlCollectionHandler, HttpCollectionHandler, Sftp3gppXmlCollectionHandler

public abstract class AbstractXmlCollectionHandler
extends Object
implements XmlCollectionHandler

The Abstract Class XML Collection Handler.

All XmlCollectionHandler should extend this class.

Author:

Alejandro Galue

Constructor Summary

Constructors

Constructor and Description
AbstractXmlCollectionHandler()

Method Summary

Modifier and Type	Method and Description
protected InputStream	applyXsltTransformation(Request request, InputStream is) Apply XSLT transformation.
XmlCollectionSet	collect(CollectionAgent agent, XmlDataCollection collection, Map<String,Object> parameters) Collect.
protected void	fillCollectionSet(CollectionAgent agent, XmlCollectionSet collectionSet, XmlSource source, Document doc) Fill collection set.
protected abstract void	fillCollectionSet(String urlString, Request request, CollectionAgent agent, XmlCollectionSet collectionSet, XmlSource source) Fill collection set.
protected Map<String,String>	filterParameters(Map<String,Object> input) Filter out blacklisted key/values out from an input Map.
protected XmlCollectionResource	getCollectionResource(CollectionAgent agent, String instance, String resourceType, Date timestamp) Gets the collection resource.
NodeDao	getNodeDao() Gets the Node DAO.
ResourceStorageDao	getResourceStorageDao()
RrdRepository	getRrdRepository() Gets the RRD repository.
String	getServiceName() Gets the service name.
protected Date	getTimeStamp(Document doc, XPath xpath, XmlGroup group) Gets the time stamp.
protected Document	getXmlDocument(InputStream is, Request request) Gets the XML document.
protected Document	getXmlDocument(String urlString, Request request) Gets the XML document.
protected XmlResourceType	getXmlResourceType(CollectionAgent agent, String resourceType) Gets the XML resource type.
protected Request	parseRequest(Request unformattedRequest, CollectionAgent agent, Integer collectionStep, Map<String,String> parameters) Parses the request.
protected String	parseString(String reference, String unformattedString, OnmsNode node, String ipAddress, Integer collectionStep, Map<String,String> parameters) Parses the string.
protected String	parseUrl(String unformattedUrl, CollectionAgent agent, Integer collectionStep, Map<String,String> parameters) Parses the URL.
protected InputStream	preProcessHtml(Request request, InputStream is) Pre-process HTML.
protected abstract void	processXmlResource(XmlCollectionResource collectionResource, AttributeGroupType attribGroupType) Process XML resource.
void	setNodeDao(NodeDao nodeDao) Sets the Node DAO.
void	setResourceStorageDao(ResourceStorageDao resourceStorageDao)
void	setRrdRepository(RrdRepository rrdRepository) Sets the RRD repository.
void	setServiceName(String serviceName) Sets the service name associated with this Collection Handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmlCollectionHandler

public AbstractXmlCollectionHandler()

Method Detail

getResourceStorageDao

public ResourceStorageDao getResourceStorageDao()

setResourceStorageDao

public void setResourceStorageDao(ResourceStorageDao resourceStorageDao)

setServiceName

public void setServiceName(String serviceName)

Description copied from interface: XmlCollectionHandler

Sets the service name associated with this Collection Handler.

Specified by:

setServiceName in interface XmlCollectionHandler

Parameters:

serviceName - the new service name

setRrdRepository

public void setRrdRepository(RrdRepository rrdRepository)

Description copied from interface: XmlCollectionHandler

Sets the RRD repository.

Specified by:

setRrdRepository in interface XmlCollectionHandler

Parameters:

rrdRepository - the new RRD repository

getServiceName

public String getServiceName()

Gets the service name.

Returns:

the service name

getRrdRepository

public RrdRepository getRrdRepository()

Gets the RRD repository.

Returns:

the RRD repository

getNodeDao

public NodeDao getNodeDao()

Gets the Node DAO.

Returns:

the Node DAO

setNodeDao

public void setNodeDao(NodeDao nodeDao)

Sets the Node DAO.

Parameters:

nodeDao - the new Node DAO

collect

public XmlCollectionSet collect(CollectionAgent agent,
                                XmlDataCollection collection,
                                Map<String,Object> parameters)
                         throws CollectionException

Description copied from interface: XmlCollectionHandler

Collect.

Specified by:

collect in interface XmlCollectionHandler

Parameters:

agent - the collection agent

collection - the XML collection configuration

parameters - the collector parameters

Returns:

the XML collection set

Throws:

CollectionException - the collection exception

fillCollectionSet

protected void fillCollectionSet(CollectionAgent agent,
                                 XmlCollectionSet collectionSet,
                                 XmlSource source,
                                 Document doc)
                          throws XPathExpressionException,
                                 ParseException

Fill collection set.

Parameters:

agent - the agent

collectionSet - the collection set

source - the source

doc - the doc

Throws:

XPathExpressionException - the x path expression exception

ParseException - the parse exception

fillCollectionSet

protected abstract void fillCollectionSet(String urlString,
                                          Request request,
                                          CollectionAgent agent,
                                          XmlCollectionSet collectionSet,
                                          XmlSource source)
                                   throws Exception

Fill collection set.

Parameters:

urlString - the URL string

request - the request

agent - the collection agent

collectionSet - the collection set

source - the XML source

Throws:

Exception - the exception

processXmlResource

protected abstract void processXmlResource(XmlCollectionResource collectionResource,
                                           AttributeGroupType attribGroupType)

Process XML resource.

Parameters:

collectionResource - the collection resource

attribGroupType - the attribute group type

getCollectionResource

protected XmlCollectionResource getCollectionResource(CollectionAgent agent,
                                                      String instance,
                                                      String resourceType,
                                                      Date timestamp)

Gets the collection resource.

Parameters:

agent - the collection agent

instance - the resource instance

resourceType - the resource type

timestamp - the timestamp

Returns:

the collection resource

getTimeStamp

protected Date getTimeStamp(Document doc,
                            XPath xpath,
                            XmlGroup group)
                     throws XPathExpressionException

Gets the time stamp.

Parameters:

doc - the doc

xpath - the xpath

group - the group

Returns:

the time stamp

Throws:

XPathExpressionException - the x path expression exception

parseUrl

protected String parseUrl(String unformattedUrl,
                          CollectionAgent agent,
                          Integer collectionStep,
                          Map<String,String> parameters)
                   throws IllegalArgumentException

Parses the URL.

Additional placeholders:

• step, The Collection Step in seconds

Parameters:

unformattedUrl - the unformatted URL

agent - the collection agent

collectionStep - the collection step (in seconds)

parameters - the service parameters

Returns:

the string

Throws:

IllegalArgumentException - the illegal argument exception

parseRequest

protected Request parseRequest(Request unformattedRequest,
                               CollectionAgent agent,
                               Integer collectionStep,
                               Map<String,String> parameters)
                        throws IllegalArgumentException

Parses the request.

Parameters:

unformattedRequest - the unformatted request

agent - the agent

collectionStep - the collection step

parameters - the service parameters

Returns:

the request

Throws:

IllegalArgumentException - the illegal argument exception

parseString

protected String parseString(String reference,
                             String unformattedString,
                             OnmsNode node,
                             String ipAddress,
                             Integer collectionStep,
                             Map<String,String> parameters)
                      throws IllegalArgumentException

Parses the string.

Valid placeholders are:

• ipAddr|ipAddress, The Node IP Address
• step, The Collection Step in seconds
• nodeId, The Node ID
• nodeLabel, The Node Label
• foreignId, The Node Foreign ID
• foreignSource, The Node Foreign Source
• Any asset property defined on the node.

Parameters:

reference - the reference

unformattedString - the unformatted string

node - the node

ipAddress - the IP address

collectionStep - the collection step

parameters - the service parameters

Returns:

the string

Throws:

IllegalArgumentException - the illegal argument exception

getXmlDocument

protected Document getXmlDocument(String urlString,
                                  Request request)
                           throws Exception

Gets the XML document.

Parameters:

urlString - the URL string

request - the request

Returns:

the XML document

Throws:

Exception - the exception

getXmlDocument

protected Document getXmlDocument(InputStream is,
                                  Request request)
                           throws Exception

Gets the XML document.

Parameters:

is - the input stream

request - the request

Returns:

the XML document

Throws:

Exception - the exception

applyXsltTransformation

protected InputStream applyXsltTransformation(Request request,
                                              InputStream is)
                                       throws Exception

Apply XSLT transformation.

Parameters:

request - the request

is - the input stream

Returns:

the input stream

Throws:

Exception - the exception

preProcessHtml

protected InputStream preProcessHtml(Request request,
                                     InputStream is)
                              throws IOException

Pre-process HTML.

Parameters:

request - the request

is - the input stream

Returns:

the updated input stream

Throws:

IOException - Signals that an I/O exception has occurred.

getXmlResourceType

protected XmlResourceType getXmlResourceType(CollectionAgent agent,
                                             String resourceType)

Gets the XML resource type.

Parameters:

agent - the collection agent

resourceType - the resource type

Returns:

the XML resource type

filterParameters

protected Map<String,String> filterParameters(Map<String,Object> input)

Filter out blacklisted key/values out from an input Map.

Parameters:

input - the original parameters

Returns:

a new map containing the filtered parameters