org.opennms.netmgt.poller.monitors
Class Pop3Monitor

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

All Implemented Interfaces:

ServiceMonitor

@Distributable
public final class Pop3Monitor
extends IPv4Monitor

This class is designed to be used by the service poller framework to test the availability of the POP3 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.

Version:

$Id: $

Author:

Tarus Balog , Mike , OpenNMS , Tarus Balog , Mike , OpenNMS , Tarus Balog , Mike , OpenNMS

Constructor Summary

Pop3Monitor()

Method Summary

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

Constructor Detail

Pop3Monitor

public Pop3Monitor()

Method Detail

poll

public 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.

Poll the specified address for POP3 service availability.

During the poll an attempt is made to connect on the specified port (by default TCP port 110). If the connection request is successful, the banner line generated by the interface is parsed and if the response indicates that we are talking to an POP3 server we continue. Next, a POP3 'QUIT' command is sent to the interface. Again the response is parsed and verified. Provided that the interface's response is valid we set the service status to SERVICE_AVAILABLE and return.

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