Package org.opennms.netmgt.mock

Class MockMonitor

java.lang.Object

org.opennms.netmgt.poller.support.AbstractServiceMonitor

org.opennms.netmgt.mock.MockMonitor

All Implemented Interfaces:

ServiceMonitor

public class MockMonitor
extends AbstractServiceMonitor

Constructor Summary

Constructors

Constructor	Description
MockMonitor()	Simple constructor so that the MockMonitor can be used as a placeholder ServiceMonitor inside config files.
MockMonitor(MockNetwork network, String svcName)

Method Summary

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

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

getEffectiveLocation, getKeyedBoolean, getKeyedInstance, getKeyedInteger, getKeyedLong, getKeyedObject, getKeyedString, getServiceProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

MockMonitor

public MockMonitor()

Simple constructor so that the MockMonitor can be used as a placeholder ServiceMonitor inside config files.

MockMonitor

public MockMonitor(MockNetwork network,
                   String svcName)

Parameters:

network -

svcName -

Method Detail

poll

public PollStatus poll(MonitoredService monSvc,
                       Map<String,Object> 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 service 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.

NOTE: This method may be invoked on a Minion, in which case certain bean and facilities will not be available. If any state related information is required such as agent related configuration, it should retrieved by the ServiceMonitor.getRuntimeAttributes(MonitoredService, Map).

Parameters:

monSvc - Includes details about to the service being monitored.

parameters - Includes the service parameters defined in poller-configuration.xml and those returned by ServiceMonitor.getRuntimeAttributes(MonitoredService, Map).

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

getRuntimeAttributes

public Map<String,Object> getRuntimeAttributes(MonitoredService svc,
                                                     Map<String,Object> parameters)

Specified by:

getRuntimeAttributes in interface ServiceMonitor

Overrides:

getRuntimeAttributes in class AbstractServiceMonitor

Parameters:

svc - Includes details about to the service being monitored.

parameters - Includes the service parameters defined in poller-configuration.xml and those returned by ServiceMonitor.getRuntimeAttributes(MonitoredService, Map).

Returns:

Additional attributes, which should be added to the parameter map before calling ServiceMonitor.poll(MonitoredService, Map).