org.opennms.netmgt.poller.monitors
Class MailTransportMonitor

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

All Implemented Interfaces:

ServiceMonitor

@Distributable
public class MailTransportMonitor
extends IPv4Monitor

This ServiceMonitor is designed to monitor the transport of SMTP email. Use cases: a) Class will test that it can successfully send an email. b) Class will test that it can successfully connect to a mail server and get mailbox contents. c) Class will test that it can successfully read a new email message from a mail server. d) Class will test that it can send an email and read that same email from a mail server.

Author:

David Hustace

Constructor Summary

MailTransportMonitor()

Method Summary

PollStatus

poll(MonitoredService svc, Map 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

MailTransportMonitor

public MailTransportMonitor()

Method Detail

poll

public PollStatus poll(MonitoredService svc,
                       Map parameters)

Description copied from interface: ServiceMonitor

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