Package org.opennms.netmgt.poller.monitors

Class DhcpMonitor

java.lang.Object

org.opennms.netmgt.poller.support.AbstractServiceMonitor

org.opennms.netmgt.poller.monitors.DhcpMonitor

All Implemented Interfaces:

ServiceMonitor

public final class DhcpMonitor
extends AbstractServiceMonitor

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_MAC_ADDRESS
static int	DEFAULT_RETRIES
static int	DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
DhcpMonitor()

Method Summary

Modifier and Type	Method	Description
PollStatus	poll(MonitoredService svc, Map<String,Object> parameters)	This method is the heart of the plug-in monitor.
void	setDhcpd(Dhcpd dhcpd)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RETRIES

public static final int DEFAULT_RETRIES

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_MAC_ADDRESS

public static final String DEFAULT_MAC_ADDRESS

See Also:

Constant Field Values

Constructor Detail

DhcpMonitor

public DhcpMonitor()

Method Detail

setDhcpd

public void setDhcpd(Dhcpd dhcpd)

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