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.

Field Summary

Fields

Modifier and Type	Field and Description
private String	attributeName The SAML Attribute Name to look for in the metadata.
private String	attributeNameFormat The SAML Attribute NameFormat to look for in the metadata.
private org.slf4j.Logger	log Class logger.
private boolean	matchIfMetadataSilent Whether to return a match if the metadata does not contain an ACS descriptor.
private boolean	onlyIfRequired Whether optionally requested attributes should be matched.

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.
private RequestedAttribute	findInMetadata(AttributeConsumingService service, AttributeEncoder encoder) Locates a RequestedAttribute object in metadata that matches the eventual "to be encoded" name represented by the encoder.
private RequestedAttribute	findInMetadata(AttributeConsumingService service, String name, String nameFormat) Locates a RequestedAttribute object in metadata that matches a specific Attribute Name and NameFormat.
boolean	isMatchIfMetadataSilent() Gets whether to matched if the metadata contains no AttributeConsumingService.
boolean	isOnlyIfRequired() Gets whether optionally requested attributes should be matched.
private boolean	match(XMLObject xmlObj, String attributeValue) Checks whether an XMLObject's "value" matches a candidate value.
void	setAttributeName(String name) Set the SAML Attribute Name to look for in the metadata.
void	setAttributeNameFormat(String format) Set the SAML Attribute Namespace to look for in the metadata.
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

Field Detail

log

private final org.slf4j.Logger log

Class logger.

onlyIfRequired

private boolean onlyIfRequired

Whether optionally requested attributes should be matched.

matchIfMetadataSilent

private boolean matchIfMetadataSilent

Whether to return a match if the metadata does not contain an ACS descriptor.

attributeName

private String attributeName

The SAML Attribute Name to look for in the metadata.

attributeNameFormat

private String attributeNameFormat

The SAML Attribute NameFormat to look for in the metadata.

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

setAttributeName

public void setAttributeName(String name)

Set the SAML Attribute Name to look for in the metadata. If not used, the evaluated attribute's own eventual encoded name(s) will be used to find a match.

This allows a "look aside" to match a different SAML Attribute Name in the metadata.

Parameters:

name - the Name to look for

setAttributeNameFormat

public void setAttributeNameFormat(String format)

Set the SAML Attribute Namespace to look for in the metadata. If not used, the evaluated attribute's own eventual encoded name format(s) will be used to find a match.

This allows a "look aside" to match a different SAML Attribute NameFormat in the metadata.

Parameters:

format - the NameFormat to look for

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

findInMetadata

private RequestedAttribute findInMetadata(AttributeConsumingService service,
                                AttributeEncoder encoder)

Locates a RequestedAttribute object in metadata that matches the eventual "to be encoded" name represented by the encoder.

Parameters:

service - the metadata descriptor to search

encoder - the attribute encoder to base the search on

Returns:

a matching RequestedAttribute, or null

findInMetadata

private RequestedAttribute findInMetadata(AttributeConsumingService service,
                                String name,
                                String nameFormat)

Locates a RequestedAttribute object in metadata that matches a specific Attribute Name and NameFormat.

Parameters:

service - the metadata descriptor to search

name - Attribute Name to match

nameFormat - Attribute NameFormat to match

Returns:

a matching RequestedAttribute, or null

match

private boolean match(XMLObject xmlObj,
            String attributeValue)

Checks whether an XMLObject's "value" matches a candidate value.

Parameters:

xmlObj - the XMLObject to match

attributeValue - the candidate value to match against

Returns:

true iff the two parameters are non-null and match