Package org.opennms.protocols.xml.collector

Interface XmlCollectionHandler

All Known Implementing Classes:

AbstractJsonCollectionHandler, AbstractVTDXmlCollectionHandler, AbstractXmlCollectionHandler, DefaultJsonCollectionHandler, DefaultVTDXmlCollectionHandler, DefaultXmlCollectionHandler, HttpCollectionHandler, Sftp3gppVTDXmlCollectionHandler, Sftp3gppXmlCollectionHandler

public interface XmlCollectionHandler

The Class XML Collection Handler.

Author:

Alejandro Galue

Method Summary

Modifier and Type	Method	Description
CollectionSet	collect(CollectionAgent agent, XmlDataCollection collection, java.util.Map<java.lang.String,java.lang.Object> parameters)	Collect.
Request	parseRequest(NodeDao nodeDao, Request unformattedRequest, CollectionAgent agent, java.lang.Integer collectionStep, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	parseUrl(NodeDao nodeDao, java.lang.String unformattedUrl, CollectionAgent agent, java.lang.Integer collectionStep, java.util.Map<java.lang.String,java.lang.String> parameters)
void	setRrdRepository(RrdRepository repository)	Sets the RRD repository.
void	setServiceName(java.lang.String serviceName)	Sets the service name associated with this Collection Handler.

Method Detail

collect

CollectionSet collect(CollectionAgent agent,
                      XmlDataCollection collection,
                      java.util.Map<java.lang.String,java.lang.Object> parameters)
               throws CollectionException

Collect.

Parameters:

agent - the collection agent

collection - the XML collection configuration

parameters - the collector parameters

Returns:

the XML collection set

Throws:

CollectionException - the collection exception

setRrdRepository

void setRrdRepository(RrdRepository repository)

Sets the RRD repository.

Parameters:

repository - the new RRD repository

setServiceName

void setServiceName(java.lang.String serviceName)

Sets the service name associated with this Collection Handler.

Parameters:

serviceName - the new service name

parseUrl

java.lang.String parseUrl(NodeDao nodeDao,
                          java.lang.String unformattedUrl,
                          CollectionAgent agent,
                          java.lang.Integer collectionStep,
                          java.util.Map<java.lang.String,java.lang.String> parameters)
                   throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

parseRequest

Request parseRequest(NodeDao nodeDao,
                     Request unformattedRequest,
                     CollectionAgent agent,
                     java.lang.Integer collectionStep,
                     java.util.Map<java.lang.String,java.lang.String> parameters)
              throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException