edu.internet2.middleware.shibboleth.common.attribute.filtering.provider
Interface MatchFunctor

All Known Implementing Classes:
AbstractAttributeTargetedRegexMatchFunctor, AbstractAttributeTargetedStringMatchFunctor, AbstractEntityAttributeExactMatchFunctor, AbstractEntityAttributeMatchFunctor, AbstractEntityAttributeRegexMatchFunctor, AbstractEntityGroupMatchFunctor, AbstractMatchFunctor, AbstractNameIDFormatSupportedMatchFunctor, AbstractRegexMatchFunctor, AbstractStringMatchFunctor, AndMatchFunctor, AnyMatchFunctor, AttributeIssuerEntityAttributeExactMatchFunctor, AttributeIssuerEntityAttributeRegexMatchFunctor, AttributeIssuerInEntityGroupMatchFunctor, AttributeIssuerNameIDFormatExactMatchFunctor, AttributeIssuerRegexMatchFunctor, AttributeIssuerStringMatchFunctor, AttributeRequesterEntityAttributeExactMatchFunctor, AttributeRequesterEntityAttributeRegexMatchFunctor, AttributeRequesterInEntityGroupMatchFunctor, AttributeRequesterNameIDFormatExactMatchFunctor, AttributeRequesterRegexMatchFunctor, AttributeRequesterStringMatchFunctor, AttributeScopeRegexMatchFunctor, AttributeScopeStringMatchFunctor, AttributeValueRegexMatchFunctor, AttributeValueStringMatchFunctor, AuthenticationMethodRegexMatchFunctor, AuthenticationMethodStringMatchFunctor, NotMatchFunctor, NumOfAttributeValuesMatchFunctor, OrMatchFunctor, PrincipalRegexMatchFunctor, PrincipalStringMatchFunctor, ScriptMatchFunctor

public interface MatchFunctor

A function that evaluates whether an expressed criteria is met by the current filter context.


Method Summary
 boolean evaluateDenyRule(ShibbolethFilteringContext filterContext, String attributeId, Object attributeValue)
          Evaluates this matching criteria.
 boolean evaluatePermitValue(ShibbolethFilteringContext filterContext, String attributeId, Object attributeValue)
          Evaluates this matching criteria.
 boolean evaluatePolicyRequirement(ShibbolethFilteringContext filterContext)
          Evaluates this matching criteria.
 

Method Detail

evaluatePolicyRequirement

boolean evaluatePolicyRequirement(ShibbolethFilteringContext filterContext)
                                  throws FilterProcessingException
Evaluates this matching criteria. This evaluation is used while the filtering engine determines policy applicability.

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

evaluatePermitValue

boolean evaluatePermitValue(ShibbolethFilteringContext filterContext,
                            String attributeId,
                            Object attributeValue)
                            throws FilterProcessingException
Evaluates this matching criteria. This evaluation is used while the filtering engine evaluating permit value rules.

Parameters:
filterContext - the current filtering context
attributeId - 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

evaluateDenyRule

boolean evaluateDenyRule(ShibbolethFilteringContext filterContext,
                         String attributeId,
                         Object attributeValue)
                         throws FilterProcessingException
Evaluates this matching criteria. This evaluation is used while the filtering engine is evaluating deny value rules.

Parameters:
filterContext - the current filtering context
attributeId - 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


Copyright © 2006-2011 Internet2. All Rights Reserved.