org.opennms.sms.monitor
Class MobileMsgSequenceMonitor

java.lang.Object
  org.opennms.netmgt.poller.monitors.IPv4Monitor
      org.opennms.sms.monitor.MobileMsgSequenceMonitor

All Implemented Interfaces:

ServiceMonitor

@Distributable(value=DAEMON)
public class MobileMsgSequenceMonitor
extends IPv4Monitor

MobileMsgSequenceMonitor class.

Version:

$Id: $

Author:

ranger

Field Summary

static String	CONTEXT_KEY Constant CONTEXT_KEY="mobileMessageContextName"
static String	DEFAULT_CONTEXT_NAME Constant DEFAULT_CONTEXT_NAME="mobileMessagePollerContext"

Constructor Summary

MobileMsgSequenceMonitor()

Method Summary

void	initialize(Map<String,Object> params) 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.IPv4Monitor

initialize, log, logDown, logDown, logUp, release, release

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTEXT_NAME

public static final String DEFAULT_CONTEXT_NAME

Constant DEFAULT_CONTEXT_NAME="mobileMessagePollerContext"

See Also:

Constant Field Values

CONTEXT_KEY

public static final String CONTEXT_KEY

Constant CONTEXT_KEY="mobileMessageContextName"

See Also:

Constant Field Values

Constructor Detail

MobileMsgSequenceMonitor

public MobileMsgSequenceMonitor()

Method Detail

initialize

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

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 retreive 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 montior 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 IPv4Monitor

Parameters:

params - 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 IPv4Monitor

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