Package org.opennms.features.deviceconfig.monitors

Class DeviceConfigMonitor

java.lang.Object

org.opennms.netmgt.poller.support.AbstractServiceMonitor

org.opennms.features.deviceconfig.monitors.DeviceConfigMonitor

All Implemented Interfaces:

ServiceMonitor

public class DeviceConfigMonitor
extends AbstractServiceMonitor

Field Summary

Fields

Modifier and Type	Field	Description
static String	HOST_KEY
static String	LAST_RETRIEVAL
static String	PASSWORD
static String	SCRIPT
static String	SCRIPT_FILE
static String	SSH_PORT
static String	SSH_TIMEOUT
static String	USERNAME

Constructor Summary

Constructors

Constructor	Description
DeviceConfigMonitor()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getRuntimeAttributes(MonitoredService svc, Map<String,Object> parameters)
PollStatus	poll(MonitoredService svc, Map<String,Object> parameters)	This method is the heart of the plug-in monitor.
void	setDeviceConfigDao(DeviceConfigDao deviceConfigDao)
void	setIpInterfaceDao(IpInterfaceDao ipInterfaceDao)
void	setRetriever(Retriever retriever)
void	setSessionUtils(SessionUtils sessionUtils)

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

SCRIPT

public static final String SCRIPT

See Also:

Constant Field Values

USERNAME

public static final String USERNAME

See Also:

Constant Field Values

SSH_PORT

public static final String SSH_PORT

See Also:

Constant Field Values

SSH_TIMEOUT

public static final String SSH_TIMEOUT

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

Constant Field Values

HOST_KEY

public static final String HOST_KEY

See Also:

Constant Field Values

LAST_RETRIEVAL

public static final String LAST_RETRIEVAL

See Also:

Constant Field Values

SCRIPT_FILE

public static final String SCRIPT_FILE

See Also:

Constant Field Values

Constructor Detail

DeviceConfigMonitor

public DeviceConfigMonitor()

Method Detail

getRuntimeAttributes

public Map<String,Object> getRuntimeAttributes(MonitoredService svc,
                                                     Map<String,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,
                       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

setRetriever

public void setRetriever(Retriever retriever)

setIpInterfaceDao

public void setIpInterfaceDao(IpInterfaceDao ipInterfaceDao)

setDeviceConfigDao

public void setDeviceConfigDao(DeviceConfigDao deviceConfigDao)

setSessionUtils

public void setSessionUtils(SessionUtils sessionUtils)