com.cafesoft.cams.auth
Interface AuthResponse

All Known Subinterfaces:

InternalAuthResponse

public interface AuthResponse

AuthResponse defines the interface to an Authentication Response corresponding to an AuthRequest to a Cafesoft SecurityDomain's Authentication Engine.

Field Summary

static int	RC_CALLBACK_HANDLER_ERROR Reason Code : The CallbackHandler had an error
static int	RC_EXPIRED_ACCOUNT Reason Code : The account specified by the user has expired.
static int	RC_EXPIRED_CREDENTIAL Reason Code : The credential specified by the user has expired.
static int	RC_GENERAL_SERVER_ERROR Reason Code: General Server Error, probably due to a misconfiguration.
static int	RC_INVALID_REMOTE_HOST_NAME Reason Code: The remote host name is not valid.
static int	RC_INVALID_REMOTE_IP_ADDRESS Reason Code: The remote host IP address is not valid.
static int	RC_LOGIN_ERROR Reason Code : An unrecoverable error occurred during login.
static int	RC_LOGIN_FAILED Reason Code : The attempted login failed due to incomplete or invalid credentials
static int	RC_NOT_APPLICABLE Reason Code: Not Applicable (because authentication is pending)
static int	RC_UNAUTHORIZED_AGENT Reason Code: The agent making the access request is not authorized.
static int	RC_UNKNOWN_LOGIN_CONFIG Reason Code: An unknown login configuration was referenced.
static int	RC_UNKNOWN_SECURITY_DOMAIN Reason Code: An unknown security domain was referenced.
static int	SC_FAILED Status Code indicating that authentication failed.
static int	SC_PENDING Status Code indicating that authentication is in progress.
static int	SC_SUCCESS Status Code indicating that authentication succeeded.

Method Summary

void	addObligation(Obligation obligation) Add an Obligation to the response.
Map	getLoginParameters() Get the login parameters if any exist.
String	getMessage() Get the message.
int	getObligationCount() Get the number of response Obligations.
Iterator	getObligations() Get an Iterator of Obligation objects that apply to the response.
int	getReason() Get the Reason code.
SessionId	getSessionId() Get the Session ID.
int	getStatus() Get the status code.
void	log(Logger logger) Logs the data contained in this response to the specified logger.

Field Detail

SC_PENDING

static final int SC_PENDING

Status Code indicating that authentication is in progress.

See Also:

Constant Field Values

SC_SUCCESS

static final int SC_SUCCESS

Status Code indicating that authentication succeeded.

See Also:

Constant Field Values

SC_FAILED

static final int SC_FAILED

Status Code indicating that authentication failed.

See Also:

Constant Field Values

RC_NOT_APPLICABLE

static final int RC_NOT_APPLICABLE

Reason Code: Not Applicable (because authentication is pending)

See Also:

Constant Field Values

RC_GENERAL_SERVER_ERROR

static final int RC_GENERAL_SERVER_ERROR

Reason Code: General Server Error, probably due to a misconfiguration.

See Also:

Constant Field Values

RC_INVALID_REMOTE_IP_ADDRESS

static final int RC_INVALID_REMOTE_IP_ADDRESS

Reason Code: The remote host IP address is not valid.

See Also:

Constant Field Values

RC_INVALID_REMOTE_HOST_NAME

static final int RC_INVALID_REMOTE_HOST_NAME

Reason Code: The remote host name is not valid.

See Also:

Constant Field Values

RC_UNAUTHORIZED_AGENT

static final int RC_UNAUTHORIZED_AGENT

Reason Code: The agent making the access request is not authorized.

See Also:

Constant Field Values

RC_UNKNOWN_SECURITY_DOMAIN

static final int RC_UNKNOWN_SECURITY_DOMAIN

Reason Code: An unknown security domain was referenced.

See Also:

Constant Field Values

RC_UNKNOWN_LOGIN_CONFIG

static final int RC_UNKNOWN_LOGIN_CONFIG

Reason Code: An unknown login configuration was referenced.

See Also:

Constant Field Values

RC_LOGIN_FAILED

static final int RC_LOGIN_FAILED

Reason Code : The attempted login failed due to incomplete or invalid credentials

See Also:

Constant Field Values

RC_LOGIN_ERROR

static final int RC_LOGIN_ERROR

Reason Code : An unrecoverable error occurred during login.

See Also:

Constant Field Values

RC_EXPIRED_ACCOUNT

static final int RC_EXPIRED_ACCOUNT

Reason Code : The account specified by the user has expired.

Since:

1.6

See Also:

Constant Field Values

RC_EXPIRED_CREDENTIAL

static final int RC_EXPIRED_CREDENTIAL

Reason Code : The credential specified by the user has expired.

Since:

1.6

See Also:

Constant Field Values

RC_CALLBACK_HANDLER_ERROR

static final int RC_CALLBACK_HANDLER_ERROR

Reason Code : The CallbackHandler had an error

See Also:

Constant Field Values

Method Detail

getStatus

int getStatus()

Get the status code.

Returns:

the status code.

getReason

int getReason()

Get the Reason code.

Returns:

the reason code.

getMessage

String getMessage()

Get the message.

Returns:

a textual message, usually used to convey error information if access is denied, or null if no message is available.

getSessionId

SessionId getSessionId()

Get the Session ID. TBD - Change name to Id

Returns:

the Session ID (if authentication was successful).

getLoginParameters

Map getLoginParameters()

Get the login parameters if any exist.

Returns:

a Map of login parameters, or null if a Map does not exist

addObligation

void addObligation(Obligation obligation)

Add an Obligation to the response.

Parameters:

obligation - the Obligation object to add.

Since:

1.7

getObligations

Iterator getObligations()

Get an Iterator of Obligation objects that apply to the response.

Returns:

an Iterator of Obligations.

Since:

1.7

getObligationCount

int getObligationCount()

Get the number of response Obligations.

Returns:

the count of Obligation the response contains.

Since:

1.7

log

void log(Logger logger)

Logs the data contained in this response to the specified logger.

Parameters:

logger - logs data