Package org.opennms.netmgt.collectd

Class SnmpCollectionResource

java.lang.Object

org.opennms.netmgt.collectd.SnmpCollectionResource

All Implemented Interfaces:

CollectionResource, CollectionVisitable, Persistable, ResourceIdentifier

Direct Known Subclasses:

AliasedResource, GenericIndexResource, IfInfo, NodeInfo

public abstract class SnmpCollectionResource
extends Object
implements CollectionResource

Abstract SnmpCollectionResource class.

Version:

$Id: $

Author:

ranger

Field Summary

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

RESOURCE_TYPE_IF, RESOURCE_TYPE_LATENCY, RESOURCE_TYPE_NODE

Constructor Summary

Constructors

Constructor	Description
SnmpCollectionResource(ResourceType def)	Constructor for SnmpCollectionResource.

Method Summary

Modifier and Type	Method	Description
CollectionAgent	getCollectionAgent()	getCollectionAgent
protected Collection<AttributeGroup>	getGroups()	getGroups
protected AttributeGroupType	getGroupType(String groupName)
String	getOwnerName()	getOwnerName
ResourceType	getResourceType()	getResourceType
abstract int	getSnmpIfType()	Returns ifType; is (but not sure if it should be) -1 for non interface type collections, otherwise the SNMP type of the interface.
List<CollectionAttribute>	getStringAttributes()
TimeKeeper	getTimeKeeper()	Returns a not-null TimeKeeper instance when this resource requires to use a special timestamp when updating RRDs/JRBs.
boolean	rescanNeeded()	rescanNeeded
void	setAttributeValue(SnmpAttributeType type, SnmpValue val)	setAttributeValue
abstract boolean	shouldPersist(ServiceParameters params)	Determines whether the attribute should be persisted.
void	visit(CollectionSetVisitor visitor)	Provide a way to visit all the values in the CollectionSet, for any appropriate purposes (persisting, thresholding, or others) The expectation is that calling this method will ultimately call visitResource, visitGroup and visitAttribute (as appropriate)

Methods inherited from class java.lang.Object

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

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

getInstance, getInterfaceLabel, getParent, getResourceTypeName, getUnmodifiedInstance

Methods inherited from interface org.opennms.netmgt.collection.api.ResourceIdentifier

getPath

Constructor Detail

SnmpCollectionResource

public SnmpCollectionResource(ResourceType def)

Constructor for SnmpCollectionResource.

Parameters:

def - a ResourceType object.

Method Detail

getResourceType

public ResourceType getResourceType()

getResourceType

Returns:

a ResourceType object.

getCollectionAgent

public final CollectionAgent getCollectionAgent()

getCollectionAgent

Returns:

a CollectionAgent object.

shouldPersist

public abstract boolean shouldPersist(ServiceParameters params)

Determines whether the attribute should be persisted.

Specified by:

shouldPersist in interface Persistable

Parameters:

params - a ServiceParameters object.

Returns:

a boolean.

getOwnerName

public String getOwnerName()

getOwnerName

Specified by:

getOwnerName in interface ResourceIdentifier

Returns:

a String object.

getSnmpIfType

public abstract int getSnmpIfType()

Returns ifType; is (but not sure if it should be) -1 for non interface type collections, otherwise the SNMP type of the interface. This field is used to match the ifType field of the group from datacollection-config.xml.

Returns:

a int.

rescanNeeded

public boolean rescanNeeded()

rescanNeeded

Specified by:

rescanNeeded in interface CollectionResource

Returns:

a boolean.

setAttributeValue

public void setAttributeValue(SnmpAttributeType type,
                              SnmpValue val)

setAttributeValue

Parameters:

type - a SnmpAttributeType object.

val - a SnmpValue object.

getGroupType

protected AttributeGroupType getGroupType(String groupName)

visit

public void visit(CollectionSetVisitor visitor)

Provide a way to visit all the values in the CollectionSet, for any appropriate purposes (persisting, thresholding, or others) The expectation is that calling this method will ultimately call visitResource, visitGroup and visitAttribute (as appropriate)

Specified by:

visit in interface CollectionVisitable

Parameters:

visitor - a CollectionSetVisitor object.

getGroups

protected Collection<AttributeGroup> getGroups()

getGroups

Returns:

a Collection object.

getStringAttributes

public List<CollectionAttribute> getStringAttributes()

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

Returns:

a TimeKeeper object or null to indicate that DefaultTimeKeeper should be used.