com.cafesoft.cams.access
Interface AccessControlResponse

All Known Subinterfaces:

InternalAccessControlResponse

public interface AccessControlResponse

AccessControlResponse defines the interface to an Access Control Response corresponding to an AccessControlRequest to a Cafesoft SecurityDomain's Access Control Engine.

Field Summary

static int	RC_ACCESS_DENIED_AUTHENTICATION_REQUIRED Reason Code: Access was denied because authentication is required.
static int	RC_ACCESS_DENIED_CONDITIONALLY Reason Code: Access Denied Conditionally
static int	RC_ACCESS_DENIED_CONFIDENTIALITY_REQUIRED Reason Code: Access was denied because confidentiality is required.
static int	RC_ACCESS_DENIED_EVALUATION_ERROR Reason Code: Access was denied because an error occured while evaluating an AccessControlRule.
static int	RC_ACCESS_DENIED_INSUFFICIENT_AUTH_METHOD Reason Code: Access Denied because authentication method is insufficient.
static int	RC_ACCESS_DENIED_MISSING_REQUIRED_ATTRIBUTES Reason Code: Access Denied because one or more required attributes are missing.
static int	RC_ACCESS_DENIED_SESSION_EXPIRED Reason Code: Access was denied because authentication is required but the session expired.
static int	RC_ACCESS_DENIED_UNCONDITIONALLY Reason Code: Access was unconditionally denied based on a rule.
static int	RC_ACCESS_GRANTED_CONDITIONALLY Reason Code: Access Granted Conditionally
static int	RC_ACCESS_GRANTED_CONDITIONALLY_SESSION_EXPIRED Reason Code: Access Granted Conditionally, but the associated session is expired.
static int	RC_ACCESS_GRANTED_UNCONDITIONALLY Reason Code: Access Granted Unconditionally
static int	RC_ACCESS_GRANTED_UNCONDITIONALLY_SESSION_EXPIRED Reason Code: Access Granted Unconditionally, but the associated session is expired.
static int	RC_DEFAULT_BIAS_APPLIED Reason Code : Use the default bias (either granted or denied) because no permission was protecting the requested resource.
static int	RC_DEFAULT_BIAS_APPLIED_SESSION_EXPIRED Reason Code : Use the default bias (either granted or denied) because no permission was protecting the requested resource and the associated session is expired.
static int	RC_GENERAL_SERVER_ERROR Reason Code: General Server Error, probably due to a misconfiguration.
static int	RC_GENERAL_TRANSPORT_ERROR Reason Code: General Transport Error
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_INVALID_RESOURCE_IDENTIFIER Reason Code: An invalid resource identifier was specified.
static int	RC_NOT_APPLICABLE Reason Code: Not Applicable (because access is granted)
static int	RC_SESSION_ID_INVALID Reason Code : Access was denied because the session id submitted was invalid
static int	RC_UNAUTHORIZED_AGENT Reason Code: The agent making the access request is not authorized.
static int	RC_UNKNOWN_LOGIN_CONFIG Reason Code : Access was denied because authentication is required, but the login configuration for the specified LoginConfigEntry could not be found
static int	RC_UNKNOWN_RESOURCE_ACTION Reason Code: An unrecognized action was requested on a resource.
static int	RC_UNKNOWN_RESOURCE_TYPE Reason Code: An unknown resource type was referenced.
static int	RC_UNKNOWN_SECURITY_DOMAIN Reason Code: An unknown security domain was referenced.
static int	SC_DENIED Status Code indicating that access is denied.
static int	SC_GRANTED Status Code indicating that access is granted.
static int	SC_PENDING Status Code indicating that access check is in progress.

Method Summary

void	addMissingAttribute(Attribute attr) Add a missing Attribute.
void	addObligation(Obligation obligation) Add an Obligation to the response.
long	getLastModificationTime() Get the last modification time of the Cams Policy Server configuration files.
String	getLoginConfigEntryName() Get the LoginConfigEntry name
Map	getLoginParameters() Get the login parameters if any exist.
String	getMessage() Get the message.
Iterator	getMissingAttributeCategories() Get all missing Attribute categories.
Iterator	getMissingAttributes() Get all missing Attributes.
Iterator	getMissingAttributesByCategory(URI attrCategory) Get all missing Attributes by category.
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.
String	getSecurityDomainName() Get the SecurityDomain name
SessionId	getSessionId() Returns the session id that applied to the corresponding access control request.
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 access check is in progress.

See Also:

Constant Field Values

SC_GRANTED

static final int SC_GRANTED

Status Code indicating that access is granted.

See Also:

Constant Field Values

SC_DENIED

static final int SC_DENIED

Status Code indicating that access is denied.

See Also:

Constant Field Values

RC_NOT_APPLICABLE

static final int RC_NOT_APPLICABLE

Reason Code: Not Applicable (because access is granted)

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_RESOURCE_TYPE

static final int RC_UNKNOWN_RESOURCE_TYPE

Reason Code: An unknown resource type was referenced.

See Also:

Constant Field Values

RC_INVALID_RESOURCE_IDENTIFIER

static final int RC_INVALID_RESOURCE_IDENTIFIER

Reason Code: An invalid resource identifier was specified.

See Also:

Constant Field Values

RC_UNKNOWN_RESOURCE_ACTION

static final int RC_UNKNOWN_RESOURCE_ACTION

Reason Code: An unrecognized action was requested on a resource.

See Also:

Constant Field Values

RC_ACCESS_DENIED_UNCONDITIONALLY

static final int RC_ACCESS_DENIED_UNCONDITIONALLY

Reason Code: Access was unconditionally denied based on a rule.

See Also:

Constant Field Values

RC_ACCESS_DENIED_AUTHENTICATION_REQUIRED

static final int RC_ACCESS_DENIED_AUTHENTICATION_REQUIRED

Reason Code: Access was denied because authentication is required.

See Also:

Constant Field Values

RC_ACCESS_DENIED_SESSION_EXPIRED

static final int RC_ACCESS_DENIED_SESSION_EXPIRED

Reason Code: Access was denied because authentication is required but the session expired.

See Also:

Constant Field Values

RC_ACCESS_DENIED_EVALUATION_ERROR

static final int RC_ACCESS_DENIED_EVALUATION_ERROR

Reason Code: Access was denied because an error occured while evaluating an AccessControlRule.

See Also:

Constant Field Values

RC_ACCESS_DENIED_CONFIDENTIALITY_REQUIRED

static final int RC_ACCESS_DENIED_CONFIDENTIALITY_REQUIRED

Reason Code: Access was denied because confidentiality is required.

See Also:

Constant Field Values

RC_SESSION_ID_INVALID

static final int RC_SESSION_ID_INVALID

Reason Code : Access was denied because the session id submitted was invalid

See Also:

Constant Field Values

RC_DEFAULT_BIAS_APPLIED

static final int RC_DEFAULT_BIAS_APPLIED

Reason Code : Use the default bias (either granted or denied) because no permission was protecting the requested resource.

See Also:

Constant Field Values

RC_UNKNOWN_LOGIN_CONFIG

static final int RC_UNKNOWN_LOGIN_CONFIG

Reason Code : Access was denied because authentication is required, but the login configuration for the specified LoginConfigEntry could not be found

See Also:

Constant Field Values

RC_GENERAL_TRANSPORT_ERROR

static final int RC_GENERAL_TRANSPORT_ERROR

Reason Code: General Transport Error

See Also:

Constant Field Values

RC_ACCESS_GRANTED_CONDITIONALLY

static final int RC_ACCESS_GRANTED_CONDITIONALLY

Reason Code: Access Granted Conditionally

See Also:

Constant Field Values

RC_ACCESS_GRANTED_UNCONDITIONALLY

static final int RC_ACCESS_GRANTED_UNCONDITIONALLY

Reason Code: Access Granted Unconditionally

See Also:

Constant Field Values

RC_ACCESS_DENIED_CONDITIONALLY

static final int RC_ACCESS_DENIED_CONDITIONALLY

Reason Code: Access Denied Conditionally

See Also:

Constant Field Values

RC_ACCESS_DENIED_MISSING_REQUIRED_ATTRIBUTES

static final int RC_ACCESS_DENIED_MISSING_REQUIRED_ATTRIBUTES

Reason Code: Access Denied because one or more required attributes are missing.

See Also:

Constant Field Values

RC_ACCESS_DENIED_INSUFFICIENT_AUTH_METHOD

static final int RC_ACCESS_DENIED_INSUFFICIENT_AUTH_METHOD

Reason Code: Access Denied because authentication method is insufficient.

See Also:

Constant Field Values

RC_DEFAULT_BIAS_APPLIED_SESSION_EXPIRED

static final int RC_DEFAULT_BIAS_APPLIED_SESSION_EXPIRED

Reason Code : Use the default bias (either granted or denied) because no permission was protecting the requested resource and the associated session is expired.

See Also:

Constant Field Values

RC_ACCESS_GRANTED_CONDITIONALLY_SESSION_EXPIRED

static final int RC_ACCESS_GRANTED_CONDITIONALLY_SESSION_EXPIRED

Reason Code: Access Granted Conditionally, but the associated session is expired.

See Also:

Constant Field Values

RC_ACCESS_GRANTED_UNCONDITIONALLY_SESSION_EXPIRED

static final int RC_ACCESS_GRANTED_UNCONDITIONALLY_SESSION_EXPIRED

Reason Code: Access Granted Unconditionally, but the associated session is expired.

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.

getSecurityDomainName

String getSecurityDomainName()

Get the SecurityDomain name

Returns:

the SecurityDomain name

getLoginConfigEntryName

String getLoginConfigEntryName()

Get the LoginConfigEntry name

Returns:

the LoginConfigEntry name

getLoginParameters

Map getLoginParameters()

Get the login parameters if any exist.

Returns:

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

getSessionId

SessionId getSessionId()

Returns the session id that applied to the corresponding access control request.

Returns:

the session id that applied to the corresponding access control request

getLastModificationTime

long getLastModificationTime()

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

Returns:

the last modification time of the Cams Policy Server configuration files

log

void log(Logger logger)

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

Parameters:

logger - logs data

addMissingAttribute

void addMissingAttribute(Attribute attr)

Add a missing Attribute.

Parameters:

attr - the missing Attribute.

getMissingAttributes

Iterator getMissingAttributes()

Get all missing Attributes.

Returns:

an Iterator over all missing Attribute instances.

getMissingAttributesByCategory

Iterator getMissingAttributesByCategory(URI attrCategory)

Get all missing Attributes by category.

Returns:

an Iterator over all missing Attributes in the specifed category within this collection.

getMissingAttributeCategories

Iterator getMissingAttributeCategories()

Get all missing Attribute categories.

Returns:

an Iterator over all unique Attribute Category URIs for missing Attributes.

addObligation

void addObligation(Obligation obligation)

Add an Obligation to the response.

Parameters:

obligation - the Obligation object to add.

getObligations

Iterator getObligations()

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

Returns:

an Iterator of Obligations.

getObligationCount

int getObligationCount()

Get the number of response Obligations.

Returns:

the count of Obligation the response contains.