org.opennms.netmgt.poller.monitors
Class SnmpMonitor

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

All Implemented Interfaces:

ServiceMonitor

Direct Known Subclasses:

Win32ServiceMonitor

@Distributable(value=DAEMON)
public class SnmpMonitor
extends SnmpMonitorStrategy

This class is designed to be used by the service poller framework to test the availability of the SNMP service on remote interfaces. The class implements the ServiceMonitor interface that allows it to be used along with other plug-ins by the service poller framework.

Author:

Tarus Balog , Mike Davidson , OpenNMS

Field Summary

Fields inherited from class org.opennms.netmgt.poller.monitors.SnmpMonitorStrategy

EQUALS, GREATER_THAN, GREATER_THAN_EQUALS, LESS_THAN, LESS_THAN_EQUALS, MATCHES, NOT_EQUAL

Constructor Summary

SnmpMonitor()

Method Summary

void	initialize(Map parameters) Initialize the service monitor.
void	initialize(MonitoredService svc) Called by the poller framework when an interface is being added to the scheduler.
PollStatus	poll(MonitoredService svc, Map parameters) The poll() method is responsible for polling the specified address for SNMP service availability.
String	serviceName() Returns the name of the service that the plug-in monitors ("SNMP").

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

meetsCriteria

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

log, logDown, logDown, logUp, release, release

Methods inherited from class java.lang.Object

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

Constructor Detail

SnmpMonitor

public SnmpMonitor()

Method Detail

serviceName

public String serviceName()

Returns the name of the service that the plug-in monitors ("SNMP").

Returns:

The service that the plug-in monitors.

initialize

public void initialize(Map parameters)

Initialize the service monitor.

Specified by:

initialize in interface ServiceMonitor

Overrides:

initialize in class IPv4Monitor

Parameters:

parameters - Not currently used.

Throws:

RuntimeException - Thrown if an unrecoverable error occurs that prevents the plug-in from functioning.

initialize

public void initialize(MonitoredService svc)

Called by the poller framework when an interface is being added to the scheduler. Here we perform any necessary initialization to prepare the NetworkInterface object for polling.

Specified by:

initialize in interface ServiceMonitor

Overrides:

initialize in class IPv4Monitor

Parameters:

svc - TODO

Throws:

RuntimeException - Thrown if an unrecoverable error occurs that prevents the interface from being monitored.

poll

public PollStatus poll(MonitoredService svc,
                       Map parameters)

The poll() method is responsible for polling the specified address for SNMP service availability.

Specified by:

poll in interface ServiceMonitor

Specified by:

poll in class SnmpMonitorStrategy

Parameters:

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

iface - The network interface to test the service on.

Returns:

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

Throws:

RuntimeException - Thrown for any uncrecoverable errors.

See Also:

PollStatus.SERVICE_AVAILABLE, PollStatus.SERVICE_UNAVAILABLE