com.theorem.radius3.auth.rsaace.client
Class RSAACEInfo

Object
  RSAACEInfo

public class RSAACEInfo

extends Object

Field Summary

static int	ERROR_ACCESS_REJECT Error code ERROR_ACCESS_REJECT = -2.
static int	ERROR_ALLDONE Error code ERROR_ALLDONE = -1.
static int	ERROR_CLIENT_EXCEPTION Error code ERROR_CLIENT_EXCEPTION = -3.
static int	STATE_COMPLETE State - Authentication completed sucessfully - 3.
static int	STATE_CONTINUE State - Running - 2.
static int	STATE_ERROR State - Authentication error - 4.

Method Summary

AttributeList	getAttributes() Return the response attributes from the RADIUS client.
String	getDisplayMessage() Get the message to be displayed to the supplicant.
int	getError() Get the numeric error code if getState() returns STATE_ERROR.
String	getErrorString() Get the string value for the error if getState() returns STATE_ERROR.
int	getState() Get the current RSA client state.
String	getStateName() Get the symbolic name for the current state returned by getState().
void	setResponse(byte[] response) Set the message the supplicant provided.
void	setResponse(String response) Set the message the supplicant provided.
String	toString() Return a string representation of this class.

Methods inherited from class Object

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

Field Detail

STATE_CONTINUE

public static final int STATE_CONTINUE

State - Running - 2. Continue to call RSAACEClient.process().

See Also:

Constant Field Values

STATE_COMPLETE

public static final int STATE_COMPLETE

State - Authentication completed sucessfully - 3. Authentication has completed using RSAACEClient.process(). The process() method must not be called again. If it is called again the error ERROR_ALLDONE will be returned.

See Also:

Constant Field Values

STATE_ERROR

public static final int STATE_ERROR

State - Authentication error - 4. An error associated with some aspect of authentication has been detected. Errors can range from server time out, Access-Reject, packet errors, and so on. Errors will always have an associated error string. If the RSAACEClient.process() method is called again it will return the previous error. It should not be called again once an error has been detected.

See Also:

Constant Field Values

ERROR_ALLDONE

public static final int ERROR_ALLDONE

Error code ERROR_ALLDONE = -1. This error is set if the RSAACEClient.process() method is called after the state STATE_COMPLETE has been returned.

See Also:

Constant Field Values

ERROR_ACCESS_REJECT

public static final int ERROR_ACCESS_REJECT

Error code ERROR_ACCESS_REJECT = -2. This error is set if the RADIUS server return an Access-Reject packet.

See Also:

Constant Field Values

ERROR_CLIENT_EXCEPTION

public static final int ERROR_CLIENT_EXCEPTION

Error code ERROR_CLIENT_EXCEPTION = -3. This will be set if either a ClientSendException or a ClientReceiveException is thrown by the client.

See Also:

Constant Field Values

Method Detail

getDisplayMessage

public String getDisplayMessage()

Get the message to be displayed to the supplicant.

Returns:

Message.

setResponse

public void setResponse(byte[] response)

Set the message the supplicant provided.

Parameters:

response - Response.

setResponse

public void setResponse(String response)

Set the message the supplicant provided.

Parameters:

response - Response.

getError

public int getError()

Get the numeric error code if getState() returns STATE_ERROR.

Returns:

Numeric error code.

getErrorString

public String getErrorString()

Get the string value for the error if getState() returns STATE_ERROR.

Returns:

The readable error code.

getState

public int getState()

Get the current RSA client state. This must be called after each RSAACEClient.process() is run or each time the RSAACEHandler.rsaaceHandler(RSAACEInfo cb)

Returns:

One of STATE_CONTINUE, STATE_COMPLETE or STATE_ERROR.

getStateName

public String getStateName()

Get the symbolic name for the current state returned by getState().

Returns:

Symbolic state name.

getAttributes

public AttributeList getAttributes()

Return the response attributes from the RADIUS client. This is only useful after the RSA ACE client state is STATE_COMPLETE.

Returns:

RADIUS attributes.

toString

public String toString()

Return a string representation of this class.

Returns:

String representation.