org.opennms.protocols.xml.collector

Class XmlCollectionResource

java.lang.Object

org.opennms.netmgt.collection.support.AbstractCollectionResource

org.opennms.protocols.xml.collector.XmlCollectionResource

All Implemented Interfaces:

CollectionResource, CollectionVisitable, Persistable, ResourceIdentifier

Direct Known Subclasses:

XmlMultiInstanceCollectionResource, XmlSingleInstanceCollectionResource

public abstract class XmlCollectionResource
extends AbstractCollectionResource

The abstract Class XmlCollectionResource.

Author:

Alejandro Galue

Field Summary

Fields inherited from class org.opennms.netmgt.collection.support.AbstractCollectionResource

m_agent

Fields inherited from interface org.opennms.netmgt.collection.api.CollectionResource

RESOURCE_TYPE_IF, RESOURCE_TYPE_NODE

Constructor Summary

Constructors

Constructor and Description
XmlCollectionResource(CollectionAgent agent) Instantiates a new XML collection resource.

Method Summary

Modifier and Type	Method and Description
abstract String	getInstance() Returns the name of the instance this CollectionResource represents.
abstract String	getResourceTypeName() Returns a string which indicates what type of resource.
TimeKeeper	getTimeKeeper() Returns a not-null TimeKeeper instance when this resource requires to use a special timestamp when updating RRDs/JRBs.
void	setAttributeValue(XmlCollectionAttributeType type, String value) Sets the attribute value.
void	setTimeKeeper(TimeKeeper timeKeeper) Sets the time keeper.

Methods inherited from class org.opennms.netmgt.collection.support.AbstractCollectionResource

addAttribute, getGroup, getInterfaceLabel, getOwnerName, getParent, getPath, rescanNeeded, shouldPersist, visit

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlCollectionResource

public XmlCollectionResource(CollectionAgent agent)

Instantiates a new XML collection resource.

Parameters:

agent - the agent

Method Detail

setAttributeValue

public void setAttributeValue(XmlCollectionAttributeType type,
                              String value)

Sets the attribute value.

Parameters:

type - the type

value - the value

getResourceTypeName

public abstract String getResourceTypeName()

Description copied from interface: CollectionResource

Returns a string which indicates what type of resource. Will be one of "node" for the node level resource "if" for network interface resources "*" for all other resource types defined in the relevant config files, e.g. hrStorage

Returns:

a String object.

getInstance

public abstract String getInstance()

Description copied from interface: CollectionResource

Returns the name of the instance this CollectionResource represents. For node level resources, this will be null to indicate the default instance. For interface level resources, some label unique to the node (ifIndex probably). For Generic resources (e.g. the SNMP GenericIndexResource), this will be some identifying label, probably the index in the table. This value is used by the StorageStrategy implementations to figure out the label for the resource which is used in constructing its RRD directory.

Returns:

a String object.

getTimeKeeper

public TimeKeeper getTimeKeeper()

Description copied from interface: CollectionResource

Returns a not-null TimeKeeper instance when this resource requires to use a special timestamp when updating RRDs/JRBs. If the resource doesn't need a special TimeKeeper it should return null.

Specified by:

getTimeKeeper in interface CollectionResource

Overrides:

getTimeKeeper in class AbstractCollectionResource

Returns:

Returns null to indicate that DefaultTimeKeeper should be used.

setTimeKeeper

public void setTimeKeeper(TimeKeeper timeKeeper)

Sets the time keeper.

Parameters:

timeKeeper - the new time keeper