|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<FieldMemberFilter>
edu.internet2.middleware.grouper.shibboleth.dataConnector.field.FieldMemberFilter
public enum FieldMemberFilter
member filter for retrieving members. Originally WsMemberFilter; modified slightly to suit the needs of ldappc - tz
Enum Constant Summary | |
---|---|
all
retrieve all members (immediate, effective and composite) |
|
composite
if this is a composite group, then return all the memberships that match the composite operator (union, intersection, complement). |
|
effective
retrieve members which exist due a group as a member of another group (for composite groups, this will not return anything) |
|
immediate
return only direct members of a group (for composite groups this will not return anything) |
Method Summary | ||
---|---|---|
static
|
enumValueOfIgnoreCase(Class<E> theEnumClass,
String string,
boolean exceptionOnNotFound)
do a case-insensitive matching |
|
abstract Set<edu.internet2.middleware.grouper.Group> |
getGroups(edu.internet2.middleware.grouper.Member member)
get groups for subject |
|
abstract Set<edu.internet2.middleware.grouper.Group> |
getGroups(edu.internet2.middleware.grouper.Member member,
edu.internet2.middleware.grouper.Field field)
get groups for subject based on field |
|
Set<edu.internet2.middleware.grouper.Member> |
getMembers(edu.internet2.middleware.grouper.Group group,
edu.internet2.middleware.grouper.Field field)
get the members from the group based on type of filter |
|
protected abstract Set<edu.internet2.middleware.grouper.Member> |
getMembersHelper(edu.internet2.middleware.grouper.Group group,
edu.internet2.middleware.grouper.Field field)
get the members from the group based on type of filter |
|
Set<edu.internet2.middleware.grouper.Membership> |
getMemberships(edu.internet2.middleware.grouper.Group group,
edu.internet2.middleware.grouper.Field field)
get the memberships from the group based on type of filter |
|
protected abstract Set<edu.internet2.middleware.grouper.Membership> |
getMembershipsHelper(edu.internet2.middleware.grouper.Group group,
edu.internet2.middleware.grouper.Field field)
get the memberships from the group based on type of filter |
|
boolean |
hasMember(edu.internet2.middleware.grouper.Group group,
edu.internet2.middleware.subject.Subject subject,
edu.internet2.middleware.grouper.Field field)
see if a subject is in a group |
|
protected abstract boolean |
hasMemberHelper(edu.internet2.middleware.grouper.Group group,
edu.internet2.middleware.subject.Subject subject,
edu.internet2.middleware.grouper.Field field)
see if a subject is in a group |
|
static FieldMemberFilter |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
|
static FieldMemberFilter |
valueOfIgnoreCase(String string)
do a case-insensitive matching |
|
static FieldMemberFilter[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final FieldMemberFilter all
public static final FieldMemberFilter effective
public static final FieldMemberFilter immediate
public static final FieldMemberFilter composite
Method Detail |
---|
public static FieldMemberFilter[] values()
for (FieldMemberFilter c : FieldMemberFilter.values()) System.out.println(c);
public static FieldMemberFilter valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is nullpublic final Set<edu.internet2.middleware.grouper.Member> getMembers(edu.internet2.middleware.grouper.Group group, edu.internet2.middleware.grouper.Field field)
group
- field
- for membership or null to not check field
protected abstract Set<edu.internet2.middleware.grouper.Member> getMembersHelper(edu.internet2.middleware.grouper.Group group, edu.internet2.middleware.grouper.Field field) throws edu.internet2.middleware.grouper.exception.SchemaException
group
- field
- for membership or null to not check field
edu.internet2.middleware.grouper.exception.SchemaException
- if problem with fieldprotected abstract Set<edu.internet2.middleware.grouper.Membership> getMembershipsHelper(edu.internet2.middleware.grouper.Group group, edu.internet2.middleware.grouper.Field field) throws edu.internet2.middleware.grouper.exception.SchemaException
group
- field
- for membership or null to not check field
edu.internet2.middleware.grouper.exception.SchemaException
- is there is a problem with fieldpublic final Set<edu.internet2.middleware.grouper.Membership> getMemberships(edu.internet2.middleware.grouper.Group group, edu.internet2.middleware.grouper.Field field)
group
- field
- for membership or null to not check field
edu.internet2.middleware.grouper.exception.SchemaException
- is there is a problem with fieldprotected abstract boolean hasMemberHelper(edu.internet2.middleware.grouper.Group group, edu.internet2.middleware.subject.Subject subject, edu.internet2.middleware.grouper.Field field) throws edu.internet2.middleware.grouper.exception.SchemaException
group
- subject
- field
-
edu.internet2.middleware.grouper.exception.SchemaException
public final boolean hasMember(edu.internet2.middleware.grouper.Group group, edu.internet2.middleware.subject.Subject subject, edu.internet2.middleware.grouper.Field field)
group
- subject
- field
-
edu.internet2.middleware.grouper.exception.SchemaException
public abstract Set<edu.internet2.middleware.grouper.Group> getGroups(edu.internet2.middleware.grouper.Member member)
member
- field
- to check with membership
public abstract Set<edu.internet2.middleware.grouper.Group> getGroups(edu.internet2.middleware.grouper.Member member, edu.internet2.middleware.grouper.Field field)
member
- field
- field
- to check with membership
public static FieldMemberFilter valueOfIgnoreCase(String string)
string
-
public static <E extends Enum<?>> E enumValueOfIgnoreCase(Class<E> theEnumClass, String string, boolean exceptionOnNotFound) throws RuntimeException
E
- generic typetheEnumClass
- class of the enumstring
- exceptionOnNotFound
- true if exception should be thrown on not found
GrouperRestInvalidRequest
- if there is a problem
RuntimeException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |