org.opennms.netmgt.poller.monitors
Class SmtpMonitor

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

All Implemented Interfaces:

ServiceMonitor

@Distributable
public final class SmtpMonitor
extends IPv4Monitor

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

Constructor Summary

SmtpMonitor()

Method Summary

PollStatus

poll(MonitoredService svc, Map parameters) Poll the specified address for SMTP service availability.

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

SmtpMonitor

public SmtpMonitor()

Method Detail

poll

public PollStatus poll(MonitoredService svc,
                       Map parameters)

Poll the specified address for SMTP service availability.

During the poll an attempt is made to connect on the specified port (by default TCP port 25). If the connection request is successful, the banner line generated by the interface is parsed and if the extracted return code indicates that we are talking to an SMTP server we continue. Next, an SMTP 'HELO' command is sent to the interface. Again the response is parsed and a return code extracted and verified. Finally, an SMTP 'QUIT' command is sent. 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:

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

iface - The network interface to test the service on.

Returns:

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

See Also:

PollStatus.SERVICE_AVAILABLE, PollStatus.SERVICE_UNAVAILABLE