org.opennms.netmgt.capsd

Interface Plugin

All Known Implementing Classes:

AbstractPlugin, LoopPlugin

public interface Plugin

The CapsdPlugin interface is the basic interface that a plugin for the capabilites daemon must support. The interface allows the daemon to determine what protocols can be verified by the plugin and has the required methods to verify protocol support for nodes/protocol pairs.

Author:

Brian Weaver , OpenNMS

Method Summary

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.

Method Detail

getProtocolName

String getProtocolName()

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

Returns:

The protocol name for this plugin.

isProtocolSupported

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.

Parameters:

address - The address to check for support.

Returns:

True if the protocol is supported by the address.

isProtocolSupported

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.

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.