org.opennms.protocols.xml.collector

Class XmlCollectionResource

java.lang.Object

org.opennms.netmgt.collectd.AbstractCollectionResource

org.opennms.protocols.xml.collector.XmlCollectionResource

All Implemented Interfaces:

CollectionResource, 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.collectd.AbstractCollectionResource

m_agent

Constructor Summary

Constructors

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

Method Summary

Methods

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

Methods inherited from class org.opennms.netmgt.collectd.AbstractCollectionResource

addAttribute, getGroup, getLabel, getOwnerName, getResourceDir, 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

shouldPersist

public boolean shouldPersist(ServiceParameters params)

Description copied from class: AbstractCollectionResource

shouldPersist

Specified by:

shouldPersist in interface CollectionResource

Specified by:

shouldPersist in class AbstractCollectionResource

Parameters:

params - a org.opennms.netmgt.collectd.ServiceParameters object.

Returns:

a boolean.

rescanNeeded

public boolean rescanNeeded()

Description copied from class: AbstractCollectionResource

rescanNeeded

Specified by:

rescanNeeded in interface CollectionResource

Specified by:

rescanNeeded in class AbstractCollectionResource

Returns:

a boolean.

setAttributeValue

public void setAttributeValue(XmlCollectionAttributeType type,
                     String value)

Sets the attribute value.

Parameters:

type - the type

value - the value

getType

public int getType()

Description copied from class: AbstractCollectionResource

getType

Specified by:

getType in interface CollectionResource

Specified by:

getType in class AbstractCollectionResource

Returns:

a int.

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

Returns:

a String object.

getParent

public String getParent()

Description copied from interface: CollectionResource

Returns the name of the parent resource.

Returns:

a String object.

getTimeKeeper

public TimeKeeper getTimeKeeper()

Description copied from interface: CollectionResource

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

Specified by:

getTimeKeeper in interface CollectionResource

Overrides:

getTimeKeeper in class AbstractCollectionResource

Returns:

a TimeKeeper object.

setTimeKeeper

public void setTimeKeeper(TimeKeeper timeKeeper)

Sets the time keeper.

Parameters:

timeKeeper - the new time keeper