edu.internet2.middleware.grouper.internal.dao.hib3

Class Hib3MemberDAO

java.lang.Object

edu.internet2.middleware.grouper.internal.dao.hib3.Hib3DAO

edu.internet2.middleware.grouper.internal.dao.hib3.Hib3MemberDAO

All Implemented Interfaces:

GrouperDAO, MemberDAO

public class Hib3MemberDAO
extends Hib3DAO
implements MemberDAO

Basic Hibernate Member DAO interface.

Since:

@HEAD@

Version:

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	MEMBER_SUBJECT_BATCH_SIZE number of subjects to put in member query

Constructor Summary

Constructors

Constructor and Description
Hib3MemberDAO()

Method Summary

Modifier and Type	Method and 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) Deprecated.
Set	findAll()
Set<Member>	findAll(Source source)
Set<String>	findAllMemberIdsForUnresolvableCheck() returns all member ids of non-internal sources.
Set<Member>	findAllUsed(Source source) find all members that are used somewhere (e.g.
Set<Member>	findByIds(Collection<String> idsOrig, QueryOptions queryOptions) find by ids secure
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	findBySubject(Subject subj) Deprecated. use overload
Member	findBySubject(Subject subj, boolean exceptionIfNull)
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> subjectsOrig, 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. use overload
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)
static void	massageMemberSortFields(QuerySort querySort) if there are sort fields, go through them, and replace name with nameDb, etc, extension for extensionDb, displayName with displayNameDb, and displayExtension with displayExtensionDb
static void	massageMemberSortFields(QuerySort querySort, String alias) if there are sort fields, go through them, and replace name with m.subjectIdDb, etc, sort_string0 for m.sortString0, etc
static void	membersCacheClear() remove all caches
static void	membersCacheRemove(Member member) remove this from all caches
protected static void	reset(HibernateSession hibernateSession)
void	saveUpdateProperties(Member member) save the udpate properties which are auto saved when business method is called
void	update(Member _m)
void	uuid2dtoCacheRemove(String uuid) Deprecated.

Methods inherited from class edu.internet2.middleware.grouper.internal.dao.hib3.Hib3DAO

evict, evictEntity, evictQueries, getConfiguration, getConfiguration, getSessionFactory, getSessionFactory, hibernateInitted, initHibernateIfNotInitted, initHibernateIfNotInitted, resourceNameFromClassName, session, session

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MEMBER_SUBJECT_BATCH_SIZE

public static int MEMBER_SUBJECT_BATCH_SIZE

number of subjects to put in member query

Constructor Detail

Hib3MemberDAO

public Hib3MemberDAO()

Method Detail

create

public void create(Member _m)
            throws GrouperDAOException

Specified by:

create in interface MemberDAO

Throws:

GrouperDAOException

Since:

@HEAD@

exists

public boolean exists(String uuid)
               throws GrouperDAOException

Specified by:

exists in interface MemberDAO

Throws:

GrouperDAOException

Since:

@HEAD@

findAll

public Set findAll()
            throws GrouperDAOException

Specified by:

findAll in interface MemberDAO

Throws:

GrouperDAOException

Since:

@HEAD@

findAll

public Set<Member> findAll(Source source)
                    throws GrouperDAOException

Specified by:

findAll in interface MemberDAO

Throws:

GrouperDAOException

Since:

@HEAD@

findBySubject

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

Deprecated. use overload

Specified by:

findBySubject in interface MemberDAO

Throws:

GrouperDAOException

MemberNotFoundException

findBySubject

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

Specified by:

findBySubject in interface MemberDAO

Throws:

GrouperDAOException

MemberNotFoundException

findBySubject

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

Deprecated. use overload

Specified by:

findBySubject in interface MemberDAO

Throws:

GrouperDAOException

MemberNotFoundException

findBySubject

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

Specified by:

findBySubject in interface MemberDAO

Throws:

GrouperDAOException

MemberNotFoundException

See Also:

MemberDAO.findBySubject(java.lang.String, java.lang.String, java.lang.String, boolean)

massageMemberSortFields

public static void massageMemberSortFields(QuerySort querySort)

if there are sort fields, go through them, and replace name with nameDb, etc, extension for extensionDb, displayName with displayNameDb, and displayExtension with displayExtensionDb

Parameters:

querySort -

massageMemberSortFields

public static void massageMemberSortFields(QuerySort querySort,
                                           String alias)

if there are sort fields, go through them, and replace name with m.subjectIdDb, etc, sort_string0 for m.sortString0, etc

Parameters:

querySort -

findBySubject

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

Description copied from interface: MemberDAO

find member by subject

Specified by:

findBySubject in interface MemberDAO

Parameters:

id -

src -

type -

exceptionIfNull -

queryOptions -

Returns:

member

Throws:

GrouperDAOException

MemberNotFoundException

findByUuid

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

Deprecated. use overload

Specified by:

findByUuid in interface MemberDAO

Throws:

GrouperDAOException

MemberNotFoundException

findByUuid

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

Specified by:

findByUuid in interface MemberDAO

Throws:

GrouperDAOException

MemberNotFoundException

See Also:

MemberDAO.findByUuid(java.lang.String, boolean, edu.internet2.middleware.grouper.internal.dao.QueryOptions)

findByUuid

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

Specified by:

findByUuid in interface MemberDAO

Throws:

GrouperDAOException

MemberNotFoundException

existsCachePut

@Deprecated
public void existsCachePut(String uuid,
                                       boolean exists)

Deprecated.

update the exists cache

Specified by:

existsCachePut in interface MemberDAO

Parameters:

uuid -

exists -

membersCacheClear

public static void membersCacheClear()

remove all caches

membersCacheRemove

public static void membersCacheRemove(Member member)

remove this from all caches

Parameters:

member -

uuid2dtoCacheRemove

@Deprecated
public void uuid2dtoCacheRemove(String uuid)

Deprecated.

remove from cache

Specified by:

uuid2dtoCacheRemove in interface MemberDAO

Parameters:

uuid -

update

public void update(Member _m)
            throws GrouperDAOException

Specified by:

update in interface MemberDAO

Throws:

GrouperDAOException

Since:

@HEAD@

reset

protected static void reset(HibernateSession hibernateSession)
                     throws org.hibernate.HibernateException

Throws:

org.hibernate.HibernateException

findBySubject

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

Deprecated. use overload

Description copied from interface: MemberDAO

find by subject id only (cant be duplicates)

Specified by:

findBySubject in interface MemberDAO

Returns:

the member

Throws:

GrouperDAOException

MemberNotFoundException

MemberNotUniqueException

See Also:

MemberDAO.findBySubject(java.lang.String)

findBySubject

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

Description copied from interface: MemberDAO

find by subject id only (cant be duplicates)

Specified by:

findBySubject in interface MemberDAO

Returns:

the member

Throws:

GrouperDAOException

MemberNotFoundException

MemberNotUniqueException

findBySubject

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

Deprecated. use overload

Description copied from interface: MemberDAO

find by subject id and source id

Specified by:

findBySubject in interface MemberDAO

Returns:

the member

Throws:

GrouperDAOException

MemberNotFoundException

See Also:

MemberDAO.findBySubject(java.lang.String, java.lang.String)

findBySubject

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

Description copied from interface: MemberDAO

find by subject id and source id

Specified by:

findBySubject in interface MemberDAO

Returns:

the member

Throws:

GrouperDAOException

MemberNotFoundException

_internal_membersIntersection

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

Description copied from interface: MemberDAO

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

Specified by:

_internal_membersIntersection in interface MemberDAO

Returns:

the set of member uuids (non null)

See Also:

MemberDAO._internal_membersIntersection(java.lang.String, java.lang.String)

_internal_membersUnion

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

Description copied from interface: MemberDAO

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

Specified by:

_internal_membersUnion in interface MemberDAO

Returns:

the set of member uuids (non null)

See Also:

MemberDAO._internal_membersUnion(java.lang.String, java.lang.String)

_internal_membersComplement

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

Description copied from interface: MemberDAO

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

Specified by:

_internal_membersComplement in interface MemberDAO

Returns:

the set of member uuids (non null)

See Also:

MemberDAO._internal_membersComplement(java.lang.String, java.lang.String)

findBySubjectIds

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

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

Specified by:

findBySubjectIds in interface MemberDAO

Parameters:

subjectIds -

subjectSourceId -

Returns:

findBySubjects

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

find members by subjects and create if not exist possibly

Specified by:

findBySubjects in interface MemberDAO

Parameters:

subjectsOrig -

createIfNotExists -

Returns:

the members

findBySubjectsInGroup

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

convert a set of subjects to a set of members

Specified by:

findBySubjectsInGroup in interface MemberDAO

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

See Also:

MemberDAO.findBySubjectsInGroup(GrouperSession, Set, Group, Field, MembershipType)

findByUuidOrSubject

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

Description copied from interface: MemberDAO

find a member by uuid or subject id

Specified by:

findByUuidOrSubject in interface MemberDAO

Returns:

the member

See Also:

MemberDAO.findByUuidOrSubject(java.lang.String, java.lang.String, java.lang.String, boolean)

saveUpdateProperties

public void saveUpdateProperties(Member member)

Description copied from interface: MemberDAO

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

Specified by:

saveUpdateProperties in interface MemberDAO

See Also:

MemberDAO.saveUpdateProperties(edu.internet2.middleware.grouper.Member)

findAllUsed

public Set<Member> findAllUsed(Source source)
                        throws GrouperDAOException

Description copied from interface: MemberDAO

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

Specified by:

findAllUsed in interface MemberDAO

Returns:

the members

Throws:

GrouperDAOException

See Also:

MemberDAO.findAllUsed(edu.internet2.middleware.subject.Source)

findAllMemberIdsForUnresolvableCheck

public Set<String> findAllMemberIdsForUnresolvableCheck()
                                                 throws GrouperDAOException

Description copied from interface: MemberDAO

returns all member ids of non-internal sources. plus member ids for groups that are deleted but have attributes/memberships.

Specified by:

findAllMemberIdsForUnresolvableCheck in interface MemberDAO

Returns:

set of member ids

Throws:

GrouperDAOException

findByIds

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

Description copied from interface: MemberDAO

find by ids secure

Specified by:

findByIds in interface MemberDAO

Returns:

the members empty set or exception

See Also:

MemberDAO.findByIds(Collection, QueryOptions)

getAllMembersSecure

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

Description copied from interface: MemberDAO

get all members secure

Specified by:

getAllMembersSecure in interface MemberDAO

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

See Also:

MemberDAO.getAllMembersSecure(GrouperSession, QueryOptions, String, Object, Set, Boolean, String, Object, Set)

getUnresolvableMembers

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

Specified by:

getUnresolvableMembers in interface MemberDAO

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

Returns:

unresolvable members