com.cafesoft.cams.auth
Interface InternalAuthResponse

All Superinterfaces:

AuthResponse

public interface InternalAuthResponse
extends AuthResponse

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

Field Summary

Fields inherited from interface com.cafesoft.cams.auth.AuthResponse

RC_CALLBACK_HANDLER_ERROR, RC_EXPIRED_ACCOUNT, RC_EXPIRED_CREDENTIAL, RC_GENERAL_SERVER_ERROR, RC_INVALID_REMOTE_HOST_NAME, RC_INVALID_REMOTE_IP_ADDRESS, RC_LOGIN_ERROR, RC_LOGIN_FAILED, RC_NOT_APPLICABLE, RC_UNAUTHORIZED_AGENT, RC_UNKNOWN_LOGIN_CONFIG, RC_UNKNOWN_SECURITY_DOMAIN, SC_FAILED, SC_PENDING, SC_SUCCESS

Method Summary

void	finalizeObligations(ObligationListFinalizer[] obListFinalizer) Finalize the response's Obligations.
Subject	getSubject() Get the Subject.
void	setLoginParameters(Map loginParameters) Set the login parameters map
void	setMessage(String message) Set the message.
void	setReason(int reason) Set the reason code.
void	setSessionId(SessionId sessionId) Set the Session ID.
void	setStatus(int status) Set the status code.
void	setSubject(Subject subject) Set the Subject.

Methods inherited from interface com.cafesoft.cams.auth.AuthResponse

addObligation, getLoginParameters, getMessage, getObligationCount, getObligations, getReason, getSessionId, getStatus, log

Method Detail

setStatus

void setStatus(int status)

Set the status code.

Parameters:

status - the status code.

setReason

void setReason(int reason)

Set the reason code.

Parameters:

reason - a code indicating why access is denied.

setMessage

void setMessage(String message)

Set the message.

Parameters:

message - a message, usually used to convey error information if access is denied.

setSessionId

void setSessionId(SessionId sessionId)

Set the Session ID. TBD - Change name to Id

Parameters:

sessionId - the Session ID associated with the successful authentication.

setLoginParameters

void setLoginParameters(Map loginParameters)

Set the login parameters map

Parameters:

loginParameters - the new Map of login parameters

getSubject

Subject getSubject()

Get the Subject.

Returns:

the Subject (if authentication was successful).

setSubject

void setSubject(Subject subject)

Set the Subject.

Parameters:

subject - the successfully authenticated Subject.

finalizeObligations

void finalizeObligations(ObligationListFinalizer[] obListFinalizer)

Finalize the response's Obligations. This method's purpose is to take the Obligations stored in the response and keep only the Obligations that match the final outcome of the authentication request. In addition, zero of more ObligationListFinalizer implementations are given an opportunity to validate individual Obligation instances or the collection as a whole and possibly remove or modify the collection.

Parameters:

obListFinalizer - an array of ObligationListFinalizer instances. Each ObligationListFinalizer is invoked (in order) on the resulting List of Obligation instances. If null or zero-length, then ObligationListFinalizers are not invoked.

Since:

1.3