Package org.opennms.features.apilayer.pollers

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

  • Type Parameters:
    T -
    All Implemented Interfaces:
    ServiceMonitor
    public class ServicePollerImpl<T extends org.opennms.integration.api.v1.pollers.ServicePoller>
extends java.lang.Object
implements ServiceMonitor
    Maps ServicePollerFactory to ServiceMonitor. The factory mapping is intentional. integration-api will have factories for service pollers.

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getEffectiveLocation​(java.lang.String location)
      Allows the monitor to override the location at which it should be run.
      java.util.Map<java.lang.String,​java.lang.Object> getRuntimeAttributes​(MonitoredService svc, java.util.Map<java.lang.String,​java.lang.Object> parameters)  
      PollStatus poll​(MonitoredService svc, java.util.Map<java.lang.String,​java.lang.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,
                       java.util.Map<java.lang.String,​java.lang.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

      • getEffectiveLocation

        public java.lang.String getEffectiveLocation​(java.lang.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