OpenNMS API 1.2.3

org.opennms.netmgt.capsd
Class SshPlugin

java.lang.Object
  extended byorg.opennms.netmgt.capsd.AbstractPlugin
      extended byorg.opennms.netmgt.capsd.SshPlugin
All Implemented Interfaces:
Plugin

public final class SshPlugin
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:
Tarus , Mike , Weaver , OpenNMS

Field Summary
private static int DEFAULT_RETRY
          Default number of retries for TCP requests
private static int DEFAULT_TIMEOUT
          Default timeout (in milliseconds) for TCP requests
private static java.lang.String PROTOCOL_NAME
          The protocol supported by the plugin
 
Constructor Summary
SshPlugin()
           
 
Method Summary
 java.lang.String getProtocolName()
          Returns the name of the protocol that this plugin checks on the target system for support.
 boolean isProtocolSupported(java.net.InetAddress address)
          Returns true if the protocol defined by this plugin is supported.
 boolean isProtocolSupported(java.net.InetAddress address, java.util.Map qualifiers)
          Returns true if the protocol defined by this plugin is supported.
private  boolean isServer(java.net.InetAddress host, int port, int retries, int timeout, org.apache.regexp.RE regex, java.lang.StringBuffer bannerResult)
           Test to see if the passed host-port pair is the endpoint for a TCP server.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROTOCOL_NAME

private static final java.lang.String PROTOCOL_NAME
The protocol supported by the plugin

See Also:
Constant Field Values

DEFAULT_RETRY

private static final int DEFAULT_RETRY
Default number of retries for TCP requests

See Also:
Constant Field Values

DEFAULT_TIMEOUT

private static final int DEFAULT_TIMEOUT
Default timeout (in milliseconds) for TCP requests

See Also:
Constant Field Values
Constructor Detail

SshPlugin

public SshPlugin()
Method Detail

isServer

private boolean isServer(java.net.InetAddress host,
                         int port,
                         int retries,
                         int timeout,
                         org.apache.regexp.RE regex,
                         java.lang.StringBuffer bannerResult)

Test to see if the passed host-port pair is the endpoint for a TCP server. If there is a TCP server at that destination then a value of true is returned from the method. Otherwise a false value is returned to the caller. In order to return true the remote host must generate a banner line which contains the text from the bannerMatch argument.

Parameters:
host - The remote host to connect to.
port - The remote port on the host.
bannerResult - Banner line generated by the remote host must contain this text.
Returns:
True if a connection is established with the host and the banner line contains the bannerMatch text.

getProtocolName

public java.lang.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(java.net.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.

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:
java.lang.UnsupportedOperationException - This is always thrown by this plugin.

isProtocolSupported

public boolean isProtocolSupported(java.net.InetAddress address,
                                   java.util.Map 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.

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.

OpenNMS API 1.2.3

Generated by eevans on May 29 2005 2015.