Package org.opennms.features.apilayer.pollers

Class ServicePollerImpl<T extends org.opennms.integration.api.v1.pollers.ServicePoller>

java.lang.Object

org.opennms.features.apilayer.pollers.ServicePollerImpl<T>

Type Parameters:

T -

All Implemented Interfaces:

ServiceMonitor

public class ServicePollerImpl<T extends org.opennms.integration.api.v1.pollers.ServicePoller>
extends Object
implements ServiceMonitor

Maps ServicePollerFactory to ServiceMonitor. The factory mapping is intentional. integration-api will have factories for service pollers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ServicePollerImpl.PollerRequestImpl

Constructor Summary

Constructors

Constructor	Description
ServicePollerImpl(org.opennms.integration.api.v1.pollers.ServicePollerFactory servicePollerFactory)

Method Summary

Modifier and Type	Method	Description
String	getEffectiveLocation(String location)	Allows the monitor to override the location at which it should be run.
Map<String,Object>	getRuntimeAttributes(MonitoredService svc, Map<String,Object> parameters)
PollStatus	poll(MonitoredService svc, Map<String,Object> parameters)	This method is the heart of the plug-in monitor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServicePollerImpl

public ServicePollerImpl(org.opennms.integration.api.v1.pollers.ServicePollerFactory servicePollerFactory)

Method Detail

poll

public PollStatus poll(MonitoredService svc,
                       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).

Specified by:

poll in interface ServiceMonitor

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:

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

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).

getEffectiveLocation

public String getEffectiveLocation(String location)

Description copied from interface: ServiceMonitor

Allows the monitor to override the location at which it should be run.

Specified by:

getEffectiveLocation in interface ServiceMonitor

Parameters:

location - location associated with the service to be monitored

Returns:

a possibly updated location