edu.internet2.middleware.grouper.shibboleth.filter
Class GroupExactAttributeFilter

java.lang.Object
  extended by edu.internet2.middleware.grouper.shibboleth.filter.AbstractFilter<edu.internet2.middleware.grouper.Group>
      extended by edu.internet2.middleware.grouper.shibboleth.filter.GroupExactAttributeFilter
All Implemented Interfaces:
edu.internet2.middleware.grouper.filter.QueryFilter<edu.internet2.middleware.grouper.Group>, Filter<edu.internet2.middleware.grouper.Group>

public class GroupExactAttributeFilter
extends AbstractFilter<edu.internet2.middleware.grouper.Group>

Selects Groups by attribute name and value.


Constructor Summary
GroupExactAttributeFilter(String name, String value)
          Creates a GroupAttributeFilter which returns groups with the given attribute name and value.
 
Method Summary
 edu.internet2.middleware.grouper.filter.QueryFilter<edu.internet2.middleware.grouper.Group> getQueryFilter()
          If the query filter is null, create a new GroupAttributeFilter.
 boolean matches(edu.internet2.middleware.grouper.Group group)
          Returns true if the group has an attribute with the configured name and value.
 
Methods inherited from class edu.internet2.middleware.grouper.shibboleth.filter.AbstractFilter
getGrouperSession, getResults, setQueryFilter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupExactAttributeFilter

public GroupExactAttributeFilter(String name,
                                 String value)
Creates a GroupAttributeFilter which returns groups with the given attribute name and value. Groups are not restricted by stem.

Parameters:
name - the attribute name
value - the attribute value
Method Detail

getQueryFilter

public edu.internet2.middleware.grouper.filter.QueryFilter<edu.internet2.middleware.grouper.Group> getQueryFilter()
If the query filter is null, create a new GroupAttributeFilter. As this filter relies upon a GrouperSession, this method should be called after the session has been started in the parent BaseGrouperDataConnector. Get the query filter.

Overrides:
getQueryFilter in class AbstractFilter<edu.internet2.middleware.grouper.Group>
Returns:
the QueryFilter

matches

public boolean matches(edu.internet2.middleware.grouper.Group group)
Returns true if the group has an attribute with the configured name and value. Returns true if the Grouper object would be returned by the filter. False otherwise.

Parameters:
group - the Grouper object
Returns:
if the Grouper object matches or not


Copyright © 2012 Internet2. All Rights Reserved.