|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectedu.internet2.middleware.grouper.MemberFinder
public class MemberFinder
Find members within the Groups Registry.
| Constructor Summary | |
|---|---|
MemberFinder()
|
|
| Method Summary | |
|---|---|
static void |
clearInternalMembers()
|
static java.util.Set |
findAll(GrouperSession s)
Find all members. |
static java.util.Set<Member> |
findAll(GrouperSession s,
edu.internet2.middleware.subject.Source source)
Find all members by source. |
static java.util.Set<Member> |
findAllUsed(GrouperSession grouperSession,
edu.internet2.middleware.subject.Source source)
Find all members by source used somewhere, e.g. with memberships or attributes etc. |
static Member |
findBySubject(GrouperSession s,
edu.internet2.middleware.subject.Subject subj)
Deprecated. use overload |
static Member |
findBySubject(GrouperSession s,
edu.internet2.middleware.subject.Subject subj,
boolean createIfNotExist)
Convert a Subject to a Member. |
static java.util.Set<Member> |
findBySubjects(java.util.Collection<edu.internet2.middleware.subject.Subject> subjects,
boolean createIfNotExists)
convert a set of subjects to a set of members |
static java.util.Set<Member> |
findBySubjectsInGroup(GrouperSession grouperSession,
java.util.Set<edu.internet2.middleware.subject.Subject> subjects,
Group group,
Field field,
MembershipType membershipType)
convert a set of subjects to a set of members |
static Member |
findByUuid(GrouperSession s,
java.lang.String uuid)
Deprecated. |
static Member |
findByUuid(GrouperSession s,
java.lang.String uuid,
boolean exceptionIfNotFound)
Get a member by UUID. |
static Member |
internal_createMember(edu.internet2.middleware.subject.Subject subj,
java.lang.String memberUuidIfCreate)
create a member |
static Member |
internal_findAllMember()
|
static Member |
internal_findBySubject(edu.internet2.middleware.subject.Subject subj,
java.lang.String uuidIfCreate,
boolean createIfNotExist)
find a member, perhaps create a new one if not there |
static java.util.Set<Member> |
internal_findMembersByType(GrouperSession grouperSession,
Group group,
Field field,
java.lang.String type,
java.util.Set<edu.internet2.middleware.subject.Source> sources,
QueryOptions queryOptions,
SortStringEnum memberSortStringEnum,
SearchStringEnum memberSearchStringEnum,
java.lang.String memberSearchStringValue)
make sure allowed to see them, and find the members |
static Member |
internal_findOrCreateBySubject(java.lang.String id,
java.lang.String src,
java.lang.String type)
find a member |
static Member |
internal_findReadableMemberBySubject(GrouperSession grouperSession,
edu.internet2.middleware.subject.Subject subject,
boolean exceptionIfNotExist)
find a member object and if group, make sure it is readable |
static Member |
internal_findRootMember()
|
static Member |
internal_findViewableMemberBySubject(GrouperSession s,
edu.internet2.middleware.subject.Subject subj,
boolean exceptionIfNotExist)
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public MemberFinder()
| Method Detail |
|---|
public static java.util.Set findAll(GrouperSession s)
throws GrouperException
Set members = MemberFinder.findAll(s);
s - Find all members within this session context.
Set of Member objects.
GrouperException
public static java.util.Set<Member> findAllUsed(GrouperSession grouperSession,
edu.internet2.middleware.subject.Source source)
throws GrouperException
Set members = MemberFinder.findAllUsed(s, source);
grouperSession - Find all members within this session context.source - Find all members with this source.
Set of Member objects.
GrouperException
public static java.util.Set<Member> findAll(GrouperSession s,
edu.internet2.middleware.subject.Source source)
throws GrouperException
Set members = MemberFinder.findAll(s, source);
s - Find all members within this session context.source - Find all members with this source.
Set of Member objects.
GrouperException
public static java.util.Set<Member> internal_findMembersByType(GrouperSession grouperSession,
Group group,
Field field,
java.lang.String type,
java.util.Set<edu.internet2.middleware.subject.Source> sources,
QueryOptions queryOptions,
SortStringEnum memberSortStringEnum,
SearchStringEnum memberSearchStringEnum,
java.lang.String memberSearchStringValue)
grouperSession - group - field - type - sources - queryOptions - memberSortStringEnum - memberSearchStringEnum - memberSearchStringValue -
@Deprecated
public static Member findBySubject(GrouperSession s,
edu.internet2.middleware.subject.Subject subj)
Subject to a Member. Create if not exist
// Convert a subject to a Member object, create if not exist Member m = MemberFinder.findBySubject(s, subj);
s - Find Member within this session context.subj - Subject to convert.
Member object.
public static java.util.Set<Member> findBySubjectsInGroup(GrouperSession grouperSession,
java.util.Set<edu.internet2.middleware.subject.Subject> subjects,
Group group,
Field field,
MembershipType membershipType)
grouperSession - subjects - to convert to membersgroup - that subjects must be infield - that they must be in in the group (null will default to eh members listmembershipType - that they must be in in the group or null for any
public static java.util.Set<Member> findBySubjects(java.util.Collection<edu.internet2.middleware.subject.Subject> subjects,
boolean createIfNotExists)
subjects - to convert to memberscreateIfNotExists - group - that subjects must be infield - that they must be in in the group (null will default to eh members listmembershipType - that they must be in in the group or null for any
public static Member findBySubject(GrouperSession s,
edu.internet2.middleware.subject.Subject subj,
boolean createIfNotExist)
Subject to a Member.
// Convert a subject to a Member object, create if not exist Member m = MemberFinder.findBySubject(s, subj, true);
s - Find Member within this session context.subj - Subject to convert.createIfNotExist - true if the member should be created if not there
Member object.
@Deprecated
public static Member findByUuid(GrouperSession s,
java.lang.String uuid)
throws MemberNotFoundException
// Get a member by uuid.
try {
Member m = MemberFind.findByUuid(s, uuid);
}
catch (MemberNotFoundException e) {
// Member not found
}
s - Get Member within this session context.uuid - Get Member with this UUID.
Member object.
MemberNotFoundException
public static Member findByUuid(GrouperSession s,
java.lang.String uuid,
boolean exceptionIfNotFound)
throws MemberNotFoundException
// Get a member by uuid. Member m = MemberFind.findByUuid(s, uuid, false);
s - Get Member within this session context.uuid - Get Member with this UUID.exceptionIfNotFound - true to throw exception if not found
Member object.
MemberNotFoundException
public static Member internal_findAllMember()
throws GrouperException
GrouperException
public static Member internal_findRootMember()
throws GrouperException
GrouperException
public static Member internal_findBySubject(edu.internet2.middleware.subject.Subject subj,
java.lang.String uuidIfCreate,
boolean createIfNotExist)
subj - uuidIfCreate - uuid to use if creatingcreateIfNotExist -
public static Member internal_findOrCreateBySubject(java.lang.String id,
java.lang.String src,
java.lang.String type)
id - src - type -
public static Member internal_createMember(edu.internet2.middleware.subject.Subject subj,
java.lang.String memberUuidIfCreate)
subj - memberUuidIfCreate -
public static Member internal_findViewableMemberBySubject(GrouperSession s,
edu.internet2.middleware.subject.Subject subj,
boolean exceptionIfNotExist)
throws InsufficientPrivilegeException,
MemberNotFoundException
s - subj - exceptionIfNotExist -
InsufficientPrivilegeException
MemberNotFoundException
public static Member internal_findReadableMemberBySubject(GrouperSession grouperSession,
edu.internet2.middleware.subject.Subject subject,
boolean exceptionIfNotExist)
throws MemberNotFoundException,
InsufficientPrivilegeException
grouperSession - subject - exceptionIfNotExist -
MemberNotFoundException
InsufficientPrivilegeExceptionpublic static void clearInternalMembers()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||