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

Class NotMatchFunctor

java.lang.Object

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

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

All Implemented Interfaces:

MatchFunctor

public class NotMatchFunctor
extends AbstractMatchFunctor

A match functor that performs a logical NOT on the result of another functor.

Field Summary

Fields

Modifier and Type	Field and Description
private MatchFunctor	targetRule Match functor to negate.

Constructor Summary

Constructors

Constructor and Description
NotMatchFunctor(MatchFunctor rule) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	doEvaluatePolicyRequirement(ShibbolethFilteringContext filterContext) Evaluates this matching criteria.
protected boolean	doEvaluateValue(ShibbolethFilteringContext filterContext, String attributeId, Object attributeValue) Evaluates this matching criteria.
MatchFunctor	getTargetRule() Gets the match functor that will be the target of the logical NOT.
void	setTargetRule(MatchFunctor target) Sets the match functor that will be the target of the logical NOT.

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

Field Detail

targetRule

private MatchFunctor targetRule

Match functor to negate.

Constructor Detail

NotMatchFunctor

public NotMatchFunctor(MatchFunctor rule)

Constructor.

Parameters:

rule - rule to NOT

Method Detail

getTargetRule

public MatchFunctor getTargetRule()

Gets the match functor that will be the target of the logical NOT.

Returns:

match functor that will be the target of the logical NOT

setTargetRule

public void setTargetRule(MatchFunctor target)

Sets the match functor that will be the target of the logical NOT.

Parameters:

target - match functor that will be the target of the logical NOT

doEvaluateValue

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

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

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

doEvaluatePolicyRequirement

protected boolean doEvaluatePolicyRequirement(ShibbolethFilteringContext filterContext)
                                       throws FilterProcessingException

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