org.opennms.netmgt.capsd.plugins

Class NrpePlugin

java.lang.Object

org.opennms.netmgt.capsd.AbstractPlugin

org.opennms.netmgt.capsd.plugins.NrpePlugin

All Implemented Interfaces:

Plugin

public final class NrpePlugin
extends AbstractPlugin

This class is designed to be used by the capabilities daemon to test for the existance of an TCP server on remote interfaces. The class implements the Plugin interface that allows it to be used along with other plugins by the daemon.

Author:

Mike, Weaver, OpenNMS

Constructor Summary

Constructors

Constructor and Description
NrpePlugin()

Method Summary

Methods

Modifier and Type	Method and Description
String	getProtocolName() Returns the name of the protocol that this plugin checks on the target system for support.
boolean	isProtocolSupported(InetAddress address) Returns true if the protocol defined by this plugin is supported.
boolean	isProtocolSupported(InetAddress address, Map<String,Object> qualifiers) Returns true if the protocol defined by this plugin is supported.
protected Socket	wrapSocket(Socket socket, String hostAddress, int hostPort) wrapSocket

Methods inherited from class java.lang.Object

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

Constructor Detail

NrpePlugin

public NrpePlugin()

Method Detail

getProtocolName

public String getProtocolName()

Returns the name of the protocol that this plugin checks on the target system for support.

Specified by:

getProtocolName in interface Plugin

Specified by:

getProtocolName in class AbstractPlugin

Returns:

The protocol name for this plugin.

isProtocolSupported

public boolean isProtocolSupported(InetAddress address)

Returns true if the protocol defined by this plugin is supported. If the protocol is not supported then a false value is returned to the caller. Returns true if the protocol defined by this plugin is supported. If the protocol is not supported then a false value is returned to the caller. Returns true if the protocol defined by this plugin is supported. If the protocol is not supported then a false value is returned to the caller.

Specified by:

isProtocolSupported in interface Plugin

Specified by:

isProtocolSupported in class AbstractPlugin

Parameters:

address - The address to check for support.

Returns:

True if the protocol is supported by the address.

isProtocolSupported

public boolean isProtocolSupported(InetAddress address,
                          Map<String,Object> qualifiers)

Returns true if the protocol defined by this plugin is supported. If the protocol is not supported then a false value is returned to the caller. The qualifier map passed to the method is used by the plugin to return additional information by key-name. These key-value pairs can be added to service events if needed. Returns true if the protocol defined by this plugin is supported. If the protocol is not supported then a false value is returned to the caller. The qualifier map passed to the method is used by the plugin to return additional information by key-name. These key-value pairs can be added to service events if needed. Returns true if the protocol defined by this plugin is supported. If the protocol is not supported then a false value is returned to the caller. The qualifier map passed to the method is used by the plugin to return additional information by key-name. These key-value pairs can be added to service events if needed.

Specified by:

isProtocolSupported in interface Plugin

Specified by:

isProtocolSupported in class AbstractPlugin

Parameters:

address - The address to check for support.

qualifiers - The map where qualification are set by the plugin.

Returns:

True if the protocol is supported by the address.

wrapSocket

protected Socket wrapSocket(Socket socket,
                String hostAddress,
                int hostPort)
                     throws Exception

wrapSocket

Parameters:

socket - a Socket object.

hostAddress - a String object.

hostPort - a int.

Returns:

a Socket object.

Throws:

Exception - if any.