org.opennms.netmgt.poller.monitors

Class WsManMonitor

java.lang.Object

org.opennms.netmgt.poller.monitors.AbstractServiceMonitor

org.opennms.netmgt.poller.monitors.WsManMonitor

All Implemented Interfaces:

ServiceMonitor

public class WsManMonitor
extends AbstractServiceMonitor

WS-Man Monitor This monitor is not distributable since it relies on local configuration provided by the WSManConfigDao.

Author:

jwhite

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_URI_PARAM
static String	RULE_PARAM
static String	SELECTOR_PARAM_PREFIX

Constructor Summary

Constructors

Constructor and Description
WsManMonitor()

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.
void	setWSManClientFactory(org.opennms.core.wsman.WSManClientFactory factory)
void	setWSManConfigDao(WSManConfigDao wsManConfigDao)

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

RESOURCE_URI_PARAM

public static final String RESOURCE_URI_PARAM

See Also:

Constant Field Values

RULE_PARAM

public static final String RULE_PARAM

See Also:

Constant Field Values

SELECTOR_PARAM_PREFIX

public static final String SELECTOR_PARAM_PREFIX

See Also:

Constant Field Values

Constructor Detail

WsManMonitor

public WsManMonitor()

Method Detail

initialize

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

Description copied from class: AbstractServiceMonitor

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)

Description copied from class: AbstractServiceMonitor

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

setWSManConfigDao

public void setWSManConfigDao(WSManConfigDao wsManConfigDao)

setWSManClientFactory

public void setWSManClientFactory(org.opennms.core.wsman.WSManClientFactory factory)