org.opennms.netmgt.collection.support

Class AbstractCollectionResource

java.lang.Object

org.opennms.netmgt.collection.support.AbstractCollectionResource

All Implemented Interfaces:

CollectionResource, CollectionVisitable, Persistable, ResourceIdentifier

public abstract class AbstractCollectionResource
extends Object
implements CollectionResource

A base class for CollectionResource objects, implementing common features (to reduce repeated code). Typically used by the non-SNMP collectors (SNMP has it's own set of classes for this). Provides a basic set of attributes. Provides support, via addAttribute(CollectionAttribute) and getGroup(AttributeGroupType) for basic "groups" of attributes. Also provides a sample "visit" implementation based on those groups, although this may well be overridden by subclasses.

Field Summary

Fields

Modifier and Type	Field and Description
protected CollectionAgent	m_agent

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

RESOURCE_TYPE_IF, RESOURCE_TYPE_NODE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCollectionResource(CollectionAgent agent) Constructor for AbstractCollectionResource.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(CollectionAttribute attr) Adds the given attribute into the collection for this resource
AttributeGroup	getGroup(AttributeGroupType groupType) Finds, or creates, and returns the AttributeGroup for the given group Type
String	getInterfaceLabel() getInterfaceLabel
String	getOwnerName() getOwnerName
ResourcePath	getParent() Returns the name of the parent resource.
ResourcePath	getPath() Retrieves path for the resource, relative to the root of the associated RrdRepository.
TimeKeeper	getTimeKeeper() Returns a not-null TimeKeeper instance when this resource requires to use a special timestamp when updating RRDs/JRBs.
boolean	rescanNeeded() rescanNeeded
boolean	shouldPersist(ServiceParameters params) Resources should be persisted by default.
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, getResourceTypeName

Field Detail

m_agent

protected final CollectionAgent m_agent

Constructor Detail

AbstractCollectionResource

protected AbstractCollectionResource(CollectionAgent agent)

Constructor for AbstractCollectionResource.

Parameters:

agent - a CollectionAgent object.

Method Detail

getOwnerName

public final String getOwnerName()

getOwnerName

Specified by:

getOwnerName in interface ResourceIdentifier

Returns:

a String object.

getPath

public ResourcePath getPath()

Retrieves path for the resource, relative to the root of the associated RrdRepository.

Specified by:

getPath in interface ResourceIdentifier

Returns:

ResourcePath object.

addAttribute

public final void addAttribute(CollectionAttribute attr)

Adds the given attribute into the collection for this resource

Parameters:

attr - The Attribute to add

getGroup

public final AttributeGroup getGroup(AttributeGroupType groupType)

Finds, or creates, and returns the AttributeGroup for the given group Type

Parameters:

groupType - a AttributeGroupType object.

Returns:

a AttributeGroup object.

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.

getParent

public final ResourcePath getParent()

Description copied from interface: CollectionResource

Returns the name of the parent resource.

Specified by:

getParent in interface CollectionResource

Returns:

a String object.

rescanNeeded

public final boolean rescanNeeded()

rescanNeeded

Specified by:

rescanNeeded in interface CollectionResource

Returns:

a boolean.

shouldPersist

public boolean shouldPersist(ServiceParameters params)

Resources should be persisted by default. Returns true.

Specified by:

shouldPersist in interface Persistable

Parameters:

params - a ServiceParameters object.

Returns:

a boolean.

getInterfaceLabel

public String getInterfaceLabel()

getInterfaceLabel

Specified by:

getInterfaceLabel in interface CollectionResource

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

Returns:

Returns null to indicate that DefaultTimeKeeper should be used.