org.opennms.netmgt.poller.monitors
Class NsclientMonitor

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

All Implemented Interfaces:

ServiceMonitor

@Distributable
public class NsclientMonitor
extends IPv4Monitor

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

Matt Raykowski, OpenNMS

Constructor Summary

NsclientMonitor()

Method Summary

PollStatus

poll(MonitoredService svc, Map parameters) Poll the specified address for 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

NsclientMonitor

public NsclientMonitor()

Method Detail

poll

public PollStatus poll(MonitoredService svc,
                       Map parameters)

Poll the specified address for service availability. During the poll an attempt is made to connect on the specified port. If the connection request is successful, the parameters are parsed and turned into NsclientCheckParams and a check is performed against the remote NSClient service. If the NsclientManager responds with a NsclientPacket containing a result code of NsclientPacket.RES_STATE_OK then we have determined that we are talking to a valid service and 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.

Throws:

RuntimeException - Thrown if the interface experiences errors during the poll.

See Also:

PollStatus.SERVICE_AVAILABLE, PollStatus.SERVICE_UNAVAILABLE