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

java.lang.Object
  extended by edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.ShibbolethFilteringContext

public class ShibbolethFilteringContext
extends Object

Contextual information for performing attribute filtering.


Field Summary
private  SAMLProfileRequestContext attributeRequestContext
          The attribute request.
private  Map<String,List<MatchFunctor>> denyValueRules
          Deny value rules that apply to the attribute identified by the map key.
private  Map<String,Collection> retainedValues
          Retained values for a given attribute.
private  Map<String,BaseAttribute> unfilteredAttributes
          Attributes being filtered.
 
Constructor Summary
ShibbolethFilteringContext(Map<String,BaseAttribute> attributes, SAMLProfileRequestContext context)
          Constructor.
 
Method Summary
 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
 

Field Detail

attributeRequestContext

private SAMLProfileRequestContext attributeRequestContext
The attribute request.


unfilteredAttributes

private Map<String,BaseAttribute> unfilteredAttributes
Attributes being filtered.


retainedValues

private Map<String,Collection> retainedValues
Retained values for a given attribute.


denyValueRules

private Map<String,List<MatchFunctor>> denyValueRules
Deny value rules that apply to the attribute identified by the map key.

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


Copyright © 1999-2012. All Rights Reserved.