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

Class GroupsField

java.lang.Object

edu.internet2.middleware.grouper.shibboleth.dataConnector.field.BaseField

edu.internet2.middleware.grouper.shibboleth.dataConnector.field.BaseMembershipField

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

public class GroupsField
extends BaseMembershipField

A representation of an attribute consisting of Groups.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME the first element of the identifier

Fields inherited from class edu.internet2.middleware.grouper.shibboleth.dataConnector.field.BaseField

DELIMITER

Constructor Summary

Constructors

Constructor and Description
GroupsField(String id)

Method Summary

Methods

Modifier and Type	Method and Description
edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute<Group>	getAttribute(Member member) Get the resultant attribute whose values are the Groups that the given Member belongs to.
edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute<Group>	getAttribute(Member member, Filter filter) 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 GrouperException

Throws:

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<Group> getAttribute(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<Group> getAttribute(Member member,
                                                                                     Filter filter)

Get the resultant attribute whose values are the Groups that the given Member belongs to. If the Filter is not null, then only the groups which match the filter are returned.

Parameters:

member - the member

filter - the filter

Returns:

the attribute consisting of groups or null if the member does not belong to any groups