edu.internet2.middleware.shibboleth.common.attribute.filtering

Interface AttributeFilteringEngine<ContextType extends AttributeRequestContext>

Type Parameters:

ContextType - type of request context expected by this filtering engine

All Known Implementing Classes:

ShibbolethAttributeFilteringEngine

public interface AttributeFilteringEngine<ContextType extends AttributeRequestContext>

The engine that applies attribute acceptance policies to a collection of attributes.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,BaseAttribute>	filterAttributes(Map<String,BaseAttribute> attributes, ContextType context) Filters values for the given attribute, removing or allowing attributes per some implementation specific policy.

Method Detail

filterAttributes

Map<String,BaseAttribute> filterAttributes(Map<String,BaseAttribute> attributes,
                                         ContextType context)
                                           throws AttributeFilteringException

Filters values for the given attribute, removing or allowing attributes per some implementation specific policy. This filtering process may remove attributes with no values but must not add attributes or attribute values.

Parameters:

attributes - attributes to be filtered

context - attribute request context

Returns:

the filtered attributes, attribute ID is the key, attribute object is the value

Throws:

AttributeFilteringException - thrown if there is a problem retrieving or applying the attribute acceptance policy