Package org.opennms.netmgt.poller.support

Class AbstractServiceMonitor

java.lang.Object

org.opennms.netmgt.poller.support.AbstractServiceMonitor

All Implemented Interfaces:

ServiceMonitor

Direct Known Subclasses:

AbstractVmwareMonitor, ActiveMQMonitor, AsteriskSIPPeerMonitor, AvailabilityMonitor, BSFMonitor, CitrixMonitor, DhcpMonitor, DnsMonitor, DominoIIOPMonitor, GpMonitor, IcmpMonitor, ImapMonitor, JMXMonitor, JschSshMonitor, LoopMonitor, MailTransportMonitor, MemcachedMonitor, MinionHeartbeatMonitor, MinionRpcMonitor, MockMonitor, NrpeMonitor, NsclientMonitor, NtpMonitor, PageSequenceMonitor, ParameterSubstitutingMonitor, PassiveServiceMonitor, Pop3Monitor, SeleniumMonitor, SmbMonitor, SmtpMonitor, SnmpMonitorStrategy, SshMonitor, StrafePingMonitor, SystemExecuteMonitor, TcpMonitor, TrivialTimeMonitor, WebMonitor, WmiMonitor, XmpMonitor

public abstract class AbstractServiceMonitor
extends java.lang.Object
implements ServiceMonitor

This class provides a basic implementation for most of the interface methods of the ServiceMonitor class. Since most pollers do not do any special initialization, and only require that the interface is an InetAddress object this class provides everything by the poll interface.

Author:

Mike, Weave, OpenNMS

Constructor Summary

Constructors

Constructor	Description
AbstractServiceMonitor()

Method Summary

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.
static java.lang.Boolean	getKeyedBoolean(java.util.Map<java.lang.String,java.lang.Object> parameterMap, java.lang.String key, java.lang.Boolean defaultValue)
static <T> T	getKeyedInstance(java.util.Map<java.lang.String,java.lang.Object> parameterMap, java.lang.String key, java.util.function.Supplier<T> defaultValue)
static java.lang.Integer	getKeyedInteger(java.util.Map<java.lang.String,java.lang.Object> parameterMap, java.lang.String key, java.lang.Integer defaultValue)
static java.lang.Long	getKeyedLong(java.util.Map<java.lang.String,java.lang.Object> parameterMap, java.lang.String key, java.lang.Long defaultValue)
static java.lang.Object	getKeyedObject(java.util.Map<java.lang.String,java.lang.Object> parameterMap, java.lang.String key, java.lang.Object defaultValue)
static java.lang.String	getKeyedString(java.util.Map<java.lang.String,java.lang.Object> parameterMap, java.lang.String key, java.lang.String defaultValue)
java.util.Map<java.lang.String,java.lang.Object>	getRuntimeAttributes(MonitoredService svc, java.util.Map<java.lang.String,java.lang.Object> parameters)
static java.util.Properties	getServiceProperties(MonitoredService svc)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennms.netmgt.poller.ServiceMonitor

poll

Constructor Detail

AbstractServiceMonitor

public AbstractServiceMonitor()

Method Detail

getRuntimeAttributes

public java.util.Map<java.lang.String,java.lang.Object> getRuntimeAttributes(MonitoredService svc,
                                                                                   java.util.Map<java.lang.String,java.lang.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 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

getKeyedObject

public static java.lang.Object getKeyedObject(java.util.Map<java.lang.String,java.lang.Object> parameterMap,
                                              java.lang.String key,
                                              java.lang.Object defaultValue)

getKeyedInstance

public static <T> T getKeyedInstance(java.util.Map<java.lang.String,java.lang.Object> parameterMap,
                                     java.lang.String key,
                                     java.util.function.Supplier<T> defaultValue)

getKeyedBoolean

public static java.lang.Boolean getKeyedBoolean(java.util.Map<java.lang.String,java.lang.Object> parameterMap,
                                                java.lang.String key,
                                                java.lang.Boolean defaultValue)

getKeyedString

public static java.lang.String getKeyedString(java.util.Map<java.lang.String,java.lang.Object> parameterMap,
                                              java.lang.String key,
                                              java.lang.String defaultValue)

getKeyedInteger

public static java.lang.Integer getKeyedInteger(java.util.Map<java.lang.String,java.lang.Object> parameterMap,
                                                java.lang.String key,
                                                java.lang.Integer defaultValue)

getKeyedLong

public static java.lang.Long getKeyedLong(java.util.Map<java.lang.String,java.lang.Object> parameterMap,
                                          java.lang.String key,
                                          java.lang.Long defaultValue)

getServiceProperties

public static java.util.Properties getServiceProperties(MonitoredService svc)