com.cafesoft.cams.access
Interface AccessControlRequest

All Known Subinterfaces:

InternalAccessControlRequest, ProtoAccessControlRequest

public interface AccessControlRequest

The interface to an Access Control Request for a Cafesoft SecurityDomain's Access Control Engine.

Since:

5/21/02

Method Summary

void	addAttribute(Attribute attr) Add an Attribute to the request.
void	addSessionId(SessionId sessionId) Add a session id to the AccessRequest
void	clearSessionIds() Clear the AccessControlRequest session id's.
EvaluationResult	getAttribute(URI attrCategory, URI type, URI id) Returns attribute value(s) from the access control request.
Iterator	getAttributeCategories() Returns the attribute categories represented in this collection.
Iterator	getAttributes() Get all Attributes.
Iterator	getAttributesByCategory(URI attrCategory) Get all Attributes by category.
AttributeValue	getResourceId() Get the Resource identifier.
Iterator	getSessionIds() Get all of the Session Ids added to the request.
boolean	hasSessionIds() Determine if AccessControlRequest had session id's.
void	log(Logger logger, boolean logAttributes) Logs the data contained in this request to the specified logger.
void	setConfidential(boolean confidential) Set the Confidential status.
void	setLoginConfigEntry(String loginConfigEntry) Sets name of the application making this request.
void	setRemoteAddr(String address) Set the Internet Protocol (IP) address of the client that sent the request.
void	setRemoteHost(String host) Set the fully qualified name of the client that sent the request.
void	setResourceRequest(ResourceRequest resReq) Set the ResourceRequest associated with this AccessControlRequest.

Method Detail

setResourceRequest

void setResourceRequest(ResourceRequest resReq)

Set the ResourceRequest associated with this AccessControlRequest.

Parameters:

resReq - the ResourceRequest.

addSessionId

void addSessionId(SessionId sessionId)

Add a session id to the AccessRequest

Parameters:

sessionId - the SessionId object associated with the AccessControlRequest

hasSessionIds

boolean hasSessionIds()

Determine if AccessControlRequest had session id's.

Returns:

true if request has session id's, false otherwise.

getSessionIds

Iterator getSessionIds()

Get all of the Session Ids added to the request.

Returns:

an iterator of SessionId objects.

clearSessionIds

void clearSessionIds()

Clear the AccessControlRequest session id's.

setRemoteAddr

void setRemoteAddr(String address)

Set the Internet Protocol (IP) address of the client that sent the request.

Parameters:

address - the new IP address

setRemoteHost

void setRemoteHost(String host)

Set the fully qualified name of the client that sent the request. If the hostname cannot be resolved, this method sets the dotted-string form of the IP address as the host name.

Parameters:

host - the host name as a String

setConfidential

void setConfidential(boolean confidential)

Set the Confidential status.

Parameters:

confidential - if true, the resource is being requested via a confidential network connection. If false, the resource is not being requested via a confidential (secure) connection.

setLoginConfigEntry

void setLoginConfigEntry(String loginConfigEntry)

Sets name of the application making this request.

Parameters:

loginConfigEntry - the application name of the agent making this request

addAttribute

void addAttribute(Attribute attr)

Add an Attribute to the request.

Parameters:

attr - the Attribute to be added.

getResourceId

AttributeValue getResourceId()

Get the Resource identifier.

Returns:

the resource identifier associated with this request as an AttributeValue.

getAttribute

EvaluationResult getAttribute(URI attrCategory,
                              URI type,
                              URI id)

Returns attribute value(s) from the access control request.

Parameters:

attrCategory - the category of the attribute value(s) to find

type - the type of the attribute value(s) to find

id - the id of the attribute value(s) to find

Returns:

a result containing a bag either empty because no values were found or containing at least one value, or status associated with an "indeterminate" result.

getAttributes

Iterator getAttributes()

Get all Attributes.

Returns:

an Iterator over all Attributes in this request.

getAttributesByCategory

Iterator getAttributesByCategory(URI attrCategory)

Get all Attributes by category.

Returns:

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

getAttributeCategories

Iterator getAttributeCategories()

Returns the attribute categories represented in this collection.

Returns:

an Iterator providing access to java.net.URI instances: one per attribute category.

log

void log(Logger logger,
         boolean logAttributes)

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

Parameters:

logger - logs data.

logAttributes - boolean flag that indicates whether the log method should log the AccessControlRequest's attributes. If the value is true the attributes are logged, otherwise the attributes are not logged.