org.opennms.protocols.xml.collector

Class Sftp3gppXmlCollectionHandler

java.lang.Object

org.opennms.protocols.xml.collector.AbstractXmlCollectionHandler

org.opennms.protocols.xml.collector.Sftp3gppXmlCollectionHandler

All Implemented Interfaces:

XmlCollectionHandler

public class Sftp3gppXmlCollectionHandler
extends AbstractXmlCollectionHandler

The custom implementation of the interface XmlCollectionHandler for 3GPP XML Data.

This supports the processing of several files ordered by filename, and the timestamp between files won't be taken in consideration.

The state will be persisted on disk by saving the name of the last successfully processed file.

Author:

Alejandro Galue

Field Summary

Fields

Modifier and Type	Field and Description
static String	PM_GROUPS_FILENAME The Constant PM_GROUPS_FILENAME.
static String	XML_LAST_FILENAME The Constant XML_LAST_FILENAME.

Constructor Summary

Constructors

Constructor and Description
Sftp3gppXmlCollectionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
XmlCollectionSet	collect(CollectionAgent agent, XmlDataCollection collection, Map<String,Object> parameters) Collect.
String	get3gppFormat(String resourceType) Gets the 3GPP resource format.
Map<String,String>	get3gppProperties(String format, String measInfoId) Gets the 3GPP properties based on measInfoId.
protected String	parseUrl(String unformattedUrl, CollectionAgent agent, Integer collectionStep, long currentTimestamp) Parses the URL.
protected void	processXmlResource(XmlCollectionResource resource, AttributeGroupType attribGroupType) Process XML resource.

Methods inherited from class org.opennms.protocols.xml.collector.AbstractXmlCollectionHandler

fillCollectionSet, getCollectionResource, getNodeDao, getRrdRepository, getServiceName, getTimeStamp, getXmlDocument, getXmlDocument, getXmlResourceType, log, parseRequest, parseString, parseUrl, setNodeDao, setRrdRepository, setServiceName

Methods inherited from class java.lang.Object

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

Field Detail

PM_GROUPS_FILENAME

public static final String PM_GROUPS_FILENAME

The Constant PM_GROUPS_FILENAME.

See Also:

Constant Field Values

XML_LAST_FILENAME

public static final String XML_LAST_FILENAME

The Constant XML_LAST_FILENAME.

See Also:

Constant Field Values

Constructor Detail

Sftp3gppXmlCollectionHandler

public Sftp3gppXmlCollectionHandler()

Method Detail

collect

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

Description copied from interface: XmlCollectionHandler

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

processXmlResource

protected void processXmlResource(XmlCollectionResource resource,
                      AttributeGroupType attribGroupType)

Description copied from class: AbstractXmlCollectionHandler

Process XML resource.

Specified by:

processXmlResource in class AbstractXmlCollectionHandler

Parameters:

resource - the collection resource

attribGroupType - the attribute group type

parseUrl

protected String parseUrl(String unformattedUrl,
              CollectionAgent agent,
              Integer collectionStep,
              long currentTimestamp)
                   throws IllegalArgumentException

Parses the URL.

Parameters:

unformattedUrl - the unformatted URL

agent - the agent

collectionStep - the collection step (in seconds)

currentTimestamp - the current timestamp

Returns:

the string

Throws:

IllegalArgumentException

get3gppFormat

public String get3gppFormat(String resourceType)

Gets the 3GPP resource format.

Parameters:

resourceType - the resource type

Returns:

the 3gpp format

get3gppProperties

public Map<String,String> get3gppProperties(String format,
                                   String measInfoId)

Gets the 3GPP properties based on measInfoId.

Parameters:

format - the format

measInfoId - the measInfoId (the resource instance)

Returns:

the properties