Package org.opennms.netmgt.poller.monitors

Class TcpMonitor

java.lang.Object

org.opennms.netmgt.poller.support.AbstractServiceMonitor

org.opennms.netmgt.poller.monitors.TcpMonitor

All Implemented Interfaces:

ServiceMonitor

public final class TcpMonitor
extends AbstractServiceMonitor

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

Author:

Weave, Tarus Balog , Mike , OpenNMS

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOG
static java.lang.String	PARAMETER_BANNER
static java.lang.String	PARAMETER_PORT

Constructor Summary

Constructors

Constructor	Description
TcpMonitor()

Method Summary

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

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

LOG

public static final org.slf4j.Logger LOG

PARAMETER_BANNER

public static final java.lang.String PARAMETER_BANNER

See Also:

Constant Field Values

PARAMETER_PORT

public static final java.lang.String PARAMETER_PORT

See Also:

Constant Field Values

Constructor Detail

TcpMonitor

public TcpMonitor()

Method Detail

poll

public PollStatus poll(MonitoredService svc,
                       java.util.Map<java.lang.String,java.lang.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 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).

Poll the specified address for service availability. During the poll an attempt is made to connect on the specified port. If the connection 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.

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