org.opennms.netmgt.asterisk.monitor

Class AsteriskSIPPeerMonitor

java.lang.Object

org.opennms.netmgt.poller.monitors.AbstractServiceMonitor

org.opennms.netmgt.asterisk.monitor.AsteriskSIPPeerMonitor

All Implemented Interfaces:

ServiceMonitor

public class AsteriskSIPPeerMonitor
extends AbstractServiceMonitor

This class is designed to be used by the service poller framework to test the availability of Asterisk SIP Peers by executing a "sip show peers" over AMI. It gets the AMI parameters from the AMI configuration and needs the parameter sip-peer to be set in the poller configuration.

Author:

Michael Batz, OpenNMS

Constructor Summary

Constructors

Constructor and Description
AsteriskSIPPeerMonitor()

Method Summary

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

Constructor Detail

AsteriskSIPPeerMonitor

public AsteriskSIPPeerMonitor()

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.

Initialize the service monitor.

Specified by:

initialize in interface ServiceMonitor

Overrides:

initialize in class AbstractServiceMonitor

Parameters:

parameters - Not currently used

Throws:

RuntimeException - Thrown if an unrecoverable error occurs that prevents the plug-in from functioning.

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.

Run the service monitor and return the poll status

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