edu.internet2.middleware.grouper.shibboleth.dataConnector.field
Class GroupsField

java.lang.Object
  extended by edu.internet2.middleware.grouper.shibboleth.dataConnector.field.BaseField
      extended by edu.internet2.middleware.grouper.shibboleth.dataConnector.field.BaseMembershipField
          extended by edu.internet2.middleware.grouper.shibboleth.dataConnector.field.GroupsField

public class GroupsField
extends BaseMembershipField

A representation of an attribute consisting of Groups.


Field Summary
static String NAME
          the first element of the identifier
 
Fields inherited from class edu.internet2.middleware.grouper.shibboleth.dataConnector.field.BaseField
DELIMITER
 
Constructor Summary
GroupsField(String id)
           
 
Method Summary
 edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute<edu.internet2.middleware.grouper.Group> getAttribute(edu.internet2.middleware.grouper.Member member)
          Get the resultant attribute whose values are the Groups that the given Member belongs to.
 edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute<edu.internet2.middleware.grouper.Group> getAttribute(edu.internet2.middleware.grouper.Member member, GroupQueryFilter groupQueryFilter)
          Get the resultant attribute whose values are the Groups that the given Member belongs to.
 
Methods inherited from class edu.internet2.middleware.grouper.shibboleth.dataConnector.field.BaseMembershipField
getField, getMemberFilter
 
Methods inherited from class edu.internet2.middleware.grouper.shibboleth.dataConnector.field.BaseField
getFirstIdElement, getId, getIdElements, getSecondIdElement, getThirdIdElement
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

public static final String NAME
the first element of the identifier

See Also:
Constant Field Values
Constructor Detail

GroupsField

public GroupsField(String id)
            throws edu.internet2.middleware.grouper.exception.GrouperException
Throws:
edu.internet2.middleware.grouper.exception.GrouperException
See Also:
edu.internet2.middleware.grouper.shibboleth.dataConnector.field.BaseField#constructor(String id)
Method Detail

getAttribute

public edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute<edu.internet2.middleware.grouper.Group> getAttribute(edu.internet2.middleware.grouper.Member member)
Get the resultant attribute whose values are the Groups that the given Member belongs to.

Parameters:
member - the member
Returns:
the attribute consisting of groups or null if the member does not belong to any groups

getAttribute

public edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute<edu.internet2.middleware.grouper.Group> getAttribute(edu.internet2.middleware.grouper.Member member,
                                                                                                                               GroupQueryFilter groupQueryFilter)
Get the resultant attribute whose values are the Groups that the given Member belongs to. If the GroupQueryFilter is not null, then only the groups which match the filter are returned.

Parameters:
member - the member
groupQueryFilter - the group filter
Returns:
the attribute consisting of groups or null if the member does not belong to any groups


Copyright © 2011 Internet2. All Rights Reserved.