|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.internet2.middleware.grouper.MembershipFinder
public class MembershipFinder
Find memberships within the Groups Registry. A membership is the object which represents a join of member and group. Has metadata like type and creator, and, if an effective membership, the parent membership
Constructor Summary | |
---|---|
MembershipFinder()
|
Method Summary | |
---|---|
static Membership |
findByUuid(GrouperSession grouperSession,
java.lang.String uuid,
boolean exceptionIfNotFound,
boolean enabledOnly)
Find a membership within the registry by UUID. |
static Membership |
findCompositeMembership(GrouperSession s,
Group g,
edu.internet2.middleware.subject.Subject subj)
Deprecated. see overload |
static Membership |
findCompositeMembership(GrouperSession s,
Group g,
edu.internet2.middleware.subject.Subject subj,
boolean exceptionOnNull)
Return the composite membership if it exists. |
static java.util.Set<Membership> |
findEffectiveMemberships(GrouperSession s,
Group g,
edu.internet2.middleware.subject.Subject subj,
Field f,
Group via,
int depth)
Return effective memberships. |
static Membership |
findImmediateMembership(GrouperSession s,
Group g,
edu.internet2.middleware.subject.Subject subj,
Field f)
Deprecated. see overload |
static Membership |
findImmediateMembership(GrouperSession s,
Group g,
edu.internet2.middleware.subject.Subject subj,
Field f,
boolean exceptionIfNotFound)
Return the immediate membership if it exists. |
static java.util.Set<Member> |
findMembers(Group group,
Field field)
|
static java.util.Set<Member> |
findMembers(Group group,
Field field,
QueryOptions queryOptions)
|
static java.util.Set<Member> |
findMembers(Group group,
Field field,
java.util.Set<edu.internet2.middleware.subject.Source> sources,
QueryOptions queryOptions)
|
static java.util.Set<java.lang.Object[]> |
findMemberships(java.util.Collection<java.lang.String> groupIds,
java.util.Collection<java.lang.String> memberIds,
java.util.Collection<java.lang.String> membershipIds,
MembershipType membershipType,
Field field,
java.util.Set<edu.internet2.middleware.subject.Source> sources,
java.lang.String scope,
Stem stem,
Stem.Scope stemScope,
java.lang.Boolean enabled)
|
static java.util.Set<Membership> |
internal_findAllByCreatedAfter(GrouperSession s,
java.util.Date d,
Field f)
|
static java.util.Set<Membership> |
internal_findAllByCreatedBefore(GrouperSession s,
java.util.Date d,
Field f)
|
static java.util.Set<Membership> |
internal_findAllByGroupAndFieldAndPage(Group group,
Field field,
int start,
int pageSize,
int sortLimit,
int[] numberOfRecords)
|
static java.util.Set<Membership> |
internal_findAllByGroupOwnerAndFieldAndType(GrouperSession s,
Group groupOwner,
Field f,
java.lang.String type)
|
static java.util.Set<Membership> |
internal_findAllChildrenNoPriv(Membership dto)
|
static java.util.Set<Membership> |
internal_findAllCompositeByGroupAndPage(Group group,
int start,
int pageSize,
int sortLimit,
int[] numberOfRecords)
|
static java.util.Set<Membership> |
internal_findAllEffectiveByGroupAndFieldAndPage(Group group,
Field field,
int start,
int pageSize,
int sortLimit,
int[] numberOfRecords)
|
static java.util.Set<Membership> |
internal_findAllEffectiveByMemberAndField(GrouperSession s,
Member m,
Field f)
|
static java.util.Set<Membership> |
internal_findAllImmediateByGroupAndFieldAndPage(Group group,
Field field,
int start,
int pageSize,
int sortLimit,
int[] numberOfRecords)
|
static java.util.Set<Membership> |
internal_findAllImmediateByMemberAndField(GrouperSession s,
Member m,
Field f)
|
static java.util.Set<Membership> |
internal_findAllNonImmediateByMemberAndField(GrouperSession s,
Member m,
Field f)
|
static java.util.Set<edu.internet2.middleware.subject.Subject> |
internal_findAttributeDefSubjects(GrouperSession s,
AttributeDef attributeDef,
Field f)
|
static java.util.Set<edu.internet2.middleware.subject.Subject> |
internal_findAttributeDefSubjectsImmediateOnly(GrouperSession s,
AttributeDef attributeDef,
Field f)
|
static java.util.Set<edu.internet2.middleware.subject.Subject> |
internal_findGroupSubjects(GrouperSession s,
Group group,
Field f)
|
static java.util.Set<edu.internet2.middleware.subject.Subject> |
internal_findGroupSubjectsImmediateOnly(GrouperSession s,
Group group,
Field f)
|
static java.util.Set<Member> |
internal_findMembersByType(GrouperSession s,
Group g,
Field f,
java.lang.String type)
|
static java.util.Set<Membership> |
internal_findMemberships(GrouperSession s,
Member m,
Field f)
|
static java.util.Set<edu.internet2.middleware.subject.Subject> |
internal_findStemSubjectsImmediateOnly(GrouperSession s,
Stem stem,
Field f)
|
static java.util.Set<edu.internet2.middleware.subject.Subject> |
internal_findSubjectsStemPriv(GrouperSession s,
Stem stem,
Field f)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MembershipFinder()
Method Detail |
---|
public static java.util.Set<java.lang.Object[]> findMemberships(java.util.Collection<java.lang.String> groupIds, java.util.Collection<java.lang.String> memberIds, java.util.Collection<java.lang.String> membershipIds, MembershipType membershipType, Field field, java.util.Set<edu.internet2.middleware.subject.Source> sources, java.lang.String scope, Stem stem, Stem.Scope stemScope, java.lang.Boolean enabled)
groupIds
- to limit memberships to (cant have more than 100 bind variables)memberIds
- to limit memberships to (cant have more than 100 bind variables)membershipIds
- to limit memberships to (cant have more than 100 bind variables)membershipType
- Immediate, NonImmediate, etcfield
- if finding one field, list here, otherwise all list fields will be returnedsources
- if limiting memberships of members in certain sources, list herescope
- sql like string which will have a % appended to itstem
- if looking in a certain stemstemScope
- if looking only in this stem, or all substemsenabled
- null for all, true for enabled only, false for disabled only
MembershipDAO.findAllByGroupOwnerOptions(java.util.Collection, java.util.Collection, java.util.Collection, edu.internet2.middleware.grouper.membership.MembershipType, edu.internet2.middleware.grouper.Field, Set, java.lang.String, edu.internet2.middleware.grouper.Stem, edu.internet2.middleware.grouper.Stem.Scope, java.lang.Boolean)
@Deprecated public static Membership findCompositeMembership(GrouperSession s, Group g, edu.internet2.middleware.subject.Subject subj) throws MembershipNotFoundException, SchemaException
s
- Get membership within this session context.g
- Composite membership has this group.subj
- Composite membership has this subject.
Membership
object
MembershipNotFoundException
SchemaException
public static Membership findCompositeMembership(GrouperSession s, Group g, edu.internet2.middleware.subject.Subject subj, boolean exceptionOnNull) throws MembershipNotFoundException, SchemaException
s
- Get membership within this session context.g
- Composite membership has this group.subj
- Composite membership has this subject.exceptionOnNull
-
Membership
object
MembershipNotFoundException
SchemaException
public static java.util.Set<Membership> findEffectiveMemberships(GrouperSession s, Group g, edu.internet2.middleware.subject.Subject subj, Field f, Group via, int depth) throws MembershipNotFoundException, SchemaException
s
- Get membership within this session context.g
- Effective membership has this group.subj
- Effective membership has this subject.f
- Effective membership has this list.via
- Effective membership has this via group.depth
- Effective membership has this depth.
Membership
objects.
MembershipNotFoundException
SchemaException
@Deprecated public static Membership findImmediateMembership(GrouperSession s, Group g, edu.internet2.middleware.subject.Subject subj, Field f) throws MembershipNotFoundException, SchemaException
s
- Get membership within this session context.g
- Immediate membership has this group.subj
- Immediate membership has this subject.f
- Immediate membership has this list.
Membership
object
MembershipNotFoundException
SchemaException
public static Membership findImmediateMembership(GrouperSession s, Group g, edu.internet2.middleware.subject.Subject subj, Field f, boolean exceptionIfNotFound) throws MembershipNotFoundException, SchemaException
s
- Get membership within this session context.g
- Immediate membership has this group.subj
- Immediate membership has this subject.f
- Immediate membership has this list.exceptionIfNotFound
-
Membership
object
MembershipNotFoundException
SchemaException
public static java.util.Set<Membership> internal_findAllChildrenNoPriv(Membership dto)
dto
-
public static java.util.Set<Member> findMembers(Group group, Field field) throws java.lang.IllegalArgumentException
group
- field
-
Member
's in group's list field.
java.lang.IllegalArgumentException
- if any parameter is null.public static java.util.Set<Member> findMembers(Group group, Field field, QueryOptions queryOptions) throws java.lang.IllegalArgumentException
group
- field
- queryOptions
-
Member
's in group's list field.
java.lang.IllegalArgumentException
- if any parameter is null.public static java.util.Set<Member> findMembers(Group group, Field field, java.util.Set<edu.internet2.middleware.subject.Source> sources, QueryOptions queryOptions) throws java.lang.IllegalArgumentException
group
- field
- sources
- set of sources to retrieve from or null for allqueryOptions
-
Member
's in group's list field.
java.lang.IllegalArgumentException
- if any parameter is null.public static java.util.Set<edu.internet2.middleware.subject.Subject> internal_findGroupSubjects(GrouperSession s, Group group, Field f) throws GrouperException
s
- group
- f
-
GrouperException
public static java.util.Set<edu.internet2.middleware.subject.Subject> internal_findAttributeDefSubjectsImmediateOnly(GrouperSession s, AttributeDef attributeDef, Field f) throws GrouperException
s
- attributeDef
- f
-
GrouperException
public static java.util.Set<edu.internet2.middleware.subject.Subject> internal_findStemSubjectsImmediateOnly(GrouperSession s, Stem stem, Field f) throws GrouperException
s
- stem
- f
-
GrouperException
public static java.util.Set<edu.internet2.middleware.subject.Subject> internal_findSubjectsStemPriv(GrouperSession s, Stem stem, Field f)
s
- stem
- f
-
public static java.util.Set<Member> internal_findMembersByType(GrouperSession s, Group g, Field f, java.lang.String type)
s
- g
- f
- type
-
public static java.util.Set<Membership> internal_findAllByCreatedAfter(GrouperSession s, java.util.Date d, Field f) throws QueryException
s
- d
- f
-
QueryException
public static java.util.Set<Membership> internal_findAllByCreatedBefore(GrouperSession s, java.util.Date d, Field f) throws QueryException
s
- d
- f
-
QueryException
public static java.util.Set<Membership> internal_findAllByGroupOwnerAndFieldAndType(GrouperSession s, Group groupOwner, Field f, java.lang.String type)
s
- groupOwner
- f
- type
-
public static java.util.Set<Membership> internal_findAllEffectiveByMemberAndField(GrouperSession s, Member m, Field f)
s
- m
- f
-
public static java.util.Set<Membership> internal_findAllImmediateByMemberAndField(GrouperSession s, Member m, Field f)
s
- m
- f
-
public static java.util.Set<Membership> internal_findAllNonImmediateByMemberAndField(GrouperSession s, Member m, Field f)
s
- m
- f
-
public static java.util.Set<Membership> internal_findMemberships(GrouperSession s, Member m, Field f)
s
- m
- f
-
public static java.util.Set<Membership> internal_findAllImmediateByGroupAndFieldAndPage(Group group, Field field, int start, int pageSize, int sortLimit, int[] numberOfRecords) throws SchemaException
start
- pageSize
- group
- field
- sortLimit
- numberOfRecords
- (pass in array of size one to get the result size back)
SchemaException
public static java.util.Set<Membership> internal_findAllCompositeByGroupAndPage(Group group, int start, int pageSize, int sortLimit, int[] numberOfRecords) throws SchemaException
start
- pageSize
- group
- sortLimit
- numberOfRecords
- (pass in array of size one to get the result size back)
SchemaException
public static java.util.Set<Membership> internal_findAllEffectiveByGroupAndFieldAndPage(Group group, Field field, int start, int pageSize, int sortLimit, int[] numberOfRecords) throws SchemaException
start
- pageSize
- group
- field
- sortLimit
- numberOfRecords
- (pass in array of size one to get the result size back)
SchemaException
public static java.util.Set<Membership> internal_findAllByGroupAndFieldAndPage(Group group, Field field, int start, int pageSize, int sortLimit, int[] numberOfRecords) throws SchemaException
start
- pageSize
- group
- field
- sortLimit
- numberOfRecords
- (pass in array of size one to get the result size back)
SchemaException
public static java.util.Set<edu.internet2.middleware.subject.Subject> internal_findAttributeDefSubjects(GrouperSession s, AttributeDef attributeDef, Field f) throws GrouperException
s
- attributeDef
- f
-
GrouperException
public static java.util.Set<edu.internet2.middleware.subject.Subject> internal_findGroupSubjectsImmediateOnly(GrouperSession s, Group group, Field f) throws GrouperException
s
- group
- f
-
GrouperException
public static Membership findByUuid(GrouperSession grouperSession, java.lang.String uuid, boolean exceptionIfNotFound, boolean enabledOnly) throws MembershipNotFoundException
Membership membership = MembershipFinder.findByUuid(grouperSession, uuid);
grouperSession
- Find membership within this session context.uuid
- UUID of membership to find.exceptionIfNotFound
- true if exception if not foundenabledOnly
- true for enabled only
Membership
MembershipNotFoundException
- if not found an exceptionIfNotFound is true
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |