Package org.craftercms.studio.impl.v2.service.security

Class GroupServiceImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.security.GroupServiceImpl

All Implemented Interfaces:

GroupService

public class GroupServiceImpl
extends Object
implements GroupService

Constructor Summary

Constructors

Constructor	Description
GroupServiceImpl(GroupServiceInternal groupServiceInternal, OrganizationServiceInternal organizationServiceInternal, UserServiceInternal userServiceInternal, GeneralLockService generalLockService, StudioConfiguration studioConfiguration, AuditServiceInternal auditServiceInternal, SiteService siteService)

Method Summary

Modifier and Type	Method	Description
List<UserResponse>	addGroupMembers(long groupId, List<Long> userIds, List<String> usernames)	Add users to the group
Group	createGroup(long orgId, String groupName, String groupDescription, boolean externallyManaged)	Create group
void	deleteGroup(List<Long> groupIds)	Delete group(s)
List<Group>	getAllGroups(long orgId, String keyword, int offset, int limit, String sort)	Get all groups
int	getAllGroupsTotal(long orgId, String keyword)	Get total number of all groups
Group	getGroup(long groupId)	Get group
List<UserResponse>	getGroupMembers(long groupId, int offset, int limit, String sort)	Get group members
int	getGroupMembersTotal(long groupId)	Get total number of group members
void	removeGroupMembers(long groupId, List<Long> userIds, List<String> usernames)	Remove users from the group
Group	updateGroup(long orgId, Group group)	Update group

Methods inherited from class java.lang.Object

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

Constructor Details

GroupServiceImpl

@ConstructorProperties({"groupServiceInternal","organizationServiceInternal","userServiceInternal","generalLockService","studioConfiguration","auditServiceInternal","siteService"})
public GroupServiceImpl(GroupServiceInternal groupServiceInternal,
 OrganizationServiceInternal organizationServiceInternal,
 UserServiceInternal userServiceInternal,
 GeneralLockService generalLockService,
 StudioConfiguration studioConfiguration,
 AuditServiceInternal auditServiceInternal,
 SiteService siteService)

Method Details

getAllGroups

public List<Group> getAllGroups(long orgId,
 String keyword,
 int offset,
 int limit,
 String sort)
                         throws ServiceLayerException,
OrganizationNotFoundException

Description copied from interface: GroupService

Get all groups

Specified by:

getAllGroups in interface GroupService

Parameters:

orgId - Organization identifier

keyword - keyword to filter groups

offset - Result set offset

limit - Result set limit

sort - Sort order

Returns:

List of groups

Throws:

ServiceLayerException - general service error

OrganizationNotFoundException - organization not found

getAllGroupsTotal

public int getAllGroupsTotal(long orgId,
 String keyword)
                      throws ServiceLayerException,
OrganizationNotFoundException

Description copied from interface: GroupService

Get total number of all groups

Specified by:

getAllGroupsTotal in interface GroupService

Parameters:

orgId - Organization identifier

keyword - keyword to filter groups

Returns:

Number of groups

Throws:

ServiceLayerException - general service error

OrganizationNotFoundException - organization not found

createGroup

public Group createGroup(long orgId,
 String groupName,
 String groupDescription,
 boolean externallyManaged)
                  throws GroupAlreadyExistsException,
ServiceLayerException,
AuthenticationException

Description copied from interface: GroupService

Create group

Specified by:

createGroup in interface GroupService

Parameters:

orgId - Organization identifier

groupName - Group name

groupDescription - Group description

externallyManaged - true if group is externally managed, false otherwise

Returns:

the created group

Throws:

GroupAlreadyExistsException - group already exist error

ServiceLayerException - general service error

AuthenticationException - authentication error

updateGroup

public Group updateGroup(long orgId,
 Group group)
                  throws ServiceLayerException,
GroupNotFoundException,
AuthenticationException,
GroupExternallyManagedException

Description copied from interface: GroupService

Update group

Specified by:

updateGroup in interface GroupService

Parameters:

orgId - Organization identifier

group - Group to update

Returns:

the updated group

Throws:

ServiceLayerException - general service error

GroupNotFoundException - group not found error

AuthenticationException - authentication error

GroupExternallyManagedException - if group is externally managed

deleteGroup

public void deleteGroup(List<Long> groupIds)
                 throws ServiceLayerException,
GroupNotFoundException,
AuthenticationException,
GroupExternallyManagedException

Description copied from interface: GroupService

Delete group(s)

Specified by:

deleteGroup in interface GroupService

Parameters:

groupIds - Group identifiers

Throws:

ServiceLayerException - general service error

GroupNotFoundException - group not found

AuthenticationException - authentication error

GroupExternallyManagedException - if group is externally managed

getGroup

public Group getGroup(long groupId)
               throws ServiceLayerException,
GroupNotFoundException

Description copied from interface: GroupService

Get group

Specified by:

getGroup in interface GroupService

Parameters:

groupId - Group identifier

Returns:

Group

Throws:

ServiceLayerException - general service error

GroupNotFoundException - group not found

getGroupMembers

public List<UserResponse> getGroupMembers(long groupId,
 int offset,
 int limit,
 String sort)
                                   throws ServiceLayerException,
GroupNotFoundException

Description copied from interface: GroupService

Get group members

Specified by:

getGroupMembers in interface GroupService

Parameters:

groupId - Group identifier

offset - Result set offset

limit - Result set limit

sort - Sort order

Returns:

List of users

Throws:

ServiceLayerException - general service error

GroupNotFoundException - group not found

getGroupMembersTotal

public int getGroupMembersTotal(long groupId)
                         throws ServiceLayerException,
GroupNotFoundException

Description copied from interface: GroupService

Get total number of group members

Specified by:

getGroupMembersTotal in interface GroupService

Parameters:

groupId - Group identifier

Returns:

Number of members

Throws:

ServiceLayerException - general service error

GroupNotFoundException - group not found

addGroupMembers

public List<UserResponse> addGroupMembers(long groupId,
 List<Long> userIds,
 List<String> usernames)
                                   throws ServiceLayerException,
UserNotFoundException,
GroupNotFoundException,
AuthenticationException

Description copied from interface: GroupService

Add users to the group

Specified by:

addGroupMembers in interface GroupService

Parameters:

groupId - Group identifier

userIds - List of user identifiers

usernames - List of usernames

Returns:

users added to the group

Throws:

ServiceLayerException - general service error

UserNotFoundException - user not found

GroupNotFoundException - group not found

AuthenticationException - authentication error

removeGroupMembers

public void removeGroupMembers(long groupId,
 List<Long> userIds,
 List<String> usernames)
                        throws ServiceLayerException,
UserNotFoundException,
GroupNotFoundException,
AuthenticationException

Description copied from interface: GroupService

Remove users from the group

Specified by:

removeGroupMembers in interface GroupService

Parameters:

groupId - Group identifier

userIds - List of user identifiers

usernames - List of usernames

Throws:

ServiceLayerException - general service error

UserNotFoundException - user not found

GroupNotFoundException - group not found

AuthenticationException - authentication error