org.opennms.netmgt.poller.monitors

Class JolokiaBeanMonitor

java.lang.Object

org.opennms.netmgt.poller.monitors.AbstractServiceMonitor

org.opennms.netmgt.poller.monitors.JolokiaBeanMonitor

All Implemented Interfaces:

ServiceMonitor

@Distributable(value=DAEMON)
public final class JolokiaBeanMonitor
extends AbstractServiceMonitor

This class is designed to be used by the service poller framework to test the availability of a generic mbean method on remote interfaces via a jolokia agent. The class implements the ServiceMonitor interface that allows it to be used along with other plug-ins by the service poller framework.

Author:

Chris Liles, OpenNMS

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_URL
static String	PARAMETER_ATTRNAME
static String	PARAMETER_ATTRPATH
static String	PARAMETER_BANNER
static String	PARAMETER_BEANNAME
static String	PARAMETER_METHODINPUT1
static String	PARAMETER_METHODINPUT2
static String	PARAMETER_METHODNAME
static String	PARAMETER_PASSWORD
static String	PARAMETER_PORT
static String	PARAMETER_URL
static String	PARAMETER_USERNAME

Constructor Summary

Constructors

Constructor and Description
JolokiaBeanMonitor()

Method Summary

Methods

Modifier and Type	Method and Description
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, initialize, release, release

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_URL

public static final String PARAMETER_URL

See Also:

Constant Field Values

PARAMETER_USERNAME

public static final String PARAMETER_USERNAME

See Also:

Constant Field Values

PARAMETER_PASSWORD

public static final String PARAMETER_PASSWORD

See Also:

Constant Field Values

PARAMETER_BANNER

public static final String PARAMETER_BANNER

See Also:

Constant Field Values

PARAMETER_PORT

public static final String PARAMETER_PORT

See Also:

Constant Field Values

PARAMETER_BEANNAME

public static final String PARAMETER_BEANNAME

See Also:

Constant Field Values

PARAMETER_ATTRNAME

public static final String PARAMETER_ATTRNAME

See Also:

Constant Field Values

PARAMETER_ATTRPATH

public static final String PARAMETER_ATTRPATH

See Also:

Constant Field Values

PARAMETER_METHODNAME

public static final String PARAMETER_METHODNAME

See Also:

Constant Field Values

PARAMETER_METHODINPUT1

public static final String PARAMETER_METHODINPUT1

See Also:

Constant Field Values

PARAMETER_METHODINPUT2

public static final String PARAMETER_METHODINPUT2

See Also:

Constant Field Values

DEFAULT_URL

public static final String DEFAULT_URL

See Also:

Constant Field Values

Constructor Detail

JolokiaBeanMonitor

public JolokiaBeanMonitor()

Method Detail

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.

Poll the specified address for service availability. During the poll an attempt is made to execute the named method (with optional input) connect on the specified port. If the exec on request is successful, the banner line generated by the interface is parsed and if the banner text indicates that we are talking to Provided that the interface's response is valid we set the service status to SERVICE_AVAILABLE and return.

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