org.opennms.netmgt.threshd

Class ThresholdingVisitor

java.lang.Object

org.opennms.netmgt.collection.support.AbstractCollectionSetVisitor

org.opennms.netmgt.threshd.ThresholdingVisitor

All Implemented Interfaces:

CollectionSetVisitor

public class ThresholdingVisitor
extends AbstractCollectionSetVisitor

Implements CollectionSetVisitor to implement thresholding. Works by simply recording all the attributes that come in via visitAttribute into an internal data structure, per resource, and then on "completeResource", does threshold checking against that in memory structure. Suggested usage is one per CollectableService; this object holds the current state of thresholds for this interface/service combination (so perhaps needs a better name than ThresholdingVisitor) Assumes and requires that the any visitation start at CollectionSet level, so that the collection timestamp can be recorded.

Version:

$Id: $

Author:

Alejandro Galue, Craig Miskell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThresholdingVisitor.ThresholdingResult

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ThresholdingVisitor(CollectorThresholdingSet thresholdingSet) Constructor for ThresholdingVisitor.

Method Summary

Methods

Modifier and Type	Method and Description
void	completeResource(CollectionResource resource) Apply threshold for specific resource (and required attributes).
static ThresholdingVisitor	create(int nodeId, String hostAddress, String serviceName, RrdRepository repo, ServiceParameters svcParams) Static method create must be used to create new ThresholdingVisitor instance.
Date	getCollectionTimestamp() Return the collection timestamp passed in at construct time.
boolean	hasThresholds()
boolean	isNodeInOutage()
void	reload() Force reload thresholds configuration, and merge threshold states
void	reloadScheduledOutages()
void	setCounterReset(boolean counterReset)
String	toString()
void	visitAttribute(CollectionAttribute attribute) Add/Update required attributes for thresholds on m_attributeMap.
void	visitCollectionSet(CollectionSet set) visitCollectionSet
void	visitResource(CollectionResource resource) Clear required attributes map

Methods inherited from class org.opennms.netmgt.collection.support.AbstractCollectionSetVisitor

completeAttribute, completeCollectionSet, completeGroup, visitGroup

Methods inherited from class java.lang.Object

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

Constructor Detail

ThresholdingVisitor

protected ThresholdingVisitor(CollectorThresholdingSet thresholdingSet)

Constructor for ThresholdingVisitor.

Parameters:

thresholdingSet - a CollectorThresholdingSet object.

Method Detail

create

public static ThresholdingVisitor create(int nodeId,
                         String hostAddress,
                         String serviceName,
                         RrdRepository repo,
                         ServiceParameters svcParams)

Static method create must be used to create new ThresholdingVisitor instance. Is static because successful creation depends on thresholding-enabled parameter.

Parameters:

nodeId - a int.

hostAddress - a String object.

serviceName - a String object.

repo - a RrdRepository object.

svcParams - a ServiceParameters object.

Returns:

a ThresholdingVisitor object.

setCounterReset

public void setCounterReset(boolean counterReset)

hasThresholds

public boolean hasThresholds()

visitCollectionSet

public void visitCollectionSet(CollectionSet set)

Description copied from class: AbstractCollectionSetVisitor

visitCollectionSet

Specified by:

visitCollectionSet in interface CollectionSetVisitor

Overrides:

visitCollectionSet in class AbstractCollectionSetVisitor

Parameters:

set - a org.opennms.netmgt.collectd.CollectionSet object.

reload

public void reload()

Force reload thresholds configuration, and merge threshold states

reloadScheduledOutages

public void reloadScheduledOutages()

isNodeInOutage

public boolean isNodeInOutage()

visitResource

public void visitResource(CollectionResource resource)

Clear required attributes map

Specified by:

visitResource in interface CollectionSetVisitor

Overrides:

visitResource in class AbstractCollectionSetVisitor

Parameters:

resource - a CollectionResource object.

visitAttribute

public void visitAttribute(CollectionAttribute attribute)

Add/Update required attributes for thresholds on m_attributeMap. This is used because CollectionResource does not have direct reference to their attributes. (The way to get attribute is against AttributeGroup object contained on CollectionResource implementations).

Specified by:

visitAttribute in interface CollectionSetVisitor

Overrides:

visitAttribute in class AbstractCollectionSetVisitor

Parameters:

attribute - a org.opennms.netmgt.collection.api.collectd.CollectionAttribute object.

completeResource

public void completeResource(CollectionResource resource)

Apply threshold for specific resource (and required attributes). Send thresholds events (if exists).

Specified by:

completeResource in interface CollectionSetVisitor

Overrides:

completeResource in class AbstractCollectionSetVisitor

Parameters:

resource - a CollectionResource object.

getCollectionTimestamp

public Date getCollectionTimestamp()

Return the collection timestamp passed in at construct time. Typically used by tests, but might be useful elsewhere

toString

public String toString()

Overrides:

toString in class Object