org.opennms.netmgt.capsd.plugins
Class NsclientPlugin

java.lang.Object
  org.opennms.netmgt.capsd.AbstractPlugin
      org.opennms.netmgt.capsd.plugins.NsclientPlugin

All Implemented Interfaces:

Plugin

public class NsclientPlugin
extends AbstractPlugin

This class is designed to be used by the capabilities daemon to test whether a NSClient service is running on the remote server and if the given command can be successfully executed against the service.

Author:

Matt Raykowski , OpenNMS

Constructor Summary

NsclientPlugin()

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NsclientPlugin

public NsclientPlugin()

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.

The NsclientPlugin does not support undirected checks, we must have a map of parameters to determine how to issue a check to the target server.

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.

Throws:

UnsupportedOperationException - This is always thrown by this plugin.

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.

The following parameters are used by this plugin:

• command - the command to be executed on this node.
• port - used to override the default NSClient port.
• password - used to override the default NSClient password
• retry - overrides the number of times to retry connecting to the service.
• timeout - tcp port timeout.
• parameter - a string used for checking services. see documentation on specific check types for use.
• criticalPercent - typically a percentage used for testing results, for example disk space used.
• warningPercent - typically a percentage used for testing results, for example memory space used.

Protocol will return as supported only if the result code is NsclientPacket.RES_STATE_OK or NsclientPacket.RES_STATE_WARNING.

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.