com.theorem.radserver3.login
Class RADIUSTextOutputCallback

Object
  TextOutputCallback
      RADIUSTextOutputCallback

All Implemented Interfaces:

Callback, RADIUSCallback, Serializable

public final class RADIUSTextOutputCallback

extends TextOutputCallback

implements RADIUSCallback

Class to handle the text output callback. Text may be returned under a variety of conditions. Some conditions, such as in conjunction with an AccessBadPacket handler may not be suitable for display as it indicates a technical failure rather than an unknown namd or bad password.

This handler class will be always be present when another handler is invoked. By ordering the other handler first it can be determined if displaying the output is necessary. Handlers that will cause the RADIUSTextOutputCallback to contain valid data are AccessReject (the Reply-Message, if any) and AccessBadPacket (error message).

Access to data handling methods in this class may only be performed when isReady() returns true.

This is a handler class.

See Also:

Serialized Form

Field Summary

Fields inherited from class TextOutputCallback

ERROR, INFORMATION, WARNING

Method Summary

boolean	isReady() Determine if the values in the callback class are ready to be accessed or modified.
void	setReady(boolean setting) Set the Callback ready indicator.

Methods inherited from class TextOutputCallback

getMessage, getMessageType

Methods inherited from class Object

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

Method Detail

isReady

public boolean isReady()

Determine if the values in the callback class are ready to be accessed or modified.

Specified by:

isReady in interface RADIUSCallback

Returns:

True if the instance's data may be read or written.

setReady

public void setReady(boolean setting)

Set the Callback ready indicator.

Specified by:

setReady in interface RADIUSCallback

Parameters:

setting - Set to true if this instance is ready to read / write data.