org.opennms.protocols.radius.capsd

Class RadiusAuthPlugin

java.lang.Object

org.opennms.netmgt.capsd.AbstractPlugin

org.opennms.protocols.radius.capsd.RadiusAuthPlugin

All Implemented Interfaces:

Plugin

public final class RadiusAuthPlugin
extends AbstractPlugin

This plugin is used to check a host for Radius Authentication support. This is done by sending a radius auth packet to the host. If a valid radius response is received (ACCEPT, REJECT or CHALLENGE) then the host is considered a Radius server.

Author:

Jonathan Sartin, Benjamin Reed, OpenNMS

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ACCT_PORT Default radius accounting port
static int	DEFAULT_AUTH_PORT Default radius authentication port
static String	DEFAULT_AUTH_TYPE Default radius authentication type
static String	DEFAULT_NAS_ID Default NAS_ID
static String	DEFAULT_PASSWORD Default password
static int	DEFAULT_RETRY Default number of times to retry a test
static String	DEFAULT_SECRET Default secret
static int	DEFAULT_TIMEOUT Number of milliseconds to wait before timing out a radius AUTH request
static String	DEFAULT_USER Default user

Constructor Summary

Constructors

Constructor and Description
RadiusAuthPlugin()

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.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

Number of milliseconds to wait before timing out a radius AUTH request

See Also:

Constant Field Values

DEFAULT_RETRY

public static final int DEFAULT_RETRY

Default number of times to retry a test

See Also:

Constant Field Values

DEFAULT_AUTH_PORT

public static final int DEFAULT_AUTH_PORT

Default radius authentication port

See Also:

Constant Field Values

DEFAULT_ACCT_PORT

public static final int DEFAULT_ACCT_PORT

Default radius accounting port

See Also:

Constant Field Values

DEFAULT_AUTH_TYPE

public static final String DEFAULT_AUTH_TYPE

Default radius authentication type

See Also:

Constant Field Values

DEFAULT_USER

public static final String DEFAULT_USER

Default user

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final String DEFAULT_PASSWORD

Default password

See Also:

Constant Field Values

DEFAULT_SECRET

public static final String DEFAULT_SECRET

Default secret

See Also:

Constant Field Values

DEFAULT_NAS_ID

public static final String DEFAULT_NAS_ID

Default NAS_ID

See Also:

Constant Field Values

Constructor Detail

RadiusAuthPlugin

public RadiusAuthPlugin()

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.

In addition, the input qualifiers map also provides information about how the plugin should contact the remote server. The plugin may check the qualifier map for specific elements and then adjust its behavior as necessary

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.