edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic

Class AttributeValueStringMatchFunctor

java.lang.Object

edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic.AbstractMatchFunctor

edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic.AbstractStringMatchFunctor

edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic.AbstractAttributeTargetedStringMatchFunctor

edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic.AttributeValueStringMatchFunctor

All Implemented Interfaces:

MatchFunctor

public class AttributeValueStringMatchFunctor
extends AbstractAttributeTargetedStringMatchFunctor

A match function that evaluates an attribute's value against the given match string.

Constructor Summary

Constructors

Constructor and Description
AttributeValueStringMatchFunctor()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	doEvaluatePolicyRequirement(ShibbolethFilteringContext filterContext) Evaluates to true if any value for the specified attribute matches the given match string.
protected boolean	doEvaluateValue(ShibbolethFilteringContext filterContext, String id, Object attributeValue) Evaluates to true if the given attribute value matches the given match string.

Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic.AbstractAttributeTargetedStringMatchFunctor

getAttributeId, setAttributeId

Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic.AbstractStringMatchFunctor

getMatchString, isCaseSensitive, isMatch, setCaseSensitive, setMatchString

Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic.AbstractMatchFunctor

evaluateDenyRule, evaluatePermitValue, evaluatePolicyRequirement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttributeValueStringMatchFunctor

public AttributeValueStringMatchFunctor()

Method Detail

doEvaluatePolicyRequirement

protected boolean doEvaluatePolicyRequirement(ShibbolethFilteringContext filterContext)
                                       throws FilterProcessingException

Evaluates to true if any value for the specified attribute matches the given match string. Evaluates this matching criteria. This evaluation is used while the filtering engine determines policy applicability.

Specified by:

doEvaluatePolicyRequirement in class AbstractMatchFunctor

Parameters:

filterContext - current filtering context

Returns:

true if the criteria for this matching function are meant

Throws:

FilterProcessingException - thrown if the function can not be evaluated

doEvaluateValue

protected boolean doEvaluateValue(ShibbolethFilteringContext filterContext,
                      String id,
                      Object attributeValue)
                           throws FilterProcessingException

Evaluates to true if the given attribute value matches the given match string. Evaluates this matching criteria. This evaluation is used while the filtering engine is evaluating either a deny or permit value rule.

Specified by:

doEvaluateValue in class AbstractMatchFunctor

Parameters:

filterContext - the current filtering context

id - ID of the attribute being evaluated

attributeValue - value of the attribute being evaluated

Returns:

true if the criteria for this matching function are meant

Throws:

FilterProcessingException - thrown if the function can not be evaluated