org.opennms.netmgt.collectd

Class AbstractCollectionResource

java.lang.Object

org.opennms.netmgt.collectd.AbstractCollectionResource

All Implemented Interfaces:

CollectionResource, ResourceIdentifier

Direct Known Subclasses:

JdbcCollectionResource, TcaCollectionResource, VmwareCimCollectionResource, VmwareCollectionResource, WmiCollectionResource, XmlCollectionResource

public abstract class AbstractCollectionResource
extends Object
implements CollectionResource

A base (partial) implementation of CollectionResource, 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 group of ag Provides support, via addAttribute, getGroup, and getGroups, for basic "groups" of attributes. Also provides a sample "visit" implementation based on those groups, although this may well be overridden by subclasses

Version:

$Id: $

Author:

opennms

Field Summary

Fields

Modifier and Type	Field and Description
protected CollectionAgent	m_agent

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAttribute(CollectionAttribute attr) Adds the given attribute into the collection for this resource
protected AttributeGroup	getGroup(AttributeGroupType groupType) Finds, or creates, and returns the AttributeGroup for the given group Type
String	getLabel() getLabel
String	getOwnerName() getOwnerName
File	getResourceDir(RrdRepository repository) getResourceDir
TimeKeeper	getTimeKeeper() Returns a not-null time tracker instance when this resource requires to use a special timestamp when updating RRDs/JRBs.
abstract int	getType() getType
abstract boolean	rescanNeeded() rescanNeeded
abstract boolean	shouldPersist(ServiceParameters params) shouldPersist
void	visit(CollectionSetVisitor visitor) visit

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.config.collector.CollectionResource

getInstance, getParent, getResourceTypeName

Field Detail

m_agent

protected CollectionAgent m_agent

Constructor Detail

AbstractCollectionResource

protected AbstractCollectionResource(CollectionAgent agent)

Constructor for AbstractCollectionResource.

Parameters:

agent - a CollectionAgent object.

Method Detail

getOwnerName

public String getOwnerName()

getOwnerName

Specified by:

getOwnerName in interface ResourceIdentifier

Returns:

a String object.

getResourceDir

public File getResourceDir(RrdRepository repository)

getResourceDir

Specified by:

getResourceDir in interface ResourceIdentifier

Parameters:

repository - a RrdRepository object.

Returns:

a File object.

addAttribute

protected void addAttribute(CollectionAttribute attr)

Adds the given attribute into the collection for this resource

Parameters:

attr - The Attribute to add

getGroup

protected 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)

visit

Specified by:

visit in interface CollectionResource

Parameters:

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

getType

public abstract int getType()

getType

Specified by:

getType in interface CollectionResource

Returns:

a int.

rescanNeeded

public abstract boolean rescanNeeded()

rescanNeeded

Specified by:

rescanNeeded in interface CollectionResource

Returns:

a boolean.

shouldPersist

public abstract boolean shouldPersist(ServiceParameters params)

shouldPersist

Specified by:

shouldPersist in interface CollectionResource

Parameters:

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

Returns:

a boolean.

getLabel

public String getLabel()

getLabel

Specified by:

getLabel in interface CollectionResource

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

Returns:

a TimeKeeper object.