OpenNMS API 1.2.3

org.opennms.netmgt.capsd
Class SnmpPlugin

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

public final class SnmpPlugin
extends AbstractPlugin

This class is used to test passed address for SNMP support. The configuration used to determine the SNMP information is managed by the SnmpPeerFactorySnmpPeerFactory class.

Author:
Brian Weaver , OpenNMS

Field Summary
private static java.lang.String DEFAULT_OID
          The system object identifier to retreive from the remote agent.
private static java.lang.String PROTOCOL_NAME
          The protocol supported by this plugin
 
Constructor Summary
SnmpPlugin()
           
 
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.
 
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 this plugin

See Also:
Constant Field Values

DEFAULT_OID

private static final java.lang.String DEFAULT_OID
The system object identifier to retreive from the remote agent.

See Also:
Constant Field Values
Constructor Detail

SnmpPlugin

public SnmpPlugin()
Method Detail

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.

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.