Package edu.internet2.middleware.grouper.internal.dao

Interface MemberDAO

All Superinterfaces:

GrouperDAO

All Known Implementing Classes:

Hib3MemberDAO

public interface MemberDAO
extends GrouperDAO

Basic Member DAO interface.

Since:

1.2.0

Version:

$Id: MemberDAO.java,v 1.11 2009-12-28 06:08:37 mchyzer Exp $

Method Summary

Modifier and Type	Method	Description
Set<String>	_internal_membersComplement(String groupUuid1, String groupUuid2)	find the set of member uuids of the complement of two groups
Set<String>	_internal_membersIntersection(String groupUuid1, String groupUuid2)	find the set of member uuids of the intersection of two groups
Set<String>	_internal_membersUnion(String groupUuid1, String groupUuid2)	find the set of member uuids of the union of two groups
void	create(Member _m)
boolean	exists(String uuid)
void	existsCachePut(String uuid, boolean exists)	update the exists cache
Set<Member>	findAll()
Set<Member>	findAll(Source source)
Set<String>	findAllDeletedGroupMemberIdsIncorrectSubjectResolutionAttributes()	Returns member ids for deleted groups and local entities that are deleted but still marked as resolvable or not deleted.
Set<String>	findAllMemberIdsForUnresolvableCheck()	Returns member ids that are checked by USDU
Set<String>	findAllMemberIdsNoLongerSubjectResolutionEligible()	Returns member ids that need to have subject resolution eligible updated to F
Set<Member>	findAllUsed(Source source)	find all members that are used somewhere (e.g.
Member	findByIdIndex(Long idIndex, boolean exceptionIfNotFound)
Set<Member>	findByIds(Collection<String> ids, QueryOptions queryOptions)	find by ids secure
Member	findBySubject(Subject subj)	Deprecated. use overload
Member	findBySubject(Subject subj, boolean exceptionIfNull)
Member	findBySubject(String subjectId)	Deprecated. use overload
Member	findBySubject(String subjectId, boolean exceptionIfNull)	find by subject id only (cant be duplicates)
Member	findBySubject(String subjectId, String src)	Deprecated. use overload
Member	findBySubject(String subjectId, String src, boolean exceptionIfNull)	find by subject id and source id
Member	findBySubject(String id, String src, String type)	Deprecated. use overload
Member	findBySubject(String id, String src, String type, boolean exceptionIfNull)
Member	findBySubject(String id, String src, String type, boolean exceptionIfNull, QueryOptions queryOptions)	find member by subject
Member	findBySubjectIdentifier(String subjectIdentifier, String src, boolean exceptionIfNull)	find by subject identifier and source id
Set<Member>	findBySubjectIds(Collection<String> subjectIds, String subjectSourceId)	Retrieve Member objects based on a list of SubjectIds within a single SubjectSource
Set<Member>	findBySubjects(Collection<Subject> subjects, boolean createIfNotExists)	find members by subjects and create if not exist possibly
Set<Member>	findBySubjectsInGroup(GrouperSession grouperSession, Set<Subject> subjects, Group group, Field field, MembershipType membershipType)	convert a set of subjects to a set of members
Member	findByUuid(String uuid)	Deprecated.
Member	findByUuid(String uuid, boolean exceptionIfNull)
Member	findByUuid(String uuid, boolean exceptionIfNull, QueryOptions queryOptions)
Member	findByUuidOrSubject(String uuid, String subjectId, String source, boolean exceptionIfNull)	find a member by uuid or subject id
Set<Member>	getAllMembersSecure(GrouperSession grouperSession, QueryOptions queryOptions, String idOfAttributeDefName, Object attributeValue, Set<Object> attributeValuesOnAssignment, Boolean attributeCheckReadOnAttributeDef, String idOfAttributeDefName2, Object attributeValue2, Set<Object> attributeValuesOnAssignment2)	get all members secure
Set<Member>	getUnresolvableMembers(QueryOptions queryOptions, Boolean deleted)
void	saveUpdateProperties(Member member)	save the udpate properties which are auto saved when business method is called
Set<Long>	selectByDataProvider(Long dataProviderInternalId)	get all the members that are assigned in a data provider to fields or rows
void	update(Member _m)
void	uuid2dtoCacheRemove(String uuid)	remove from cache

Method Details

selectByDataProvider

Set<Long> selectByDataProvider(Long dataProviderInternalId)

get all the members that are assigned in a data provider to fields or rows

Parameters:

dataProviderInternalId -

Returns:

the members by internal id

findByIds

Set<Member> findByIds(Collection<String> ids,
 QueryOptions queryOptions)

find by ids secure

Parameters:

ids -

queryOptions -

Returns:

the members empty set or exception

create

void create(Member _m)
     throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

exists

boolean exists(String uuid)
        throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

findAll

Set<Member> findAll()
             throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.3.0

findAll

Set<Member> findAll(Source source)
             throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.3.0

findAllUsed

Set<Member> findAllUsed(Source source)
                 throws GrouperDAOException

find all members that are used somewhere (e.g. memberships or attributes)

Parameters:

source -

Returns:

the members

Throws:

GrouperDAOException

Since:

1.6.1

findBySubject

@Deprecated
Member findBySubject(Subject subj)
              throws GrouperDAOException,
MemberNotFoundException

Deprecated.

use overload

Throws:

GrouperDAOException

MemberNotFoundException

Since:

1.2.0

findBySubject

Member findBySubject(Subject subj,
 boolean exceptionIfNull)
              throws GrouperDAOException,
MemberNotFoundException

Throws:

GrouperDAOException

MemberNotFoundException

Since:

1.2.0

findBySubject

@Deprecated
Member findBySubject(String id,
 String src,
 String type)
              throws GrouperDAOException,
MemberNotFoundException

Deprecated.

use overload

Throws:

GrouperDAOException

MemberNotFoundException

Since:

1.2.0

findBySubject

Member findBySubject(String id,
 String src,
 String type,
 boolean exceptionIfNull)
              throws GrouperDAOException,
MemberNotFoundException

Throws:

GrouperDAOException

MemberNotFoundException

Since:

1.2.0

findBySubject

Member findBySubject(String id,
 String src,
 String type,
 boolean exceptionIfNull,
 QueryOptions queryOptions)
              throws GrouperDAOException,
MemberNotFoundException

find member by subject

Parameters:

id -

src -

type -

exceptionIfNull -

queryOptions -

Returns:

the member or null

Throws:

GrouperDAOException

MemberNotFoundException

findBySubject

@Deprecated
Member findBySubject(String subjectId)
              throws GrouperDAOException,
MemberNotFoundException,
MemberNotUniqueException

Deprecated.

use overload

find by subject id only (cant be duplicates)

Parameters:

subjectId -

Returns:

the member

Throws:

GrouperDAOException

MemberNotFoundException

MemberNotUniqueException

findBySubject

Member findBySubject(String subjectId,
 boolean exceptionIfNull)
              throws GrouperDAOException,
MemberNotFoundException,
MemberNotUniqueException

find by subject id only (cant be duplicates)

Parameters:

subjectId -

Returns:

the member

Throws:

GrouperDAOException

MemberNotFoundException

MemberNotUniqueException

findBySubject

Member findBySubject(String subjectId,
 String src,
 boolean exceptionIfNull)
              throws GrouperDAOException,
MemberNotFoundException

find by subject id and source id

Parameters:

subjectId -

src -

Returns:

the member

Throws:

GrouperDAOException

MemberNotFoundException

findBySubjectIdentifier

Member findBySubjectIdentifier(String subjectIdentifier,
 String src,
 boolean exceptionIfNull)
                        throws GrouperDAOException,
MemberNotFoundException

find by subject identifier and source id

Parameters:

subjectIdentifier -

src -

Returns:

the member

Throws:

GrouperDAOException

MemberNotFoundException

findBySubject

@Deprecated
Member findBySubject(String subjectId,
 String src)
              throws GrouperDAOException,
MemberNotFoundException

Deprecated.

use overload

find by subject id and source id

Parameters:

subjectId -

src -

Returns:

the member

Throws:

GrouperDAOException

MemberNotFoundException

findByUuid

@Deprecated
Member findByUuid(String uuid)
           throws GrouperDAOException,
MemberNotFoundException

Deprecated.

Throws:

GrouperDAOException

MemberNotFoundException

Since:

1.2.0

findByUuid

Member findByUuid(String uuid,
 boolean exceptionIfNull)
           throws GrouperDAOException,
MemberNotFoundException

Throws:

GrouperDAOException

MemberNotFoundException

Since:

1.2.0

findByUuid

Member findByUuid(String uuid,
 boolean exceptionIfNull,
 QueryOptions queryOptions)
           throws GrouperDAOException,
MemberNotFoundException

Throws:

GrouperDAOException

MemberNotFoundException

Since:

1.2.0

update

void update(Member _m)
     throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

existsCachePut

void existsCachePut(String uuid,
 boolean exists)

update the exists cache

Parameters:

uuid -

exists -

uuid2dtoCacheRemove

void uuid2dtoCacheRemove(String uuid)

remove from cache

Parameters:

uuid -

_internal_membersIntersection

Set<String> _internal_membersIntersection(String groupUuid1,
 String groupUuid2)

find the set of member uuids of the intersection of two groups

Parameters:

groupUuid1 -

groupUuid2 -

Returns:

the set of member uuids (non null)

_internal_membersUnion

Set<String> _internal_membersUnion(String groupUuid1,
 String groupUuid2)

find the set of member uuids of the union of two groups

Parameters:

groupUuid1 -

groupUuid2 -

Returns:

the set of member uuids (non null)

_internal_membersComplement

Set<String> _internal_membersComplement(String groupUuid1,
 String groupUuid2)

find the set of member uuids of the complement of two groups

Parameters:

groupUuid1 -

groupUuid2 -

Returns:

the set of member uuids (non null)

findBySubjectsInGroup

Set<Member> findBySubjectsInGroup(GrouperSession grouperSession,
 Set<Subject> subjects,
 Group group,
 Field field,
 MembershipType membershipType)

convert a set of subjects to a set of members

Parameters:

grouperSession -

subjects - to convert to members

group - that subjects must be in

field - that they must be in in the group (null will default to eh members list

membershipType - that they must be in in the group or null for any

Returns:

the members in the group

findBySubjects

Set<Member> findBySubjects(Collection<Subject> subjects,
 boolean createIfNotExists)

find members by subjects and create if not exist possibly

Parameters:

subjects -

createIfNotExists -

Returns:

the members

findBySubjectIds

Set<Member> findBySubjectIds(Collection<String> subjectIds,
 String subjectSourceId)

Retrieve Member objects based on a list of SubjectIds within a single SubjectSource

Parameters:

subjectIds -

subjectSourceId -

Returns:

findByUuidOrSubject

Member findByUuidOrSubject(String uuid,
 String subjectId,
 String source,
 boolean exceptionIfNull)

find a member by uuid or subject id

Parameters:

uuid -

subjectId -

source -

exceptionIfNull -

Returns:

the member

saveUpdateProperties

void saveUpdateProperties(Member member)

save the udpate properties which are auto saved when business method is called

Parameters:

member -

getAllMembersSecure

Set<Member> getAllMembersSecure(GrouperSession grouperSession,
 QueryOptions queryOptions,
 String idOfAttributeDefName,
 Object attributeValue,
 Set<Object> attributeValuesOnAssignment,
 Boolean attributeCheckReadOnAttributeDef,
 String idOfAttributeDefName2,
 Object attributeValue2,
 Set<Object> attributeValuesOnAssignment2)

get all members secure

Parameters:

grouperSession -

subject -

privileges -

queryOptions -

idOfAttributeDefName - if looking for members that have this attribute def name

attributeValue - if looking for members that have this attribute value on the attribute def name

attributeValuesOnAssignment - if looking for an attribute value on an assignment, could be multiple values

attributeCheckReadOnAttributeDef - use security around attribute def? default is true

idOfAttributeDefName2 - if looking for members that have this attribute def name2

attributeValue2 - if looking for members that have this attribute value2 on the attribute def name2

attributeValuesOnAssignment2 - if looking for an attribute value on an assignment2, could be multiple values

Returns:

set of member

Since:

v2.4.0.patch

getUnresolvableMembers

Set<Member> getUnresolvableMembers(QueryOptions queryOptions,
 Boolean deleted)

Parameters:

queryOptions -

deleted - true - return unresolvable members that are deleted false - return unresolvable members that are not deleted null - return all unresolvable members

Returns:

unresolvable members

findAllMemberIdsForUnresolvableCheck

Set<String> findAllMemberIdsForUnresolvableCheck()

Returns member ids that are checked by USDU

Returns:

set of member ids

findAllMemberIdsNoLongerSubjectResolutionEligible

Set<String> findAllMemberIdsNoLongerSubjectResolutionEligible()

Returns member ids that need to have subject resolution eligible updated to F

Returns:

set of member ids

findAllDeletedGroupMemberIdsIncorrectSubjectResolutionAttributes

Set<String> findAllDeletedGroupMemberIdsIncorrectSubjectResolutionAttributes()

Returns member ids for deleted groups and local entities that are deleted but still marked as resolvable or not deleted.

Returns:

set of member ids

findByIdIndex

Member findByIdIndex(Long idIndex,
 boolean exceptionIfNotFound)
              throws MemberNotFoundException

Returns:

member

Throws:

MemberNotFoundException