Package org.opennms.netmgt.poller.monitors

Class WsManMonitor

java.lang.Object

org.opennms.netmgt.poller.support.AbstractServiceMonitor

org.opennms.netmgt.poller.monitors.support.ParameterSubstitutingMonitor

org.opennms.netmgt.poller.monitors.WsManMonitor

All Implemented Interfaces:

ServiceMonitor

public class WsManMonitor
extends ParameterSubstitutingMonitor

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	Description
static String	RESOURCE_URI_PARAM
static String	RULE_PARAM
static String	SELECTOR_PARAM_PREFIX

Fields inherited from class org.opennms.netmgt.poller.monitors.support.ParameterSubstitutingMonitor

LOG

Constructor Summary

Constructors

Constructor	Description
WsManMonitor()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getRuntimeAttributes(MonitoredService svc, Map<String,Object> parameters)	Add new parameters derived from existing parameters that contain placeholders.
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.support.ParameterSubstitutingMonitor

getSubstitutedParameters, parseString, resolveKeyedString

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

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

getRuntimeAttributes

public Map<String,Object> getRuntimeAttributes(MonitoredService svc,
                                                     Map<String,Object> parameters)

Description copied from class: ParameterSubstitutingMonitor

Add new parameters derived from existing parameters that contain placeholders. The new key will be prepended with 'subbed-'.

Specified by:

getRuntimeAttributes in interface ServiceMonitor

Overrides:

getRuntimeAttributes in class ParameterSubstitutingMonitor

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,
                       Map<String,Object> parameters)

Description copied from interface: ServiceMonitor

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.

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

setWSManConfigDao

public void setWSManConfigDao(WSManConfigDao wsManConfigDao)

setWSManClientFactory

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