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

Class AbstractAttributeTargetedRegexMatchFunctor

java.lang.Object

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

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

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

All Implemented Interfaces:

MatchFunctor

Direct Known Subclasses:

AttributeScopeRegexMatchFunctor, AttributeValueRegexMatchFunctor

public abstract class AbstractAttributeTargetedRegexMatchFunctor
extends AbstractRegexMatchFunctor

Base class for match functions that match a regular expresion against an attribute's value.

Field Summary

Fields

Modifier and Type	Field and Description
private String	attributeId ID of the attribute whose values will be evaluated.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
AbstractAttributeTargetedRegexMatchFunctor()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	evaluatePermitValue(ShibbolethFilteringContext filterContext, String id, Object attributeValue) Evaluates this matching criteria.
String	getAttributeId() Gets the ID of the attribute whose values will be evaluated.
void	setAttributeId(String id) Sets the ID of the attribute whose values will be evaluated.
protected void	warnOnTargeted(String actualId) Emits a warning in the event that a target attribute is configured, because this target is ignored during Permit/Deny rule evaluation.

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

getRegularExpression, isMatch, setRegularExpression

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

doEvaluatePolicyRequirement, doEvaluateValue, evaluateDenyRule, evaluatePolicyRequirement

Methods inherited from class java.lang.Object

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

Field Detail

log

private final org.slf4j.Logger log

Class logger.

attributeId

private String attributeId

ID of the attribute whose values will be evaluated.

Constructor Detail

AbstractAttributeTargetedRegexMatchFunctor

public AbstractAttributeTargetedRegexMatchFunctor()

Method Detail

getAttributeId

public String getAttributeId()

Gets the ID of the attribute whose values will be evaluated.

Returns:

ID of the attribute whose values will be evaluated

setAttributeId

public void setAttributeId(String id)

Sets the ID of the attribute whose values will be evaluated.

Parameters:

id - ID of the attribute whose values will be evaluated

evaluatePermitValue

public boolean evaluatePermitValue(ShibbolethFilteringContext filterContext,
                          String id,
                          Object attributeValue)
                            throws FilterProcessingException

Evaluates this matching criteria. This evaluation is used while the filtering engine evaluating permit value rules.

Specified by:

evaluatePermitValue in interface MatchFunctor

Overrides:

evaluatePermitValue 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

warnOnTargeted

protected void warnOnTargeted(String actualId)

Emits a warning in the event that a target attribute is configured, because this target is ignored during Permit/Deny rule evaluation.

Parameters:

actualId - the actual attribute being evaluated