org.opennms.netmgt.poller.monitors
Class SnmpMonitorStrategy

java.lang.Object
  org.opennms.netmgt.poller.monitors.IPv4Monitor
      org.opennms.netmgt.poller.monitors.SnmpMonitorStrategy

All Implemented Interfaces:

ServiceMonitor

Direct Known Subclasses:

BgpSessionMonitor, CiscoIpSlaMonitor, CiscoPingMibMonitor, DiskUsageMonitor, HostResourceSwRunMonitor, OmsaStorageMonitor, OpenManageChassisMonitor, PercMonitor, SnmpMonitor

public abstract class SnmpMonitorStrategy
extends IPv4Monitor

Abstract SnmpMonitorStrategy class.

Version:

$Id: $

Author:

david

Field Summary

protected static String	EQUALS Constant EQUALS="="
protected static String	GREATER_THAN Constant GREATER_THAN=">"
protected static String	GREATER_THAN_EQUALS Constant GREATER_THAN_EQUALS=">="
protected static String	LESS_THAN Constant for less-than operand
protected static String	LESS_THAN_EQUALS Constant LESS_THAN_EQUALS="<="
protected static String	MATCHES Constant MATCHES="~"
protected static String	NOT_EQUAL Constant NOT_EQUAL="!="

Constructor Summary

SnmpMonitorStrategy()

Method Summary

boolean	meetsCriteria(SnmpValue result, String operator, String operand) Verifies that the result of the SNMP query meets the criteria specified by the operator and the operand from the configuration file.
abstract PollStatus	poll(MonitoredService svc, Map<String,Object> parameters) This method is the heart of the plug-in monitor.

Methods inherited from class org.opennms.netmgt.poller.monitors.IPv4Monitor

initialize, initialize, log, logDown, logDown, logUp, release, release

Methods inherited from class java.lang.Object

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

Field Detail

LESS_THAN

protected static final String LESS_THAN

Constant for less-than operand

See Also:

Constant Field Values

GREATER_THAN

protected static final String GREATER_THAN

Constant GREATER_THAN=">"

See Also:

Constant Field Values

LESS_THAN_EQUALS

protected static final String LESS_THAN_EQUALS

Constant LESS_THAN_EQUALS="<="

See Also:

Constant Field Values

GREATER_THAN_EQUALS

protected static final String GREATER_THAN_EQUALS

Constant GREATER_THAN_EQUALS=">="

See Also:

Constant Field Values

EQUALS

protected static final String EQUALS

Constant EQUALS="="

See Also:

Constant Field Values

NOT_EQUAL

protected static final String NOT_EQUAL

Constant NOT_EQUAL="!="

See Also:

Constant Field Values

MATCHES

protected static final String MATCHES

Constant MATCHES="~"

See Also:

Constant Field Values

Constructor Detail

SnmpMonitorStrategy

public SnmpMonitorStrategy()

Method Detail

poll

public abstract PollStatus poll(MonitoredService svc,
                                Map<String,Object> parameters)

This method is the heart of the plug-in monitor. Each time an interface requires a check to be performed as defined by the scheduler the poll method is invoked. The poll is passed the interface to check

By default when the status transition from up to down or vice versa the framework will generate an event. Additionally, if the polling interval changes due to an extended unavailability, the framework will generate an additional down event. The plug-in can suppress the generation of the default events by setting the suppress event bit in the returned integer.

Specified by:

poll in interface ServiceMonitor

Specified by:

poll in class IPv4Monitor

Parameters:

svc - TODO

parameters - The package parameters (timeout, retry, etc...) to be used for this poll.

Returns:

The availability of the interface and if a transition event should be suppressed.

See Also:

PollStatus.SERVICE_AVAILABLE, PollStatus.SERVICE_UNAVAILABLE, PollStatus.SERVICE_AVAILABLE, PollStatus.SERVICE_UNAVAILABLE

meetsCriteria

public boolean meetsCriteria(SnmpValue result,
                             String operator,
                             String operand)

Verifies that the result of the SNMP query meets the criteria specified by the operator and the operand from the configuration file.

Parameters:

result - a SnmpValue object.

operator - a String object.

operand - a String object.

Returns:

a boolean.