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

java.lang.Object
  extended by edu.internet2.middleware.grouper.shibboleth.filter.BaseGroupQueryFilter
All Implemented Interfaces:
edu.internet2.middleware.grouper.filter.QueryFilter<edu.internet2.middleware.grouper.Group>, GroupQueryFilter
Direct Known Subclasses:
ConditionalGroupQueryFilter, ExactAttributeGroupFilter, StemNameGroupFilter

public abstract class BaseGroupQueryFilter
extends Object
implements GroupQueryFilter

Base class for GroupQueryFilters.


Constructor Summary
BaseGroupQueryFilter()
           
 
Method Summary
 edu.internet2.middleware.grouper.GrouperSession getGrouperSession()
          Get the grouper session.
 edu.internet2.middleware.grouper.filter.QueryFilter<edu.internet2.middleware.grouper.Group> getQueryFilter()
          Get the query filter.
 Set<edu.internet2.middleware.grouper.Group> getResults(edu.internet2.middleware.grouper.GrouperSession s)
          
 void setGrouperSession(edu.internet2.middleware.grouper.GrouperSession grouperSession)
          Set the grouper session.
 void setQueryFilter(edu.internet2.middleware.grouper.filter.QueryFilter<edu.internet2.middleware.grouper.Group> queryFilter)
          Set the query filter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface edu.internet2.middleware.grouper.shibboleth.filter.GroupQueryFilter
matchesGroup
 

Constructor Detail

BaseGroupQueryFilter

public BaseGroupQueryFilter()
Method Detail

getResults

public Set<edu.internet2.middleware.grouper.Group> getResults(edu.internet2.middleware.grouper.GrouperSession s)
                                                       throws edu.internet2.middleware.grouper.exception.QueryException

Specified by:
getResults in interface edu.internet2.middleware.grouper.filter.QueryFilter<edu.internet2.middleware.grouper.Group>
Throws:
edu.internet2.middleware.grouper.exception.QueryException

getGrouperSession

public edu.internet2.middleware.grouper.GrouperSession getGrouperSession()
Get the grouper session. Re-uses the same session. A grouper session must have been started already in the jvm.

Returns:
the grouper session

getQueryFilter

public edu.internet2.middleware.grouper.filter.QueryFilter<edu.internet2.middleware.grouper.Group> getQueryFilter()
Get the query filter.

Returns:
the QueryFilter

setQueryFilter

public void setQueryFilter(edu.internet2.middleware.grouper.filter.QueryFilter<edu.internet2.middleware.grouper.Group> queryFilter)
Set the query filter.

Parameters:
queryFilter -

setGrouperSession

public void setGrouperSession(edu.internet2.middleware.grouper.GrouperSession grouperSession)
Set the grouper session.

Specified by:
setGrouperSession in interface GroupQueryFilter
Parameters:
grouperSession -


Copyright © 2011 Internet2. All Rights Reserved.