com.cafesoft.cams.access.attr
Interface AttributeTarget

All Known Implementing Classes:

StandardAttributeTarget

public interface AttributeTarget

AttributeTarget defines the interface for a conjunctive sequence of AttributeConditions instances used to match an AccessControlRequest. Each AttributeConditions instance must have a unique attribute category. AttributeTarget is responsible for matching AttributeConditions instances and returning a "MATCH" status if ALL AttributeConditions match. AttributeConditions are matched in the order specified by a List.

Since:

5/10/2004

Method Summary

AccessControlRule	getAccessControlRule() Returns the associated AccessControlRule.
List	getAttributeConditionsList() Get the List of AttributeConditions to be matched.
String	getDescription() Returns a textual description.
MatchResult	match(EvaluationContext evalContext) Determines whether this AttributeTarget matches the input request (whether it is applicable).
void	setAttributeConditionsList(List attrCondsList) Set the List of AttributeConditions to be matched.

Method Detail

getDescription

String getDescription()

Returns a textual description.

Returns:

a textual description of the AttributeTarget or null if no description is available.

getAccessControlRule

AccessControlRule getAccessControlRule()

Returns the associated AccessControlRule.

Returns:

the AccessControlRule associated with this AttributeTarget. NOTE: It is the caller's responsibility to evaluate the AccessControlRule in the event that an AccessControlRequest matches this AttributeTarget.

setAttributeConditionsList

void setAttributeConditionsList(List attrCondsList)
                                throws IllegalArgumentException

Set the List of AttributeConditions to be matched.

Parameters:

attrCondsList - the List of AttributeConditions.

Throws:

IllegalArgumentException - if one or more Objects within the AttributeConditions list are of the incorrect type.

getAttributeConditionsList

List getAttributeConditionsList()

Get the List of AttributeConditions to be matched.

Returns:

a List of AttributeConditions or an empty List if no current AttributeConditions.

match

MatchResult match(EvaluationContext evalContext)

Determines whether this AttributeTarget matches the input request (whether it is applicable). This will be true only if ALL enclosed AttributeConditionss match.

Parameters:

evalContext - the representation of the request

Returns:

the result of trying to match the AttributeConditions and the request