org.opennms.netmgt.config.collector
Interface CollectionResource

All Superinterfaces:

ResourceIdentifier

All Known Implementing Classes:

AbstractCollectionResource, AliasedResource, GenericIndexResource, IfInfo, JdbcCollectionResource, JdbcMultiInstanceCollectionResource, JdbcSingleInstanceCollectionResource, LatencyCollectionResource, NodeInfo, SnmpCollectionResource, WmiCollectionResource, WmiMultiInstanceCollectionResource, WmiSingleInstanceCollectionResource, XmlCollectionResource, XmlMultiInstanceCollectionResource, XmlSingleInstanceCollectionResource

public interface CollectionResource
extends ResourceIdentifier

CollectionResource interface.

Version:

$Id: $

Author:

ranger

Method Summary

String	getInstance() Returns the name of the instance this CollectionResource represents.
String	getLabel() Returns a unique label for each resource depending on resource type.
String	getParent() Returns the name of the parent resource.
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() Returns something like an ifType; is (but not sure if it should be) -1 for non interface type collections, otherwise the SNMP type of the interface.
boolean	rescanNeeded() rescanNeeded
boolean	shouldPersist(ServiceParameters params) shouldPersist
void	visit(CollectionSetVisitor visitor) visit

Methods inherited from interface org.opennms.netmgt.config.collector.ResourceIdentifier

getOwnerName, getResourceDir

Method Detail

shouldPersist

boolean shouldPersist(ServiceParameters params)

shouldPersist

Parameters:

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

Returns:

a boolean.

rescanNeeded

boolean rescanNeeded()

rescanNeeded

Returns:

a boolean.

visit

void visit(CollectionSetVisitor visitor)

visit

Parameters:

visitor - a org.opennms.netmgt.collectd.CollectionSetVisitor object.

getType

int getType()

Returns something like an ifType; is (but not sure if it should be) -1 for non interface type collections, otherwise the SNMP type of the interface. Relates to ifType in datacollection-config.xml

Returns:

a int.

getResourceTypeName

String getResourceTypeName()

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.

getParent

String getParent()

Returns the name of the parent resource.

Returns:

a String object.

getInstance

String getInstance()

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.

getLabel

String getLabel()

Returns a unique label for each resource depending on resource type. This label is the same label used when constructing the resource ID.

Returns:

a String object.

getTimeKeeper

TimeKeeper getTimeKeeper()

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.

Returns:

a TimeKeeper object.