org.opennms.netmgt.poller.monitors

Class SystemExecuteMonitor

java.lang.Object

org.opennms.netmgt.poller.monitors.AbstractServiceMonitor

org.opennms.netmgt.poller.monitors.SystemExecuteMonitor

All Implemented Interfaces:

ServiceMonitor

@Distributable(value=ALL)
public final class SystemExecuteMonitor
extends AbstractServiceMonitor

Constructor Summary

Constructors

Constructor and Description
SystemExecuteMonitor()

Method Summary

Methods

Modifier and Type	Method and Description
PollStatus	poll(MonitoredService svc, Map<String,Object> parameters) This method is the heart of the plug-in monitor.

Methods inherited from class org.opennms.netmgt.poller.monitors.AbstractServiceMonitor

getKeyedBoolean, getKeyedInteger, getKeyedLong, getKeyedObject, getKeyedString, initialize, initialize, release, release

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SystemExecuteMonitor

public SystemExecuteMonitor()

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.

During the poll an attempt is made to call the specified external script or program. The banner line returned as standard output by the script or program is parsed for a partial match with the banner string specified in the poller configuration. Provided that the script's response is valid we set the service status to SERVICE_AVAILABLE and return. The parameter script The parameter args is handed over to the called script. The following variables will be replaced. ${timeout} will be replaced with the specified timeout in milliseconds. ${timeoutsec} will be replaced with the specified timeout in seconds not in milliseconds. ${retry} will be replaced with the amount off specified retires. ${ipaddr} will be replaced with the ip-address of the interface that holds the polled service at the node. ${nodeid} will be replaced with the nodeid of the node that holds the polled service. ${nodelabel} will be replaced with the nodelabel of the node that holds the polled service. ${svcname} will be replaced with the name of the polled service. The timeout is handled by ExecRunner and is also passed as a parameter to the script or program being called.

Specified by:

poll in interface ServiceMonitor

Specified by:

poll in class AbstractServiceMonitor

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