edu.internet2.middleware.grouper.internal.dao
Interface GroupDAO

All Superinterfaces:

GrouperDAO

All Known Implementing Classes:

Hib3GroupDAO

public interface GroupDAO
extends GrouperDAO

Basic Group DAO interface.

Since:

1.2.0

Version:

$Id: GroupDAO.java,v 1.30 2009-12-10 08:54:15 mchyzer Exp $

Author:

blair christensen.

Method Summary

void	delete(Group _g)
boolean	exists(java.lang.String uuid)
java.util.Set<Group>	findAllByAnyApproximateAttr(java.lang.String val)
java.util.Set<Group>	findAllByAnyApproximateAttr(java.lang.String val, java.lang.String scope)
java.util.Set<Group>	findAllByAnyApproximateAttr(java.lang.String val, java.lang.String scope, boolean secureQuery)
java.util.Set<Group>	findAllByApproximateAlternateName(java.lang.String name) Find groups using an approximate string for the alternate name.
java.util.Set<Group>	findAllByApproximateAlternateName(java.lang.String name, java.lang.String scope) Find groups using an approximate string for the alternate name.
java.util.Set<Group>	findAllByApproximateAttr(java.lang.String attr, java.lang.String val)
java.util.Set<Group>	findAllByApproximateAttr(java.lang.String attr, java.lang.String val, java.lang.String scope)
java.util.Set<Group>	findAllByApproximateAttrSecure(java.lang.String attr, java.lang.String val, java.lang.String scope)
java.util.Set<Group>	findAllByApproximateCurrentName(java.lang.String name) Find groups using an approximate string for the current name, display name, extension, display extension.
java.util.Set<Group>	findAllByApproximateCurrentName(java.lang.String name, java.lang.String scope) Find groups using an approximate string for the current name, display name, extension, display extension.
java.util.Set<Group>	findAllByApproximateName(java.lang.String name)
java.util.Set<Group>	findAllByApproximateName(java.lang.String name, java.lang.String scope)
java.util.Set<Group>	findAllByApproximateNameSecure(java.lang.String name, java.lang.String scope, QueryOptions queryOptions)
java.util.Set<Group>	findAllByApproximateNameSecure(java.lang.String name, java.lang.String scope, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups)
java.util.Set<Group>	findAllByAttr(java.lang.String attr, java.lang.String val)
java.util.Set<Group>	findAllByAttr(java.lang.String attr, java.lang.String val, java.lang.String scope)
java.util.Set<Group>	findAllByAttr(java.lang.String attr, java.lang.String val, java.lang.String scope, boolean secureQuery)
java.util.Set<Group>	findAllByCreatedAfter(java.util.Date d)
java.util.Set<Group>	findAllByCreatedAfter(java.util.Date d, java.lang.String scope)
java.util.Set<Group>	findAllByCreatedBefore(java.util.Date d)
java.util.Set<Group>	findAllByCreatedBefore(java.util.Date d, java.lang.String scope)
java.util.Set<Group>	findAllByLastMembershipAfter(java.util.Date d)
java.util.Set<Group>	findAllByLastMembershipAfter(java.util.Date d, java.lang.String scope)
java.util.Set<Group>	findAllByLastMembershipBefore(java.util.Date d)
java.util.Set<Group>	findAllByLastMembershipBefore(java.util.Date d, java.lang.String scope)
java.util.Set<Group>	findAllByModifiedAfter(java.util.Date d)
java.util.Set<Group>	findAllByModifiedAfter(java.util.Date d, java.lang.String scope)
java.util.Set<Group>	findAllByModifiedBefore(java.util.Date d)
java.util.Set<Group>	findAllByModifiedBefore(java.util.Date d, java.lang.String scope)
java.util.Set<Group>	findAllByType(GroupType _gt) note, this doesnt cache
java.util.Set<Group>	findAllByType(GroupType _gt, QueryOptions queryOptions) this caches
java.util.Set<Group>	findAllByType(GroupType _gt, java.lang.String scope)
Group	findByAlternateName(java.lang.String name, boolean exceptionIfNotFound) Find a group by its alternate name only.
Group	findByAttribute(java.lang.String attr, java.lang.String val) Deprecated. use overload
Group	findByAttribute(java.lang.String attr, java.lang.String val, boolean exceptionIfNotFound)
Group	findByAttribute(java.lang.String attr, java.lang.String val, boolean exceptionIfNotFound, boolean secureQuery)
java.util.Set<Group>	findByCreatorOrModifier(Member member) find groups by creator or modifier
Group	findByCurrentName(java.lang.String name, boolean exceptionIfNotFound) Find a group by its current name only.
Group	findByIdIndex(java.lang.Long idIndex, boolean exceptionIfNotFound)
Group	findByIdIndexSecure(java.lang.Long idIndex, boolean exceptionIfNotFound, QueryOptions queryOptions) find a group by id index
Group	findByName(java.lang.String name) Deprecated. use overload
Group	findByName(java.lang.String name, boolean exceptionIfNotFound)
Group	findByName(java.lang.String name, boolean exceptionIfNotFound, QueryOptions queryOptions)
Group	findByName(java.lang.String name, boolean exceptionIfNotFound, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups)
Group	findByNameSecure(java.lang.String name, boolean exceptionIfNotFound, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups)
Group	findByNameSecure(java.lang.String name, boolean exceptionIfNotFound, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups, java.util.Set<Privilege> inPrivSet)
java.util.Set<Group>	findByNamesSecure(java.util.Collection<java.lang.String> names, QueryOptions queryOptions)
java.util.Set<Group>	findByNamesSecure(java.util.Collection<java.lang.String> names, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups)
Group	findByUuid(java.lang.String uuid) Deprecated. use overload
Group	findByUuid(java.lang.String uuid, boolean exceptionIfNotFound)
Group	findByUuid(java.lang.String uuid, boolean exceptionIfNotFound, QueryOptions queryOptions)
Group	findByUuid(java.lang.String uuid, boolean exceptionIfNotFound, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups)
Group	findByUuidOrName(java.lang.String uuid, java.lang.String name, boolean exceptionIfNull)
Group	findByUuidOrName(java.lang.String uuid, java.lang.String name, boolean exceptionIfNull, QueryOptions queryOptions)
java.util.Set<Group>	findByUuids(java.util.Collection<java.lang.String> uuids, boolean exceptionOnNotFound) find all groups which have these uuids
Group	findByUuidSecure(java.lang.String uuid, boolean exceptionIfNotFound, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups) find by uuid secure
java.util.Set<Group>	findByUuidsSecure(java.util.Collection<java.lang.String> uuids, QueryOptions queryOptions) find by uuid secure
java.util.Set<Group>	findByUuidsSecure(java.util.Collection<java.lang.String> uuids, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups) find by uuid secure
java.util.Set<Group>	findGroupsInStemWithoutPrivilege(GrouperSession grouperSession, java.lang.String stemId, Stem.Scope scope, edu.internet2.middleware.subject.Subject subject, Privilege privilege, QueryOptions queryOptions, boolean considerAllSubject, java.lang.String sqlLikeString) see which groups do not have this privilege
java.util.Set<Group>	getAllGroups()
java.util.Set<Group>	getAllGroups(java.lang.String scope)
java.util.Set<Group>	getAllGroupsMembershipSecure(Field field, java.lang.String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, QueryOptions queryOptions, java.lang.Boolean enabled, MembershipType membershipType, Stem stem, Stem.Scope stemScope)
java.util.Set<Group>	getAllGroupsMembershipSecure(GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> inPrivSet, QueryOptions queryOptions, boolean enabledOnly)
java.util.Set<Group>	getAllGroupsMembershipSecure(java.lang.String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> inPrivSet, QueryOptions queryOptions, boolean enabledOnly)
java.util.Set<Group>	getAllGroupsMembershipSecure(java.lang.String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> inPrivSet, QueryOptions queryOptions, boolean enabledOnly, Stem stem, Stem.Scope stemScope)
java.util.Set<Group>	getAllGroupsSecure(GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> inPrivSet, QueryOptions queryOptions)
java.util.Set<Group>	getAllGroupsSecure(GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> inPrivSet, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups)
java.util.Set<Group>	getAllGroupsSecure(java.lang.String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> inPrivSet, QueryOptions queryOptions)
java.util.Set<Group>	getAllGroupsSecure(java.lang.String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> inPrivSet, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups)
java.util.Set<Group>	getAllGroupsSecure(java.lang.String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> privileges, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroup, boolean splitScope, edu.internet2.middleware.subject.Subject membershipSubject, Field field) get all groups secure, split the scope by whitespace
java.util.Set<Group>	getAllGroupsSecure(java.lang.String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> privileges, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroup, boolean splitScope, edu.internet2.middleware.subject.Subject membershipSubject, Field field, java.lang.String parentStemId, Stem.Scope stemScope, boolean findByUuidOrName, edu.internet2.middleware.subject.Subject subjectNotInGroup, java.util.Collection<java.lang.String> groupIds, java.util.Collection<java.lang.String> groupNames, java.lang.Boolean compositeOwner) get all groups secure, split the scope by whitespace
java.util.Set<Group>	getAllGroupsSecure(java.lang.String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> privileges, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroup, boolean splitScope, edu.internet2.middleware.subject.Subject membershipSubject, Field field, java.lang.String parentStemId, Stem.Scope stemScope, boolean findByUuidOrName, edu.internet2.middleware.subject.Subject subjectNotInGroup, java.util.Collection<java.lang.String> groupIds, java.util.Collection<java.lang.String> groupNames, java.lang.Boolean compositeOwner, java.lang.String idOfAttributeDefName, java.lang.Object attributeValue) get all groups secure, split the scope by whitespace
java.util.Set<Group>	getAllGroupsSplitScopeSecure(java.lang.String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> privileges, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups) get all groups secure, split the scope by whitespace
java.util.Set<Group>	getAllGroupsSplitScopeSecure(java.lang.String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> privileges, QueryOptions queryOptions, TypeOfGroup typeOfGroup) get all groups secure, split the scope by whitespace
java.util.Set<Group>	getImmediateChildren(Stem stem)
java.util.Set<Group>	getImmediateChildrenMembershipSecure(GrouperSession grouperSession, Stem stem, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> inPrivSet, QueryOptions queryOptions, boolean enabledOnly) get immediate children secure
java.util.Set<Group>	getImmediateChildrenSecure(GrouperSession grouperSession, Stem stem, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> inPrivSet, QueryOptions queryOptions) get immediate children secure
java.util.Set<Group>	getImmediateChildrenSecure(GrouperSession grouperSession, Stem stem, edu.internet2.middleware.subject.Subject subject, java.util.Set<Privilege> inPrivSet, QueryOptions queryOptions, java.util.Set<TypeOfGroup> typeOfGroups) get immediate children secure
void	putInExistsCache(java.lang.String uuid, boolean exists) put in cache
void	saveUpdateProperties(Group group) save the update properties which are auto saved when business method is called
void	update(Group _g)
void	updateLastImmediateMembershipChange(java.lang.String groupId)
void	updateLastMembershipChange(java.lang.String groupId)
void	updateLastMembershipChangeIncludeAncestorGroups(java.lang.String groupId) This will update last_membership_change for group owners where group member in groupSet is the given groupId.

Method Detail

putInExistsCache

void putInExistsCache(java.lang.String uuid,
                      boolean exists)

put in cache

Parameters:

uuid -

exists -

delete

void delete(Group _g)
            throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

exists

boolean exists(java.lang.String uuid)
               throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

findAllByAnyApproximateAttr

java.util.Set<Group> findAllByAnyApproximateAttr(java.lang.String val)
                                                 throws GrouperDAOException,
                                                        java.lang.IllegalStateException

Throws:

GrouperDAOException

java.lang.IllegalStateException

Since:

1.2.0

findAllByAnyApproximateAttr

java.util.Set<Group> findAllByAnyApproximateAttr(java.lang.String val,
                                                 java.lang.String scope)
                                                 throws GrouperDAOException,
                                                        java.lang.IllegalStateException

Throws:

GrouperDAOException

java.lang.IllegalStateException

Since:

1.4.0

findAllByAnyApproximateAttr

java.util.Set<Group> findAllByAnyApproximateAttr(java.lang.String val,
                                                 java.lang.String scope,
                                                 boolean secureQuery)
                                                 throws GrouperDAOException,
                                                        java.lang.IllegalStateException

Parameters:

val -

scope -

secureQuery -

Returns:

set

Throws:

GrouperDAOException

java.lang.IllegalStateException

findAllByApproximateAttr

java.util.Set<Group> findAllByApproximateAttr(java.lang.String attr,
                                              java.lang.String val)
                                              throws GrouperDAOException,
                                                     java.lang.IllegalStateException

Throws:

GrouperDAOException

java.lang.IllegalStateException

Since:

1.2.0

findAllByApproximateAttr

java.util.Set<Group> findAllByApproximateAttr(java.lang.String attr,
                                              java.lang.String val,
                                              java.lang.String scope)
                                              throws GrouperDAOException,
                                                     java.lang.IllegalStateException

Throws:

GrouperDAOException

java.lang.IllegalStateException

Since:

1.4.0

findAllByApproximateAttrSecure

java.util.Set<Group> findAllByApproximateAttrSecure(java.lang.String attr,
                                                    java.lang.String val,
                                                    java.lang.String scope)
                                                    throws GrouperDAOException,
                                                           java.lang.IllegalStateException

Parameters:

attr - attribute name

val - value

scope - some folder or null for all

Returns:

the grops

Throws:

GrouperDAOException

java.lang.IllegalStateException

Since:

2.0.2

findAllByAttr

java.util.Set<Group> findAllByAttr(java.lang.String attr,
                                   java.lang.String val)
                                   throws GrouperDAOException,
                                          java.lang.IllegalStateException

Throws:

GrouperDAOException

java.lang.IllegalStateException

Since:

1.3

findAllByAttr

java.util.Set<Group> findAllByAttr(java.lang.String attr,
                                   java.lang.String val,
                                   java.lang.String scope)
                                   throws GrouperDAOException,
                                          java.lang.IllegalStateException

Throws:

GrouperDAOException

java.lang.IllegalStateException

Since:

1.4.0

findAllByAttr

java.util.Set<Group> findAllByAttr(java.lang.String attr,
                                   java.lang.String val,
                                   java.lang.String scope,
                                   boolean secureQuery)
                                   throws GrouperDAOException,
                                          java.lang.IllegalStateException

Parameters:

attr -

val -

scope -

secureQuery -

Returns:

set

Throws:

GrouperDAOException

java.lang.IllegalStateException

findAllByApproximateName

java.util.Set<Group> findAllByApproximateName(java.lang.String name)
                                              throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

findAllByApproximateName

java.util.Set<Group> findAllByApproximateName(java.lang.String name,
                                              java.lang.String scope)
                                              throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.4.0

findAllByApproximateNameSecure

java.util.Set<Group> findAllByApproximateNameSecure(java.lang.String name,
                                                    java.lang.String scope,
                                                    QueryOptions queryOptions)
                                                    throws GrouperDAOException

Throws:

GrouperDAOException

Since:

2.1.0

findAllByCreatedAfter

java.util.Set<Group> findAllByCreatedAfter(java.util.Date d)
                                           throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

findAllByCreatedAfter

java.util.Set<Group> findAllByCreatedAfter(java.util.Date d,
                                           java.lang.String scope)
                                           throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.4.0

findAllByCreatedBefore

java.util.Set<Group> findAllByCreatedBefore(java.util.Date d)
                                            throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

findAllByCreatedBefore

java.util.Set<Group> findAllByCreatedBefore(java.util.Date d,
                                            java.lang.String scope)
                                            throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.4.0

findAllByModifiedAfter

java.util.Set<Group> findAllByModifiedAfter(java.util.Date d)
                                            throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

findAllByModifiedAfter

java.util.Set<Group> findAllByModifiedAfter(java.util.Date d,
                                            java.lang.String scope)
                                            throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.4.0

findAllByModifiedBefore

java.util.Set<Group> findAllByModifiedBefore(java.util.Date d)
                                             throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

findAllByModifiedBefore

java.util.Set<Group> findAllByModifiedBefore(java.util.Date d,
                                             java.lang.String scope)
                                             throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.4.0

findAllByLastMembershipAfter

java.util.Set<Group> findAllByLastMembershipAfter(java.util.Date d)
                                                  throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.5.0

findAllByLastMembershipAfter

java.util.Set<Group> findAllByLastMembershipAfter(java.util.Date d,
                                                  java.lang.String scope)
                                                  throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.5.0

findAllByLastMembershipBefore

java.util.Set<Group> findAllByLastMembershipBefore(java.util.Date d)
                                                   throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.5.0

findAllByLastMembershipBefore

java.util.Set<Group> findAllByLastMembershipBefore(java.util.Date d,
                                                   java.lang.String scope)
                                                   throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.5.0

findAllByType

java.util.Set<Group> findAllByType(GroupType _gt)
                                   throws GrouperDAOException

note, this doesnt cache

Throws:

GrouperDAOException

Since:

1.2.0

findAllByType

java.util.Set<Group> findAllByType(GroupType _gt,
                                   QueryOptions queryOptions)
                                   throws GrouperDAOException

this caches

Throws:

GrouperDAOException

Since:

1.2.0

findAllByType

java.util.Set<Group> findAllByType(GroupType _gt,
                                   java.lang.String scope)
                                   throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.4.0

findByAttribute

@Deprecated
Group findByAttribute(java.lang.String attr,
                                 java.lang.String val)
                      throws GrouperDAOException,
                             GroupNotFoundException

Deprecated. use overload

Throws:

GrouperDAOException

GroupNotFoundException

Since:

1.2.0

findByAttribute

Group findByAttribute(java.lang.String attr,
                      java.lang.String val,
                      boolean exceptionIfNotFound)
                      throws GrouperDAOException,
                             GroupNotFoundException

Throws:

GrouperDAOException

GroupNotFoundException

Since:

1.2.0

findByAttribute

Group findByAttribute(java.lang.String attr,
                      java.lang.String val,
                      boolean exceptionIfNotFound,
                      boolean secureQuery)
                      throws GrouperDAOException,
                             GroupNotFoundException

Parameters:

attr -

val -

exceptionIfNotFound -

secureQuery -

Returns:

group

Throws:

GrouperDAOException

GroupNotFoundException

findByName

@Deprecated
Group findByName(java.lang.String name)
                 throws GrouperDAOException,
                        GroupNotFoundException

Deprecated. use overload

Throws:

GrouperDAOException

GroupNotFoundException

Since:

1.2.0

findByName

Group findByName(java.lang.String name,
                 boolean exceptionIfNotFound)
                 throws GrouperDAOException,
                        GroupNotFoundException

Throws:

GrouperDAOException

GroupNotFoundException

Since:

1.2.0

findByIdIndex

Group findByIdIndex(java.lang.Long idIndex,
                    boolean exceptionIfNotFound)
                    throws GroupNotFoundException

Throws:

GroupNotFoundException

Since:

2.2

findByIdIndexSecure

Group findByIdIndexSecure(java.lang.Long idIndex,
                          boolean exceptionIfNotFound,
                          QueryOptions queryOptions)
                          throws GroupNotFoundException

find a group by id index

Parameters:

idIndex - id index to find

exceptionIfNotFound - true if exception should be thrown if not found

queryOptions - query options

Returns:

the gorup or null or exception

Throws:

GroupNotFoundException

findByName

Group findByName(java.lang.String name,
                 boolean exceptionIfNotFound,
                 QueryOptions queryOptions)
                 throws GrouperDAOException,
                        GroupNotFoundException

Throws:

GrouperDAOException

GroupNotFoundException

Since:

1.2.0

findByNameSecure

Group findByNameSecure(java.lang.String name,
                       boolean exceptionIfNotFound,
                       QueryOptions queryOptions,
                       java.util.Set<TypeOfGroup> typeOfGroups)

Since:

2.0.2

findByNameSecure

Group findByNameSecure(java.lang.String name,
                       boolean exceptionIfNotFound,
                       QueryOptions queryOptions,
                       java.util.Set<TypeOfGroup> typeOfGroups,
                       java.util.Set<Privilege> inPrivSet)

Since:

2.2.1

findByName

Group findByName(java.lang.String name,
                 boolean exceptionIfNotFound,
                 QueryOptions queryOptions,
                 java.util.Set<TypeOfGroup> typeOfGroups)
                 throws GrouperDAOException,
                        GroupNotFoundException

Throws:

GrouperDAOException

GroupNotFoundException

Since:

2.1.0

findByUuid

@Deprecated
Group findByUuid(java.lang.String uuid)
                 throws GrouperDAOException,
                        GroupNotFoundException

Deprecated. use overload

Throws:

GrouperDAOException

GroupNotFoundException

Since:

1.2.0

findByUuid

Group findByUuid(java.lang.String uuid,
                 boolean exceptionIfNotFound)
                 throws GrouperDAOException,
                        GroupNotFoundException

Throws:

GrouperDAOException

GroupNotFoundException

findByUuid

Group findByUuid(java.lang.String uuid,
                 boolean exceptionIfNotFound,
                 QueryOptions queryOptions)
                 throws GrouperDAOException,
                        GroupNotFoundException

Parameters:

uuid -

exceptionIfNotFound -

queryOptions -

Returns:

the group or null or exception

Throws:

GrouperDAOException

GroupNotFoundException

findByUuidSecure

Group findByUuidSecure(java.lang.String uuid,
                       boolean exceptionIfNotFound,
                       QueryOptions queryOptions,
                       java.util.Set<TypeOfGroup> typeOfGroups)

find by uuid secure

Parameters:

uuid -

exceptionIfNotFound -

queryOptions -

typeOfGroups -

Returns:

the group or null or exception

Throws:

GrouperDAOException

GroupNotFoundException

findByUuid

Group findByUuid(java.lang.String uuid,
                 boolean exceptionIfNotFound,
                 QueryOptions queryOptions,
                 java.util.Set<TypeOfGroup> typeOfGroups)
                 throws GrouperDAOException,
                        GroupNotFoundException

Parameters:

uuid -

exceptionIfNotFound -

queryOptions -

typeOfGroups - to search in or null for all

Returns:

the group or null or exception

Throws:

GrouperDAOException

GroupNotFoundException

findByUuids

java.util.Set<Group> findByUuids(java.util.Collection<java.lang.String> uuids,
                                 boolean exceptionOnNotFound)
                                 throws GroupNotFoundException

find all groups which have these uuids

Parameters:

uuids -

exceptionOnNotFound - if exception should be thrown when a uuid doesnt match up

Returns:

the groups

Throws:

GroupNotFoundException

getAllGroups

java.util.Set<Group> getAllGroups()
                                  throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.3.1

getAllGroupsSecure

java.util.Set<Group> getAllGroupsSecure(GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        java.util.Set<Privilege> inPrivSet,
                                        QueryOptions queryOptions)
                                        throws GrouperDAOException

Parameters:

grouperSession -

subject -

queryOptions -

inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets

Returns:

groups

Throws:

GrouperDAOException

getAllGroupsSecure

java.util.Set<Group> getAllGroupsSecure(GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        java.util.Set<Privilege> inPrivSet,
                                        QueryOptions queryOptions,
                                        java.util.Set<TypeOfGroup> typeOfGroups)
                                        throws GrouperDAOException

Parameters:

grouperSession -

subject -

queryOptions -

inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets

typeOfGroups - type of groups to return, or null for all

Returns:

groups

Throws:

GrouperDAOException

getAllGroupsSecure

java.util.Set<Group> getAllGroupsSecure(java.lang.String scope,
                                        GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        java.util.Set<Privilege> inPrivSet,
                                        QueryOptions queryOptions)
                                        throws GrouperDAOException

Parameters:

scope -

grouperSession -

subject -

queryOptions -

inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets

Returns:

the groups

Throws:

GrouperDAOException

getAllGroupsSecure

java.util.Set<Group> getAllGroupsSecure(java.lang.String scope,
                                        GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        java.util.Set<Privilege> inPrivSet,
                                        QueryOptions queryOptions,
                                        java.util.Set<TypeOfGroup> typeOfGroups)
                                        throws GrouperDAOException

Parameters:

scope -

grouperSession -

subject -

queryOptions -

inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets

typeOfGroups - type of groups to return or null for all

Returns:

the groups

Throws:

GrouperDAOException

getImmediateChildrenSecure

java.util.Set<Group> getImmediateChildrenSecure(GrouperSession grouperSession,
                                                Stem stem,
                                                edu.internet2.middleware.subject.Subject subject,
                                                java.util.Set<Privilege> inPrivSet,
                                                QueryOptions queryOptions)
                                                throws GrouperDAOException

get immediate children secure

Parameters:

grouperSession -

stem -

subject -

queryOptions -

inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets

Returns:

the set of groups

Throws:

GrouperDAOException

getImmediateChildrenSecure

java.util.Set<Group> getImmediateChildrenSecure(GrouperSession grouperSession,
                                                Stem stem,
                                                edu.internet2.middleware.subject.Subject subject,
                                                java.util.Set<Privilege> inPrivSet,
                                                QueryOptions queryOptions,
                                                java.util.Set<TypeOfGroup> typeOfGroups)
                                                throws GrouperDAOException

get immediate children secure

Parameters:

grouperSession -

stem -

subject -

queryOptions -

inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets

typeOfGroups - type of groups to return, or null for all

Returns:

the set of groups

Throws:

GrouperDAOException

getImmediateChildrenMembershipSecure

java.util.Set<Group> getImmediateChildrenMembershipSecure(GrouperSession grouperSession,
                                                          Stem stem,
                                                          edu.internet2.middleware.subject.Subject subject,
                                                          java.util.Set<Privilege> inPrivSet,
                                                          QueryOptions queryOptions,
                                                          boolean enabledOnly)
                                                          throws GrouperDAOException

get immediate children secure

Parameters:

grouperSession -

stem -

subject -

queryOptions -

inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets

enabledOnly -

Returns:

the set of groups

Throws:

GrouperDAOException

getAllGroups

java.util.Set<Group> getAllGroups(java.lang.String scope)
                                  throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.4.0

getImmediateChildren

java.util.Set<Group> getImmediateChildren(Stem stem)
                                          throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.4.0

update

void update(Group _g)
            throws GrouperDAOException

Throws:

GrouperDAOException

Since:

1.2.0

findByCreatorOrModifier

java.util.Set<Group> findByCreatorOrModifier(Member member)

find groups by creator or modifier

Parameters:

member -

Returns:

the groups

findAllByApproximateNameSecure

java.util.Set<Group> findAllByApproximateNameSecure(java.lang.String name,
                                                    java.lang.String scope,
                                                    QueryOptions queryOptions,
                                                    java.util.Set<TypeOfGroup> typeOfGroups)
                                                    throws GrouperDAOException

Parameters:

name -

scope -

queryOptions -

typeOfGroups -

Returns:

the set of groups

Throws:

GrouperDAOException

Since:

2.1.0

findByAlternateName

Group findByAlternateName(java.lang.String name,
                          boolean exceptionIfNotFound)
                          throws GrouperDAOException,
                                 GroupNotFoundException

Find a group by its alternate name only.

Parameters:

name -

exceptionIfNotFound -

Returns:

group

Throws:

GrouperDAOException

GroupNotFoundException

findByCurrentName

Group findByCurrentName(java.lang.String name,
                        boolean exceptionIfNotFound)
                        throws GrouperDAOException,
                               GroupNotFoundException

Find a group by its current name only.

Parameters:

name -

exceptionIfNotFound -

Returns:

group

Throws:

GrouperDAOException

GroupNotFoundException

findAllByApproximateCurrentName

java.util.Set<Group> findAllByApproximateCurrentName(java.lang.String name)
                                                     throws GrouperDAOException

Find groups using an approximate string for the current name, display name, extension, display extension.

Parameters:

name -

Returns:

set

Throws:

GrouperDAOException

findAllByApproximateCurrentName

java.util.Set<Group> findAllByApproximateCurrentName(java.lang.String name,
                                                     java.lang.String scope)
                                                     throws GrouperDAOException

Find groups using an approximate string for the current name, display name, extension, display extension.

Parameters:

name -

scope -

Returns:

set

Throws:

GrouperDAOException

findAllByApproximateAlternateName

java.util.Set<Group> findAllByApproximateAlternateName(java.lang.String name)
                                                       throws GrouperDAOException

Find groups using an approximate string for the alternate name.

Parameters:

name -

Returns:

set

Throws:

GrouperDAOException

findAllByApproximateAlternateName

java.util.Set<Group> findAllByApproximateAlternateName(java.lang.String name,
                                                       java.lang.String scope)
                                                       throws GrouperDAOException

Find groups using an approximate string for the alternate name.

Parameters:

name -

scope -

Returns:

set

Throws:

GrouperDAOException

getAllGroupsMembershipSecure

java.util.Set<Group> getAllGroupsMembershipSecure(GrouperSession grouperSession,
                                                  edu.internet2.middleware.subject.Subject subject,
                                                  java.util.Set<Privilege> inPrivSet,
                                                  QueryOptions queryOptions,
                                                  boolean enabledOnly)
                                                  throws GrouperDAOException

Parameters:

grouperSession -

subject -

queryOptions -

inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets

enabledOnly -

Returns:

groups

Throws:

GrouperDAOException

getAllGroupsMembershipSecure

java.util.Set<Group> getAllGroupsMembershipSecure(java.lang.String scope,
                                                  GrouperSession grouperSession,
                                                  edu.internet2.middleware.subject.Subject subject,
                                                  java.util.Set<Privilege> inPrivSet,
                                                  QueryOptions queryOptions,
                                                  boolean enabledOnly)
                                                  throws GrouperDAOException

Parameters:

scope -

grouperSession -

subject -

queryOptions -

inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets

enabledOnly -

Returns:

the groups

Throws:

GrouperDAOException

getAllGroupsMembershipSecure

java.util.Set<Group> getAllGroupsMembershipSecure(java.lang.String scope,
                                                  GrouperSession grouperSession,
                                                  edu.internet2.middleware.subject.Subject subject,
                                                  java.util.Set<Privilege> inPrivSet,
                                                  QueryOptions queryOptions,
                                                  boolean enabledOnly,
                                                  Stem stem,
                                                  Stem.Scope stemScope)
                                                  throws GrouperDAOException

Parameters:

scope -

stemScope -

grouperSession -

subject -

queryOptions -

inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets

enabledOnly -

stem -

Returns:

the groups

Throws:

GrouperDAOException

getAllGroupsMembershipSecure

java.util.Set<Group> getAllGroupsMembershipSecure(Field field,
                                                  java.lang.String scope,
                                                  GrouperSession grouperSession,
                                                  edu.internet2.middleware.subject.Subject subject,
                                                  QueryOptions queryOptions,
                                                  java.lang.Boolean enabled,
                                                  MembershipType membershipType,
                                                  Stem stem,
                                                  Stem.Scope stemScope)
                                                  throws GrouperDAOException

Parameters:

field -

scope -

grouperSession -

subject -

queryOptions - if sorting on name, displayName, extension, displayExtension

enabled - null for all, True for enabledOnly, False for disabledOnly

membershipType - immediate, effective, etc

stem - if searching in a specific stem

stemScope - sub or one

Returns:

the groups

Throws:

GrouperDAOException

updateLastMembershipChange

void updateLastMembershipChange(java.lang.String groupId)

Parameters:

groupId -

updateLastImmediateMembershipChange

void updateLastImmediateMembershipChange(java.lang.String groupId)

Parameters:

groupId -

updateLastMembershipChangeIncludeAncestorGroups

void updateLastMembershipChangeIncludeAncestorGroups(java.lang.String groupId)

This will update last_membership_change for group owners where group member in groupSet is the given groupId.

Parameters:

groupId -

findByUuidOrName

Group findByUuidOrName(java.lang.String uuid,
                       java.lang.String name,
                       boolean exceptionIfNull)
                       throws GrouperDAOException,
                              GroupNotFoundException

Parameters:

uuid -

name -

exceptionIfNull -

Returns:

the stem or null

Throws:

GrouperDAOException

GroupNotFoundException

Since:

1.6.0

findByUuidOrName

Group findByUuidOrName(java.lang.String uuid,
                       java.lang.String name,
                       boolean exceptionIfNull,
                       QueryOptions queryOptions)
                       throws GrouperDAOException,
                              GroupNotFoundException

Parameters:

uuid -

name -

exceptionIfNull -

queryOptions -

Returns:

the stem or null

Throws:

GrouperDAOException

GroupNotFoundException

Since:

1.6.0

saveUpdateProperties

void saveUpdateProperties(Group group)

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

Parameters:

group -

findGroupsInStemWithoutPrivilege

java.util.Set<Group> findGroupsInStemWithoutPrivilege(GrouperSession grouperSession,
                                                      java.lang.String stemId,
                                                      Stem.Scope scope,
                                                      edu.internet2.middleware.subject.Subject subject,
                                                      Privilege privilege,
                                                      QueryOptions queryOptions,
                                                      boolean considerAllSubject,
                                                      java.lang.String sqlLikeString)

see which groups do not have this privilege

Parameters:

grouperSession -

stemId -

scope -

subject -

privilege -

queryOptions -

considerAllSubject -

sqlLikeString -

Returns:

the groups

getAllGroupsSplitScopeSecure

java.util.Set<Group> getAllGroupsSplitScopeSecure(java.lang.String scope,
                                                  GrouperSession grouperSession,
                                                  edu.internet2.middleware.subject.Subject subject,
                                                  java.util.Set<Privilege> privileges,
                                                  QueryOptions queryOptions,
                                                  TypeOfGroup typeOfGroup)

get all groups secure, split the scope by whitespace

Parameters:

scope -

grouperSession -

subject -

privileges -

queryOptions -

typeOfGroup - or null for all

Returns:

set of group

getAllGroupsSecure

java.util.Set<Group> getAllGroupsSecure(java.lang.String scope,
                                        GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        java.util.Set<Privilege> privileges,
                                        QueryOptions queryOptions,
                                        java.util.Set<TypeOfGroup> typeOfGroup,
                                        boolean splitScope,
                                        edu.internet2.middleware.subject.Subject membershipSubject,
                                        Field field)

get all groups secure, split the scope by whitespace

Parameters:

scope -

grouperSession -

subject -

privileges -

queryOptions -

typeOfGroup - or null for all

splitScope -

field -

Returns:

set of group

getAllGroupsSecure

java.util.Set<Group> getAllGroupsSecure(java.lang.String scope,
                                        GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        java.util.Set<Privilege> privileges,
                                        QueryOptions queryOptions,
                                        java.util.Set<TypeOfGroup> typeOfGroup,
                                        boolean splitScope,
                                        edu.internet2.middleware.subject.Subject membershipSubject,
                                        Field field,
                                        java.lang.String parentStemId,
                                        Stem.Scope stemScope,
                                        boolean findByUuidOrName,
                                        edu.internet2.middleware.subject.Subject subjectNotInGroup,
                                        java.util.Collection<java.lang.String> groupIds,
                                        java.util.Collection<java.lang.String> groupNames,
                                        java.lang.Boolean compositeOwner)

get all groups secure, split the scope by whitespace

Parameters:

scope -

grouperSession -

subject -

privileges -

queryOptions -

typeOfGroup - or null for all

splitScope -

membershipSubject -

field -

parentStemId -

stemScope -

findByUuidOrName -

subjectNotInGroup - is a subject which does not have a membership in the group

groupIds - are the group ids to search for

groupNames - are the group names to search for

compositeOwner - if we are filtering for groups which are or are not composite owners

Returns:

set of group

Since:

v2.2

getAllGroupsSecure

java.util.Set<Group> getAllGroupsSecure(java.lang.String scope,
                                        GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        java.util.Set<Privilege> privileges,
                                        QueryOptions queryOptions,
                                        java.util.Set<TypeOfGroup> typeOfGroup,
                                        boolean splitScope,
                                        edu.internet2.middleware.subject.Subject membershipSubject,
                                        Field field,
                                        java.lang.String parentStemId,
                                        Stem.Scope stemScope,
                                        boolean findByUuidOrName,
                                        edu.internet2.middleware.subject.Subject subjectNotInGroup,
                                        java.util.Collection<java.lang.String> groupIds,
                                        java.util.Collection<java.lang.String> groupNames,
                                        java.lang.Boolean compositeOwner,
                                        java.lang.String idOfAttributeDefName,
                                        java.lang.Object attributeValue)

get all groups secure, split the scope by whitespace

Parameters:

scope -

grouperSession -

subject -

privileges -

queryOptions -

typeOfGroup - or null for all

splitScope -

membershipSubject -

field -

parentStemId -

stemScope -

findByUuidOrName -

subjectNotInGroup - is a subject which does not have a membership in the group

groupIds - are the group ids to search for

groupNames - are the group names to search for

compositeOwner - if we are filtering for groups which are or are not composite owners

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

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

Returns:

set of group

Since:

v2.2.1

findByUuidsSecure

java.util.Set<Group> findByUuidsSecure(java.util.Collection<java.lang.String> uuids,
                                       QueryOptions queryOptions)

find by uuid secure

Parameters:

uuids -

exceptionIfNotFound -

queryOptions -

Returns:

the group or null or exception

Throws:

GrouperDAOException

GroupNotFoundException

findByUuidsSecure

java.util.Set<Group> findByUuidsSecure(java.util.Collection<java.lang.String> uuids,
                                       QueryOptions queryOptions,
                                       java.util.Set<TypeOfGroup> typeOfGroups)

find by uuid secure

Parameters:

uuids -

exceptionIfNotFound -

queryOptions -

typeOfGroups -

Returns:

the group or null or exception

Throws:

GrouperDAOException

GroupNotFoundException

findByNamesSecure

java.util.Set<Group> findByNamesSecure(java.util.Collection<java.lang.String> names,
                                       QueryOptions queryOptions)

Parameters:

names -

queryOptions -

Since:

2.0.2

findByNamesSecure

java.util.Set<Group> findByNamesSecure(java.util.Collection<java.lang.String> names,
                                       QueryOptions queryOptions,
                                       java.util.Set<TypeOfGroup> typeOfGroups)

Parameters:

names -

queryOptions -

typeOfGroups -

Since:

2.1.0

getAllGroupsSplitScopeSecure

java.util.Set<Group> getAllGroupsSplitScopeSecure(java.lang.String scope,
                                                  GrouperSession grouperSession,
                                                  edu.internet2.middleware.subject.Subject subject,
                                                  java.util.Set<Privilege> privileges,
                                                  QueryOptions queryOptions,
                                                  java.util.Set<TypeOfGroup> typeOfGroups)

get all groups secure, split the scope by whitespace

Parameters:

scope -

grouperSession -

subject -

privileges -

queryOptions -

typeOfGroups - or null for all

Returns:

set of group