Package org.opennms.netmgt.poller.monitors

Class JMXMonitor

java.lang.Object

org.opennms.netmgt.poller.support.AbstractServiceMonitor

org.opennms.netmgt.poller.monitors.JMXMonitor

All Implemented Interfaces:

ServiceMonitor

Direct Known Subclasses:

Jsr160Monitor

public class JMXMonitor
extends AbstractServiceMonitor

This class computes the response time of making a connection to the remote server. If the connection is successful the reponse time RRD is updated.

Author:

Mike Jamison , OpenNMS

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PARAM_BEAN_PREFIX
static java.lang.String	PARAM_PORT
static java.lang.String	PARAM_TEST
static java.lang.String	PARAM_TEST_PREFIX

Constructor Summary

Constructors

Constructor	Description
JMXMonitor()

Method Summary

Modifier and Type	Method	Description
protected JmxConnectors	getConnectionName()
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> map)	This method is the heart of the plug-in monitor.

Methods inherited from class org.opennms.netmgt.poller.support.AbstractServiceMonitor

getEffectiveLocation, getKeyedBoolean, getKeyedInstance, getKeyedInteger, getKeyedLong, getKeyedObject, getKeyedString, getServiceProperties

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_BEAN_PREFIX

public static final java.lang.String PARAM_BEAN_PREFIX

See Also:

Constant Field Values

PARAM_TEST_PREFIX

public static final java.lang.String PARAM_TEST_PREFIX

See Also:

Constant Field Values

PARAM_TEST

public static final java.lang.String PARAM_TEST

See Also:

Constant Field Values

PARAM_PORT

public static final java.lang.String PARAM_PORT

See Also:

Constant Field Values

Constructor Detail

JMXMonitor

public JMXMonitor()

Method Detail

getConnectionName

protected JmxConnectors getConnectionName()

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

Overrides:

getRuntimeAttributes in class AbstractServiceMonitor

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).

poll

public PollStatus poll(MonitoredService svc,
                       java.util.Map<java.lang.String,java.lang.Object> map)

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).

Parameters:

svc - Includes details about to the service being monitored.

map - 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