org.opennms.netmgt.poller.monitors
Class WmiMonitor

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

All Implemented Interfaces:

ServiceMonitor

@Distributable
public class WmiMonitor
extends IPv4Monitor

This class is designed to be used by the service poller framework to test the availability of WMI services on remote interfaces. The class implements the IPv4Monitor interface that allows it to be used along with other plug-ins by the service poller framework.

Version:

$Id: $

Author:

Matt Raykowski, OpenNMS , Matt Raykowski, OpenNMS

Constructor Summary

WmiMonitor()

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

WmiMonitor

public WmiMonitor()

Method Detail

poll

public PollStatus poll(MonitoredService svc,
                       Map 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 service availability. During the poll an attempt is made to connect the WMI agent on the specified host. If the connection request is successful, the parameters are parsed and turned into WmiParams and a check is performed against the remote WMI service. If the WmiManager responds with a WmiResult containing a result code of WmiResult.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:

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