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

Class AttributeInMetadataMatchFunctor

java.lang.Object

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

edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.saml.AttributeInMetadataMatchFunctor

All Implemented Interfaces:

MatchFunctor

public class AttributeInMetadataMatchFunctor
extends AbstractMatchFunctor

Match functor that checks whether an attribute is enumerated in an SP's metadata as a required or optional attribute. Also supports simple string-based value filtering.

Constructor Summary

Constructors

Constructor and Description
AttributeInMetadataMatchFunctor()

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.
boolean	isMatchIfMetadataSilent() Gets whether to matched if the metadata contains no AttributeConsumingService.
boolean	isOnlyIfRequired() Gets whether optionally requested attributes should be matched.
void	setMatchIfMetadataSilent(boolean flag) Sets whether to match if the metadata contains no AttributeConsumingService.
void	setOnlyIfRequired(boolean flag) Sets whether optionally requested attributes should be matched.

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

AttributeInMetadataMatchFunctor

public AttributeInMetadataMatchFunctor()

Method Detail

isOnlyIfRequired

public boolean isOnlyIfRequired()

Gets whether optionally requested attributes should be matched.

Returns:

Whether optionally requested attributes should be matched.

setOnlyIfRequired

public void setOnlyIfRequired(boolean flag)

Sets whether optionally requested attributes should be matched.

Parameters:

flag - whether optionally requested attributes should be matched

isMatchIfMetadataSilent

public boolean isMatchIfMetadataSilent()

Gets whether to matched if the metadata contains no AttributeConsumingService.

Returns:

whether to match if the metadata contains no AttributeConsumingService

setMatchIfMetadataSilent

public void setMatchIfMetadataSilent(boolean flag)

Sets whether to match if the metadata contains no AttributeConsumingService.

Parameters:

flag - whether to match if the metadata contains no AttributeConsumingService

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

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