com.cafesoft.cams.access
Interface InternalAccessControlResponse

All Superinterfaces:

AccessControlResponse

public interface InternalAccessControlResponse
extends AccessControlResponse

Internal representation of the AccessControlResponse object.

Field Summary

Fields inherited from interface com.cafesoft.cams.access.AccessControlResponse

RC_ACCESS_DENIED_AUTHENTICATION_REQUIRED, RC_ACCESS_DENIED_CONDITIONALLY, RC_ACCESS_DENIED_CONFIDENTIALITY_REQUIRED, RC_ACCESS_DENIED_EVALUATION_ERROR, RC_ACCESS_DENIED_INSUFFICIENT_AUTH_METHOD, RC_ACCESS_DENIED_MISSING_REQUIRED_ATTRIBUTES, RC_ACCESS_DENIED_SESSION_EXPIRED, RC_ACCESS_DENIED_UNCONDITIONALLY, RC_ACCESS_GRANTED_CONDITIONALLY, RC_ACCESS_GRANTED_CONDITIONALLY_SESSION_EXPIRED, RC_ACCESS_GRANTED_UNCONDITIONALLY, RC_ACCESS_GRANTED_UNCONDITIONALLY_SESSION_EXPIRED, RC_DEFAULT_BIAS_APPLIED, RC_DEFAULT_BIAS_APPLIED_SESSION_EXPIRED, RC_GENERAL_SERVER_ERROR, RC_GENERAL_TRANSPORT_ERROR, RC_INVALID_REMOTE_HOST_NAME, RC_INVALID_REMOTE_IP_ADDRESS, RC_INVALID_RESOURCE_IDENTIFIER, RC_NOT_APPLICABLE, RC_SESSION_ID_INVALID, RC_UNAUTHORIZED_AGENT, RC_UNKNOWN_LOGIN_CONFIG, RC_UNKNOWN_RESOURCE_ACTION, RC_UNKNOWN_RESOURCE_TYPE, RC_UNKNOWN_SECURITY_DOMAIN, SC_DENIED, SC_GRANTED, SC_PENDING

Method Summary

void	finalizeObligations(ObligationListFinalizer[] obListFinalizer) Finalize the response's Obligations.
void	setLastModificationTime(long time) Set the last modification time of the Cams Policy Server configuration files.
void	setLoginConfigEntryName(String loginConfigEntryName) Set the LoginConfigEntry name
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	setSecurityDomainName(String securityDomainName) Set the SecurityDomain name
void	setSessionId(SessionId sessionId) Sets the session id that matched the corresponding access control request
void	setStatus(int status) Set the status code.

Methods inherited from interface com.cafesoft.cams.access.AccessControlResponse

addMissingAttribute, addObligation, getLastModificationTime, getLoginConfigEntryName, getLoginParameters, getMessage, getMissingAttributeCategories, getMissingAttributes, getMissingAttributesByCategory, getObligationCount, getObligations, getReason, getSecurityDomainName, 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.

setSecurityDomainName

void setSecurityDomainName(String securityDomainName)

Set the SecurityDomain name

Parameters:

securityDomainName - the new SecurityDomain name

setLoginConfigEntryName

void setLoginConfigEntryName(String loginConfigEntryName)

Set the LoginConfigEntry name

Parameters:

loginConfigEntryName - the new LoginConfigEntry name

setLoginParameters

void setLoginParameters(Map loginParameters)

Set the login parameters map

Parameters:

loginParameters - the new Map of login parameters

setSessionId

void setSessionId(SessionId sessionId)

Sets the session id that matched the corresponding access control request

Parameters:

sessionId - the session id that matched the corresponding access control request

setLastModificationTime

void setLastModificationTime(long time)

Set the last modification time of the Cams Policy Server configuration files.

Parameters:

time - the last modification time of the Cams Policy Server configuration files.

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 access control 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.