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

Class ShibbolethFilteringContext

java.lang.Object

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

public class ShibbolethFilteringContext
extends Object

Contextual information for performing attribute filtering.

Constructor Summary

Constructors

Constructor and Description
ShibbolethFilteringContext(Map<String,BaseAttribute> attributes, SAMLProfileRequestContext context) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
SAMLProfileRequestContext	getAttributeRequestContext() Gets the context for the attribute request.
Map<String,List<MatchFunctor>>	getDenyValueRules() Gets the deny value rules that apply to the attribute.
Collection	getRetainedValues(String attributeId, boolean prepopulate) Gets the values, for the given attribute, that have no yet been filtered out.
Map<String,BaseAttribute>	getUnfilteredAttributes() Gets the attributes being filtered.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShibbolethFilteringContext

public ShibbolethFilteringContext(Map<String,BaseAttribute> attributes,
                          SAMLProfileRequestContext context)

Constructor.

Parameters:

attributes - unfiltered attribute set

context - attribute request context

Method Detail

getAttributeRequestContext

public SAMLProfileRequestContext getAttributeRequestContext()

Gets the context for the attribute request.

Returns:

context for the attribute request

getUnfilteredAttributes

public Map<String,BaseAttribute> getUnfilteredAttributes()

Gets the attributes being filtered.

Returns:

attributes being filtered

getRetainedValues

public Collection getRetainedValues(String attributeId,
                           boolean prepopulate)

Gets the values, for the given attribute, that have no yet been filtered out.

Parameters:

attributeId - attribute to retrieve the values for

prepopulate - whether to pre-populate the retained value list from the unfiltered value list if there is currently no set of values retained for the given attribute

Returns:

attribute values not yet filtered out, never null

getDenyValueRules

public Map<String,List<MatchFunctor>> getDenyValueRules()

Gets the deny value rules that apply to the attribute. The map key is the ID of the attribute, the value is a list of deny rules that apply to that attribute.

Returns:

deny value rules that apply to the attribute