Package org.opennms.protocols.radius.monitor

Class RadiusAuthMonitor

java.lang.Object

org.opennms.netmgt.poller.support.AbstractServiceMonitor

org.opennms.netmgt.poller.monitors.support.ParameterSubstitutingMonitor

org.opennms.protocols.radius.monitor.RadiusAuthMonitor

All Implemented Interfaces:

ServiceMonitor

public final class RadiusAuthMonitor
extends ParameterSubstitutingMonitor

This Monitor is used to poll hosts supporting Radius Authentication. This is done by sending a radius auth packet to the host. If a valid radius ACCEPT response is received. then the Radius service is considered available.

Author:

Jonathan Sartin, Benjamin Reed, OpenNMS

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_ACCT_PORT	Default radius accounting port
static int	DEFAULT_AUTH_PORT	Default radius authentication port
static java.lang.String	DEFAULT_AUTH_TYPE	Default radius authentication type
static java.lang.String	DEFAULT_INNER_USER	Default inner user identity (ttls / peap)
static java.lang.String	DEFAULT_NASID	Default NAS-ID
static java.lang.String	DEFAULT_PASSWORD	Default pasword
static int	DEFAULT_RETRY	Default number of times to retry a test
static java.lang.String	DEFAULT_SECRET	Default secret
static int	DEFAULT_TIMEOUT	Number of milliseconds to wait before timing out a radius AUTH request
static java.lang.String	DEFAULT_TTLS_INNER_AUTH_TYPE	Default Inner Auth Type (ttls)
static java.lang.String	DEFAULT_USER	Default user

Constructor Summary

Constructors

Constructor	Description
RadiusAuthMonitor()	Class constructor.

Method Summary

Modifier and Type	Method	Description
PollStatus	poll(MonitoredService svc, java.util.Map<java.lang.String,java.lang.Object> parameters)	This method is the heart of the plug-in monitor.

Methods inherited from class org.opennms.netmgt.poller.monitors.support.ParameterSubstitutingMonitor

getRuntimeAttributes, getSubstitutedParameters, parseString, resolveKeyedString

Methods inherited from class org.opennms.netmgt.poller.support.AbstractServiceMonitor

getEffectiveLocation, getKeyedBoolean, getKeyedInstance, getKeyedInteger, getKeyedLong, getKeyedObject, getKeyedString, getServiceProperties

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 java.lang.String DEFAULT_AUTH_TYPE

Default radius authentication type

See Also:

Constant Field Values

DEFAULT_USER

public static final java.lang.String DEFAULT_USER

Default user

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final java.lang.String DEFAULT_PASSWORD

Default pasword

See Also:

Constant Field Values

DEFAULT_SECRET

public static final java.lang.String DEFAULT_SECRET

Default secret

See Also:

Constant Field Values

DEFAULT_NASID

public static final java.lang.String DEFAULT_NASID

Default NAS-ID

See Also:

Constant Field Values

DEFAULT_INNER_USER

public static final java.lang.String DEFAULT_INNER_USER

Default inner user identity (ttls / peap)

See Also:

Constant Field Values

DEFAULT_TTLS_INNER_AUTH_TYPE

public static final java.lang.String DEFAULT_TTLS_INNER_AUTH_TYPE

Default Inner Auth Type (ttls)

See Also:

Constant Field Values

Constructor Detail

RadiusAuthMonitor

public RadiusAuthMonitor()
                  throws java.lang.ClassNotFoundException,
                         java.lang.InstantiationException,
                         java.lang.IllegalAccessException

Class constructor.

Throws:

java.lang.ClassNotFoundException - if any.

java.lang.InstantiationException - if any.

java.lang.IllegalAccessException - if any.

Method Detail

poll

public PollStatus poll(MonitoredService svc,
                       java.util.Map<java.lang.String,java.lang.Object> parameters)

This method is the heart of the plug-in monitor. Each time an interface requires a check to be performed as defined by the scheduler the poll method is invoked. The poll is passed the service to check.

By default when the status transition from up to down or vice versa the framework will generate an event. Additionally, if the polling interval changes due to an extended unavailability, the framework will generate an additional down event. The plug-in can suppress the generation of the default events by setting the suppress event bit in the returned integer.

NOTE: This method may be invoked on a Minion, in which case certain bean and facilities will not be available. If any state related information is required such as agent related configuration, it should retrieved by the ServiceMonitor.getRuntimeAttributes(MonitoredService, Map).

Radius Authentication Poller Note that the poller will return SERVICE_AVAILABLE only if the authentication Request actually succeeds. A failed authentication request will result in SERVICE_UNAVILABLE, although the radius server may actually be up.

Parameters:

svc - Includes details about to the service being monitored.

parameters - Includes the service parameters defined in poller-configuration.xml and those returned by ServiceMonitor.getRuntimeAttributes(MonitoredService, Map).

Returns:

The availability of the interface and if a transition event should be suppressed.

See Also:

org.opennms.netmgt.poller.ServiceMonitor#SERVICE_AVAILABLE, org.opennms.netmgt.poller.ServiceMonitor#SERVICE_UNAVAILABLE, org.opennms.netmgt.poller.ServiceMonitor#SERVICE_UNRESPONSIVE, org.opennms.netmgt.poller.ServiceMonitor#SERVICE_AVAILABLE, org.opennms.netmgt.poller.ServiceMonitor#SERVICE_UNAVAILABLE, org.opennms.netmgt.poller.ServiceMonitor#SERVICE_UNRESPONSIVE, org.opennms.netmgt.poller.ServiceMonitor#SERVICE_AVAILABLE, org.opennms.netmgt.poller.ServiceMonitor#SERVICE_UNAVAILABLE, org.opennms.netmgt.poller.ServiceMonitor#SERVICE_UNRESPONSIVE