Package org.dspace.eperson

Class GroupServiceImpl

java.lang.Object

org.dspace.content.DSpaceObjectServiceImpl<Group>

org.dspace.eperson.GroupServiceImpl

All Implemented Interfaces:

DSpaceObjectLegacySupportService<Group>, DSpaceObjectService<Group>, GroupService

public class GroupServiceImpl
extends DSpaceObjectServiceImpl<Group>
implements GroupService

Service implementation for the Group object. This class is responsible for all business logic calls for the Group object and is autowired by spring. This class should never be accessed directly.

Author:

kevinvandevelde at atmire.com

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorizeService	authorizeService
protected CollectionRoleService	collectionRoleService
protected CollectionService	collectionService
protected CommunityService	communityService
protected EPersonService	ePersonService
protected Group2GroupCacheDAO	group2GroupCacheDAO
protected GroupDAO	groupDAO

Fields inherited from class org.dspace.content.DSpaceObjectServiceImpl

choiceAuthorityService, handleService, metadataAuthorityService, metadataFieldService, metadataValueService, relationshipService

Fields inherited from interface org.dspace.eperson.service.GroupService

NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GroupServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addMember(Context context, Group group, EPerson e)	add an eperson member
void	addMember(Context context, Group groupParent, Group groupChild)	add group to this group
List<Group>	allMemberGroups(Context context, EPerson ePerson)	Get all of the groups that an eperson is a member of.
Set<Group>	allMemberGroupsSet(Context context, EPerson ePerson)
List<EPerson>	allMembers(Context c, Group g)	Get all of the epeople who are a member of the specified group, or a member of a sub-group of the specified group, etc.
int	countTotal(Context context)	Count the total number of groups in DSpace
Group	create(Context context)	Create a new group
void	delete(Context context, Group group)
Group	find(Context context, UUID id)	Generic find for when the precise type of an Entity is not known
List<Group>	findAll(Context context, int sortField)	Deprecated.
List<Group>	findAll(Context context, List<MetadataField> metadataSortFields)
List<Group>	findAll(Context context, List<MetadataField> metadataSortFields, int pageSize, int offset)	Finds all groups in the site
Group	findByIdOrLegacyId(Context context, String id)
Group	findByLegacyId(Context context, int id)	Generic find for when the precise type of a DSO is not known, just the a pair of type number and database ID.
List<Group>	findByMetadataField(Context context, String searchValue, MetadataField metadataField)	Look up groups based on their value for a certain metadata field (NOTE: name is not stored as metadata)
Group	findByName(Context context, String name)	Find the group by its name - assumes name is unique
protected Set<UUID>	getChildren(Map<UUID,Set<UUID>> parents, UUID parent)	Used recursively to generate a map of ALL of the children of the given parent
List<Group>	getEmptyGroups(Context context)	Get a list of groups with no members.
DSpaceObject	getParentObject(Context context, Group group)	Return the dspace object that "own" the current object in the hierarchy.
int	getSupportsTypeConstant()	Returns the Constants which this service supports
void	initDefaultGroupNames(Context context)	Initializes the group names for anonymous and administrator, and marks them "permanent".
boolean	isDirectMember(Group group, EPerson ePerson)	check to see if an eperson is a direct member.
boolean	isEmpty(Group group)	Return true if group has no direct or indirect members
protected boolean	isEPersonInGroup(Context context, Group group, EPerson ePerson)
boolean	isMember(Context context, String groupName)	fast check to see if an eperson is a member called with eperson id, does database lookup without instantiating all of the epeople objects and is thus a static method.
boolean	isMember(Context context, EPerson eperson, String groupName)	fast check to see if an eperson is a member called with eperson id, does database lookup without instantiating all of the epeople objects and is thus a static method.
boolean	isMember(Context context, EPerson ePerson, Group group)	fast check to see if an eperson is a member called with eperson id, does database lookup without instantiating all of the epeople objects and is thus a static method
boolean	isMember(Context context, Group group)	fast check to see if an eperson is a member called with eperson id, does database lookup without instantiating all of the epeople objects and is thus a static method
boolean	isMember(Group owningGroup, Group childGroup)	Check to see if childGroup is a direct group member of owningGroup.
boolean	isParentOf(Context context, Group parentGroup, Group childGroup)	Check to see if parentGroup is a direct or in-direct parent of a childGroup.
void	removeMember(Context context, Group group, EPerson ePerson)	remove an eperson from a group
void	removeMember(Context context, Group groupParent, Group childGroup)	remove group from this group
protected void	rethinkGroupCache(Context context, boolean flushQueries)	Regenerate the group cache AKA the group2groupcache table in the database - meant to be called when a group is added or removed from another group
List<Group>	search(Context context, String groupIdentifier)	Find the groups that match the search query across eperson_group_id or name
List<Group>	search(Context context, String groupIdentifier, int offset, int limit)	Find the groups that match the search query across eperson_group_id or name
int	searchResultCount(Context context, String groupIdentifier)	Returns the total number of groups returned by a specific query, without the overhead of creating the Group objects to store the results.
void	setName(Group group, String name)	set name of group
void	update(Context context, Group group)	Update the group - writing out group object and EPerson list if necessary
void	updateLastModified(Context context, Group dso)

Methods inherited from class org.dspace.content.DSpaceObjectServiceImpl

addAndShiftRightMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, getAdminObject, getAuthoritiesAndConfidences, getElements, getElementsFilled, getIdentifiers, getMDValueByField, getMDValueByLegacyField, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getMetadataValuePlace, getName, getTypeText, match, moveMetadata, removeMetadataValues, replaceMetadata, setMetadataModified, setMetadataSingleValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.content.service.DSpaceObjectService

addAndShiftRightMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, getAdminObject, getIdentifiers, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getName, getTypeText, moveMetadata, removeMetadataValues, replaceMetadata, setMetadataModified, setMetadataSingleValue

Field Detail

groupDAO

@Autowired(required=true)
protected GroupDAO groupDAO

group2GroupCacheDAO

@Autowired(required=true)
protected Group2GroupCacheDAO group2GroupCacheDAO

collectionService

@Autowired(required=true)
protected CollectionService collectionService

collectionRoleService

@Autowired(required=true)
protected CollectionRoleService collectionRoleService

ePersonService

@Autowired(required=true)
protected EPersonService ePersonService

communityService

@Autowired(required=true)
protected CommunityService communityService

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

Constructor Detail

GroupServiceImpl

protected GroupServiceImpl()

Method Detail

create

public Group create(Context context)
             throws SQLException,
                    AuthorizeException

Description copied from interface: GroupService

Create a new group

Specified by:

create in interface GroupService

Parameters:

context - DSpace context object

Returns:

group

Throws:

SQLException - if database error

AuthorizeException - if authorization error

setName

public void setName(Group group,
                    String name)
             throws SQLException

Description copied from interface: GroupService

set name of group

Specified by:

setName in interface GroupService

Parameters:

group - DSpace group

name - new group name

Throws:

SQLException - if database error

addMember

public void addMember(Context context,
                      Group group,
                      EPerson e)

Description copied from interface: GroupService

add an eperson member

Specified by:

addMember in interface GroupService

Parameters:

context - DSpace context object

group - DSpace group

e - eperson

addMember

public void addMember(Context context,
                      Group groupParent,
                      Group groupChild)
               throws SQLException

Description copied from interface: GroupService

add group to this group

Specified by:

addMember in interface GroupService

Parameters:

context - DSpace context object

groupParent - parent group

groupChild - child group

Throws:

SQLException - if database error

removeMember

public void removeMember(Context context,
                         Group group,
                         EPerson ePerson)

Description copied from interface: GroupService

remove an eperson from a group

Specified by:

removeMember in interface GroupService

Parameters:

context - DSpace context object

group - DSpace group

ePerson - eperson

removeMember

public void removeMember(Context context,
                         Group groupParent,
                         Group childGroup)
                  throws SQLException

Description copied from interface: GroupService

remove group from this group

Specified by:

removeMember in interface GroupService

Parameters:

context - DSpace context object

groupParent - parent group

childGroup - child group

Throws:

SQLException - if database error

isDirectMember

public boolean isDirectMember(Group group,
                              EPerson ePerson)

Description copied from interface: GroupService

check to see if an eperson is a direct member. If the eperson is a member via a subgroup will be returned false

Specified by:

isDirectMember in interface GroupService

Parameters:

group - DSpace group

ePerson - eperson to check membership

Returns:

true or false

isMember

public boolean isMember(Group owningGroup,
                        Group childGroup)

Description copied from interface: GroupService

Check to see if childGroup is a direct group member of owningGroup. If childGroup is a subgroup via another group will be returned false

Specified by:

isMember in interface GroupService

Parameters:

owningGroup - parent group

childGroup - child group

Returns:

true or false

isParentOf

public boolean isParentOf(Context context,
                          Group parentGroup,
                          Group childGroup)
                   throws SQLException

Description copied from interface: GroupService

Check to see if parentGroup is a direct or in-direct parent of a childGroup.

Specified by:

isParentOf in interface GroupService

parentGroup - parent group

childGroup - child group

Returns:

true or false

Throws:

SQLException

isMember

public boolean isMember(Context context,
                        Group group)
                 throws SQLException

Description copied from interface: GroupService

fast check to see if an eperson is a member called with eperson id, does database lookup without instantiating all of the epeople objects and is thus a static method

Specified by:

isMember in interface GroupService

Parameters:

context - context

group - group to check

Returns:

true or false

Throws:

SQLException - if database error

isMember

public boolean isMember(Context context,
                        EPerson ePerson,
                        Group group)
                 throws SQLException

Description copied from interface: GroupService

fast check to see if an eperson is a member called with eperson id, does database lookup without instantiating all of the epeople objects and is thus a static method

Specified by:

isMember in interface GroupService

Parameters:

context - DSpace context object.

ePerson - EPerson whos membership should be checked.

group - The group to check against.

Returns:

true or false

Throws:

SQLException - if database error

isMember

public boolean isMember(Context context,
                        String groupName)
                 throws SQLException

Description copied from interface: GroupService

fast check to see if an eperson is a member called with eperson id, does database lookup without instantiating all of the epeople objects and is thus a static method. This method uses context.getCurrentUser() as eperson whos membership should be checked.

Specified by:

isMember in interface GroupService

Parameters:

context - context

groupName - the name of the group to check

Returns:

true or false

Throws:

SQLException - if database error

isMember

public boolean isMember(Context context,
                        EPerson eperson,
                        String groupName)
                 throws SQLException

Description copied from interface: GroupService

fast check to see if an eperson is a member called with eperson id, does database lookup without instantiating all of the epeople objects and is thus a static method. The eperson whos membership should be checked must be defined as method attribute.

Specified by:

isMember in interface GroupService

Parameters:

context - context

groupName - the name of the group to check

Returns:

true or false

Throws:

SQLException - if database error

allMemberGroups

public List<Group> allMemberGroups(Context context,
                                   EPerson ePerson)
                            throws SQLException

Description copied from interface: GroupService

Get all of the groups that an eperson is a member of.

Specified by:

allMemberGroups in interface GroupService

Parameters:

context - DSpace contenxt

ePerson - ePerson object

Returns:

list of Group objects

Throws:

SQLException - if database error

allMemberGroupsSet

public Set<Group> allMemberGroupsSet(Context context,
                                     EPerson ePerson)
                              throws SQLException

Specified by:

allMemberGroupsSet in interface GroupService

Throws:

SQLException

allMembers

public List<EPerson> allMembers(Context c,
                                Group g)
                         throws SQLException

Description copied from interface: GroupService

Get all of the epeople who are a member of the specified group, or a member of a sub-group of the specified group, etc.

Specified by:

allMembers in interface GroupService

Parameters:

c - The relevant DSpace Context.

g - Group object

Returns:

List of EPerson objects

Throws:

SQLException - if error

find

public Group find(Context context,
                  UUID id)
           throws SQLException

Description copied from interface: DSpaceObjectService

Generic find for when the precise type of an Entity is not known

Specified by:

find in interface DSpaceObjectService<Group>

Parameters:

context - - the context

id - - uuid within table of type'd dspace objects

Returns:

the dspace object found, or null if it does not exist.

Throws:

SQLException - only upon failure accessing the database.

findByName

public Group findByName(Context context,
                        String name)
                 throws SQLException

Description copied from interface: GroupService

Find the group by its name - assumes name is unique

Specified by:

findByName in interface GroupService

Parameters:

context - The relevant DSpace Context.

name - Group name to search for

Returns:

the named Group, or null if not found

Throws:

SQLException - if error

findAll

@Deprecated
public List<Group> findAll(Context context,
                           int sortField)
                    throws SQLException

Deprecated.

DEPRECATED: Please use findAll(Context context, List<MetadataField> metadataSortFields) instead

Specified by:

findAll in interface GroupService

Parameters:

context - DSpace context

sortField - sort field index

Returns:

List of all groups in the site

Throws:

SQLException - if error

findAll

public List<Group> findAll(Context context,
                           List<MetadataField> metadataSortFields)
                    throws SQLException

Specified by:

findAll in interface GroupService

Parameters:

context - The relevant DSpace Context.

metadataSortFields - metadata fields to sort by, leave empty to sort by Name

Returns:

List of all groups in the site

Throws:

SQLException - if error

findAll

public List<Group> findAll(Context context,
                           List<MetadataField> metadataSortFields,
                           int pageSize,
                           int offset)
                    throws SQLException

Description copied from interface: GroupService

Finds all groups in the site

Specified by:

findAll in interface GroupService

Parameters:

context - The relevant DSpace Context.

metadataSortFields - metadata fields to sort by, leave empty to sort by Name

pageSize - how many results return

offset - the position of the first result to return

Returns:

List of all groups in the site

Throws:

SQLException - if error

search

public List<Group> search(Context context,
                          String groupIdentifier)
                   throws SQLException

Description copied from interface: GroupService

Find the groups that match the search query across eperson_group_id or name

Specified by:

search in interface GroupService

Parameters:

context - DSpace context

groupIdentifier - The group name or group ID

Returns:

array of Group objects

Throws:

SQLException - if error

search

public List<Group> search(Context context,
                          String groupIdentifier,
                          int offset,
                          int limit)
                   throws SQLException

Description copied from interface: GroupService

Find the groups that match the search query across eperson_group_id or name

Specified by:

search in interface GroupService

Parameters:

context - DSpace context

groupIdentifier - The group name or group ID

offset - Inclusive offset

limit - Maximum number of matches returned

Returns:

array of Group objects

Throws:

SQLException - if error

searchResultCount

public int searchResultCount(Context context,
                             String groupIdentifier)
                      throws SQLException

Description copied from interface: GroupService

Returns the total number of groups returned by a specific query, without the overhead of creating the Group objects to store the results.

Specified by:

searchResultCount in interface GroupService

Parameters:

context - DSpace context

groupIdentifier - The search string

Returns:

the number of groups matching the query

Throws:

SQLException - if error

delete

public void delete(Context context,
                   Group group)
            throws SQLException

Specified by:

delete in interface DSpaceObjectService<Group>

Throws:

SQLException

getSupportsTypeConstant

public int getSupportsTypeConstant()

Description copied from interface: DSpaceObjectService

Returns the Constants which this service supports

Specified by:

getSupportsTypeConstant in interface DSpaceObjectLegacySupportService<Group>

Specified by:

getSupportsTypeConstant in interface DSpaceObjectService<Group>

Returns:

a org.dspace.core.Constants that represents a IndexableObject type

isEmpty

public boolean isEmpty(Group group)

Return true if group has no direct or indirect members

Specified by:

isEmpty in interface GroupService

Parameters:

group - DSpace group

Returns:

true or false

initDefaultGroupNames

public void initDefaultGroupNames(Context context)
                           throws SQLException,
                                  AuthorizeException

Description copied from interface: GroupService

Initializes the group names for anonymous and administrator, and marks them "permanent".

Specified by:

initDefaultGroupNames in interface GroupService

Parameters:

context - the DSpace context

Throws:

SQLException - database exception

AuthorizeException - authorization error

getEmptyGroups

public List<Group> getEmptyGroups(Context context)
                           throws SQLException

Get a list of groups with no members.

Specified by:

getEmptyGroups in interface GroupService

Parameters:

context - The relevant DSpace Context.

Returns:

list of groups with no members

Throws:

SQLException - An exception that provides information on a database access error or other errors.

update

public void update(Context context,
                   Group group)
            throws SQLException,
                   AuthorizeException

Update the group - writing out group object and EPerson list if necessary

Specified by:

update in interface DSpaceObjectService<Group>

Overrides:

update in class DSpaceObjectServiceImpl<Group>

Parameters:

context - The relevant DSpace Context.

group - Group to update

Throws:

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

isEPersonInGroup

protected boolean isEPersonInGroup(Context context,
                                   Group group,
                                   EPerson ePerson)
                            throws SQLException

Throws:

SQLException

rethinkGroupCache

protected void rethinkGroupCache(Context context,
                                 boolean flushQueries)
                          throws SQLException

Regenerate the group cache AKA the group2groupcache table in the database - meant to be called when a group is added or removed from another group

Parameters:

context - The relevant DSpace Context.

flushQueries - flushQueries Flush all pending queries

Throws:

SQLException - An exception that provides information on a database access error or other errors.

getParentObject

public DSpaceObject getParentObject(Context context,
                                    Group group)
                             throws SQLException

Description copied from interface: DSpaceObjectService

Return the dspace object that "own" the current object in the hierarchy. Note that this method has a meaning slightly different from the getAdminObject because it is independent of the action but it is in a way related to it. It defines the "first" dspace object OTHER then the current one, where allowed ADMIN actions imply allowed ADMIN actions on the object self.

Specified by:

getParentObject in interface DSpaceObjectService<Group>

Overrides:

getParentObject in class DSpaceObjectServiceImpl<Group>

Parameters:

context - DSpace context

group - DSpaceObject

Returns:

the dspace object that "own" the current object in the hierarchy

Throws:

SQLException - if database error

updateLastModified

public void updateLastModified(Context context,
                               Group dso)

Specified by:

updateLastModified in interface DSpaceObjectService<Group>

getChildren

protected Set<UUID> getChildren(Map<UUID,Set<UUID>> parents,
                                UUID parent)

Used recursively to generate a map of ALL of the children of the given parent

Parameters:

parents - Map of parent,child relationships

parent - the parent you're interested in

Returns:

Map whose keys are all of the children of a parent

findByIdOrLegacyId

public Group findByIdOrLegacyId(Context context,
                                String id)
                         throws SQLException

Specified by:

findByIdOrLegacyId in interface DSpaceObjectLegacySupportService<Group>

Throws:

SQLException

findByLegacyId

public Group findByLegacyId(Context context,
                            int id)
                     throws SQLException

Description copied from interface: DSpaceObjectLegacySupportService

Generic find for when the precise type of a DSO is not known, just the a pair of type number and database ID.

Specified by:

findByLegacyId in interface DSpaceObjectLegacySupportService<Group>

Parameters:

context - - the context

id - - the legacy id within table of type'd objects

Returns:

the object found, or null if it does not exist.

Throws:

SQLException - only upon failure accessing the database.

countTotal

public int countTotal(Context context)
               throws SQLException

Description copied from interface: GroupService

Count the total number of groups in DSpace

Specified by:

countTotal in interface GroupService

Parameters:

context - The DSpace context

Returns:

The total number of groups

Throws:

SQLException - database exception

findByMetadataField

public List<Group> findByMetadataField(Context context,
                                       String searchValue,
                                       MetadataField metadataField)
                                throws SQLException

Description copied from interface: GroupService

Look up groups based on their value for a certain metadata field (NOTE: name is not stored as metadata)

Specified by:

findByMetadataField in interface GroupService

Parameters:

context - The DSpace context

searchValue - The value to match

metadataField - The metadata field to search in

Returns:

The groups that have a matching value for specified metadata field

Throws:

SQLException - database exception