org.opennms.netmgt.poller.monitors
Class HttpMonitor

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

All Implemented Interfaces:

ServiceMonitor

Direct Known Subclasses:

HttpsMonitor

@Distributable
public class HttpMonitor
extends IPv4Monitor

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

OpenNMS , Tarus Balog , Mike , David Hustace, OpenNMS , Tarus Balog , Mike , David Hustace, OpenNMS , Tarus Balog , Mike , David Hustace, OpenNMS , Tarus Balog , Mike , David Hustace

Constructor Summary

HttpMonitor()

Method Summary

protected int[]	determinePorts(Map<String,Object> parameters) determinePorts
PollStatus	poll(MonitoredService svc, Map<String,Object> parameters) This method is the heart of the plug-in monitor.
protected Socket	wrapSocket(Socket socket) wrapSocket

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

HttpMonitor

public HttpMonitor()

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 HTTP service availability. During the poll an attempt is made to connect on the specified port(s) (by default TCP ports 80, 8080, 8888). If the connection request is successful, an HTTP 'GET' command is sent to the interface. The response is parsed and a return code extracted 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

wrapSocket

protected Socket wrapSocket(Socket socket)
                     throws IOException

wrapSocket

Parameters:

socket - a Socket object.

Returns:

a Socket object.

Throws:

IOException - if any.

determinePorts

protected int[] determinePorts(Map<String,Object> parameters)

determinePorts

Parameters:

parameters - a Map object.

Returns:

an array of int.