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_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
 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
getLoginParameters, getMessage, getReason, getSessionId, getStatus, log
 

Method Detail

setStatus

public void setStatus(int status)
Set the status code.

Parameters:
status - the status code.

setReason

public void setReason(int reason)
Set the reason code.

Parameters:
reason - a code indicating why access is denied.

setMessage

public void setMessage(String message)
Set the message.

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

setSessionId

public void setSessionId(SessionId sessionId)
Set the Session ID. TBD - Change name to Id


setLoginParameters

public void setLoginParameters(Map loginParameters)
Set the login parameters map

Parameters:
loginParameters - the new Map of login parameters

getSubject

public Subject getSubject()
Get the Subject.

Returns:
the Subject (if authentication was successful).

setSubject

public void setSubject(Subject subject)
Set the Subject.

Parameters:
subject - the successfully authenticated Subject.


Generated on 10:40:31 AM September 10, 2003, © 1996-2003 Cafésoft LLC. All rights reserved.