org.opennms.netmgt.provision.adapters.link

Class EndPointMonitor

java.lang.Object

org.opennms.netmgt.poller.monitors.AbstractServiceMonitor

org.opennms.netmgt.provision.adapters.link.EndPointMonitor

All Implemented Interfaces:

ServiceMonitor

public class EndPointMonitor
extends AbstractServiceMonitor

EndPointMonitor class.

Version:

$Id: $

Author:

ranger

Field Summary

Fields

Modifier and Type	Field and Description
static String	SNMP_AGENTCONFIG_KEY Constant SNMP_AGENTCONFIG_KEY="org.opennms.netmgt.snmp.SnmpAgentConfig"

Constructor Summary

Constructors

Constructor and Description
EndPointMonitor() Constructor for EndPointMonitor.

Method Summary

Methods

Modifier and Type	Method and Description
void	initialize(Map<String,Object> parameters) This method is called after the framework creates an instance of the plug-in.
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, release, release

Methods inherited from class java.lang.Object

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

Field Detail

SNMP_AGENTCONFIG_KEY

public static final String SNMP_AGENTCONFIG_KEY

Constant SNMP_AGENTCONFIG_KEY="org.opennms.netmgt.snmp.SnmpAgentConfig"

See Also:

Constant Field Values

Constructor Detail

EndPointMonitor

public EndPointMonitor()

Constructor for EndPointMonitor.

Method Detail

initialize

public void initialize(Map<String,Object> parameters)

This method is called after the framework creates an instance of the plug-in. The framework passes the object a proxy object that can be used to retrieve configuration information specific to the plug-in. Additionally, any parameters for the plug-in from the package definition are passed using the parameters element.

If there is a critical error, like missing service libraries, the the Monitor may throw a ServiceMonitorException. If the plug-in throws an exception then the plug-in will be disabled in the framework.

This method is called after the framework creates an instance of the plug-in. The framework passes the object a proxy object that can be used to retrieve configuration information specific to the plug-in. Additionally, any parameters for the plug-in from the package definition are passed using the parameters element.

If there is a critical error, like missing service libraries, the monitor may throw a ServiceMonitorException. If the plug-in throws an exception then the plug-in will be disabled in the framework.

Specified by:

initialize in interface ServiceMonitor

Overrides:

initialize in class AbstractServiceMonitor

Parameters:

parameters - Not currently used

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.

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