com.communote.server.core.user

Class UserGroupManagementBase

java.lang.Object

com.communote.server.core.user.UserGroupManagementBase

All Implemented Interfaces:

UserGroupManagement

Direct Known Subclasses:

UserGroupManagementImpl

@Transactional(propagation=REQUIRED)
public abstract class UserGroupManagementBase
extends Object
implements UserGroupManagement

Spring Service base class for UserGroupManagement, provides access to all services and entities referenced by this service.

Author:

Communote GmbH - http://www.communote.com/

See Also:

UserGroupManagement

Constructor Summary

Constructors

Constructor and Description
UserGroupManagementBase()

Method Summary

Modifier and Type	Method and Description
Long	createExternalGroup(ExternalGroupVO groupVO) Create a group imported from an external system.
Group	createGroup(GroupVO groupVO) Create a new group.
Long	createOrUpdateExternalGroup(ExternalGroupVO groupVO) Create a group imported from an external system or if that group already exists it is updated.
void	deleteExternalGroup(Long groupId, String externalSystemId) Delete an external group.
void	deleteGroup(Long groupId) Delete a group.
<T> T	findGroupByAlias(String alias, Converter<Group,T> converter) Find a user group by its alias and convert it to the object to be returned.
<T> T	findGroupById(Long id, Converter<Group,T> converter) Find a user group by its ID and convert it to the object to be returned.
protected abstract Long	handleCreateExternalGroup(ExternalGroupVO groupVO) Performs the core logic for createExternalGroup(ExternalGroupVO)
protected abstract Group	handleCreateGroup(GroupVO groupVO) Performs the core logic for createGroup(GroupVO)
protected abstract Long	handleCreateOrUpdateExternalGroup(ExternalGroupVO groupVO) Performs the core logic for createOrUpdateExternalGroup(ExternalGroupVO)
protected abstract void	handleDeleteExternalGroup(Long groupId, String externalSystemId) Performs the core logic for deleteExternalGroup(Long, String)
protected abstract void	handleDeleteGroup(Long groupId) Performs the core logic for deleteGroup(Long)
protected abstract <T> T	handleFindGroupByAlias(String alias, Converter<Group,T> converter) Find a user group by its alias and convert it to the object to be returned.
protected abstract <T> T	handleFindGroupById(Long id, Converter<Group,T> converter) Find a user group by its ID and convert it to the object to be returned.
protected abstract boolean	handleIsExternalGroup(Long groupId) Test whether a group is an external group or an internal group.
protected abstract void	handleUpdateExternalGroup(Long groupId, ExternalGroupVO groupVO) Performs the core logic for #updateExternalGroup(ExternalGroupVO)
protected abstract void	handleUpdateGroup(Long groupId, GroupVO groupVO) Performs the core logic for updateGroup(Long, GroupVO)
boolean	isExternalGroup(Long groupId) Test whether a group is an external group or an internal group.
void	updateExternalGroup(Long groupId, ExternalGroupVO groupVO) Update a group that was imported from an external system.
void	updateGroup(Long groupId, GroupVO groupVO) Update an existing group.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserGroupManagementBase

public UserGroupManagementBase()

Method Detail

createExternalGroup

public Long createExternalGroup(ExternalGroupVO groupVO)
                         throws AliasValidationException,
                                AliasAlreadyExistsException,
                                GroupAlreadyExistsException

Description copied from interface: UserGroupManagement

Create a group imported from an external system.

Specified by:

createExternalGroup in interface UserGroupManagement

Parameters:

groupVO - a value object with details about the group. If the alias member is not set it will be generated from the name.

Returns:

the ID of the created group

Throws:

AliasValidationException - in case the alias field is not valid

AliasAlreadyExistsException - in case the alias already exists

GroupAlreadyExistsException - in case there is already a local group for the external group

createGroup

public Group createGroup(GroupVO groupVO)
                  throws AliasAlreadyExistsException,
                         AliasValidationException,
                         AuthorizationException

Description copied from interface: UserGroupManagement

Create a new group.

Specified by:

createGroup in interface UserGroupManagement

Throws:

AuthorizationException - in case the current user is not the client manager or the internal system user

AliasAlreadyExistsException

AliasValidationException

createOrUpdateExternalGroup

public Long createOrUpdateExternalGroup(ExternalGroupVO groupVO)
                                 throws AliasValidationException,
                                        AliasAlreadyExistsException

Description copied from interface: UserGroupManagement

Create a group imported from an external system or if that group already exists it is updated.

Specified by:

createOrUpdateExternalGroup in interface UserGroupManagement

Parameters:

groupVO - a value object with details about the group. If the alias member is not set it will be generated from the name.

Returns:

the ID of the created group

Throws:

AliasValidationException - in case the alias field is not valid

AliasAlreadyExistsException - in case the alias already exists

deleteExternalGroup

public void deleteExternalGroup(Long groupId,
                                String externalSystemId)
                         throws AuthorizationException

Description copied from interface: UserGroupManagement

Delete an external group. If the group does not exist nothing will happen.

Specified by:

deleteExternalGroup in interface UserGroupManagement

Throws:

AuthorizationException - in case the current user is not the internal system user

deleteGroup

public void deleteGroup(Long groupId)
                 throws AuthorizationException

Description copied from interface: UserGroupManagement

Delete a group. The group members are note deleted.

Specified by:

deleteGroup in interface UserGroupManagement

Parameters:

groupId - the Id of the group to delete

Throws:

GroupOperationNotPermittedException - if the group refers to an external group

AuthorizationException - if the current user is not client manager

findGroupByAlias

@Transactional(readOnly=true)
public <T> T findGroupByAlias(String alias,
                                                            Converter<Group,T> converter)

Description copied from interface: UserGroupManagement

Find a user group by its alias and convert it to the object to be returned.

Specified by:

findGroupByAlias in interface UserGroupManagement

Type Parameters:

T - the type of the target object

Parameters:

alias - the alias of the group to retrieve

converter - the converter to create the target object

Returns:

the found group as an instance of the target type or null if the group wasn't found

findGroupById

@Transactional(readOnly=true)
public <T> T findGroupById(Long id,
                                                         Converter<Group,T> converter)

Description copied from interface: UserGroupManagement

Find a user group by its ID and convert it to the object to be returned.

Specified by:

findGroupById in interface UserGroupManagement

Type Parameters:

T - the type of the target object

Parameters:

id - the ID of the group to retrieve

converter - the converter to create the target object

Returns:

the found group as an instance of the target type or null if the group wasn't found

handleCreateExternalGroup

protected abstract Long handleCreateExternalGroup(ExternalGroupVO groupVO)
                                           throws AliasValidationException,
                                                  AliasAlreadyExistsException,
                                                  GroupAlreadyExistsException

Performs the core logic for createExternalGroup(ExternalGroupVO)

Throws:

AliasValidationException

AliasAlreadyExistsException

GroupAlreadyExistsException

handleCreateGroup

protected abstract Group handleCreateGroup(GroupVO groupVO)
                                    throws AliasAlreadyExistsException,
                                           AliasValidationException,
                                           AuthorizationException

Performs the core logic for createGroup(GroupVO)

Throws:

AuthorizationException

AliasAlreadyExistsException

AliasValidationException

handleCreateOrUpdateExternalGroup

protected abstract Long handleCreateOrUpdateExternalGroup(ExternalGroupVO groupVO)
                                                   throws AliasAlreadyExistsException,
                                                          AliasValidationException

Performs the core logic for createOrUpdateExternalGroup(ExternalGroupVO)

Parameters:

groupVO - a value object with details about the group. If the alias member is not set it will be generated from the name.

Returns:

the ID of the group

Throws:

AliasValidationException - in case the alias field is not valid

AliasAlreadyExistsException - in case the alias already exists

handleDeleteExternalGroup

protected abstract void handleDeleteExternalGroup(Long groupId,
                                                  String externalSystemId)
                                           throws AuthorizationException

Performs the core logic for deleteExternalGroup(Long, String)

Throws:

AuthorizationException

handleDeleteGroup

protected abstract void handleDeleteGroup(Long groupId)
                                   throws GroupOperationNotPermittedException,
                                          AuthorizationException

Performs the core logic for deleteGroup(Long)

Throws:

AuthorizationException

GroupOperationNotPermittedException

handleFindGroupByAlias

protected abstract <T> T handleFindGroupByAlias(String alias,
                                                Converter<Group,T> converter)

Find a user group by its alias and convert it to the object to be returned.

Type Parameters:

T - the type of the target object

Parameters:

alias - the alias of the group to retrieve

converter - the converter to create the target object

Returns:

the found group as an instance of the target type or null if the group wasn't found

handleFindGroupById

protected abstract <T> T handleFindGroupById(Long id,
                                             Converter<Group,T> converter)

Find a user group by its ID and convert it to the object to be returned.

Type Parameters:

T - the type of the target object

Parameters:

id - the ID of the group to retrieve

converter - the converter to create the target object

Returns:

the found group as an instance of the target type or null if the group wasn't found

handleIsExternalGroup

protected abstract boolean handleIsExternalGroup(Long groupId)

Test whether a group is an external group or an internal group.

Parameters:

groupId - the ID of the group to test

Returns:

true if the group exists and is an external group, false otherwise

handleUpdateExternalGroup

protected abstract void handleUpdateExternalGroup(Long groupId,
                                                  ExternalGroupVO groupVO)
                                           throws GroupNotFoundException

Performs the core logic for #updateExternalGroup(ExternalGroupVO)

Parameters:

groupId - the ID of the group

groupVO - a value object with details about the group.

Throws:

GroupNotFoundException - in case the group to update does not exist

handleUpdateGroup

protected abstract void handleUpdateGroup(Long groupId,
                                          GroupVO groupVO)
                                   throws GroupNotFoundException,
                                          GroupOperationNotPermittedException

Performs the core logic for updateGroup(Long, GroupVO)

Throws:

GroupNotFoundException

GroupOperationNotPermittedException

isExternalGroup

@Transactional(readOnly=true)
public boolean isExternalGroup(Long groupId)

Description copied from interface: UserGroupManagement

Test whether a group is an external group or an internal group.

Specified by:

isExternalGroup in interface UserGroupManagement

Parameters:

groupId - the ID of the group to test

Returns:

true if the group exists and is an external group, false otherwise

updateExternalGroup

public void updateExternalGroup(Long groupId,
                                ExternalGroupVO groupVO)
                         throws GroupNotFoundException

Description copied from interface: UserGroupManagement

Update a group that was imported from an external system. The alias won't be changed.

Specified by:

updateExternalGroup in interface UserGroupManagement

Parameters:

groupId - ID of the group to update

groupVO - a value object with details about the group

Throws:

GroupNotFoundException - in case the group to update does not exist

updateGroup

public void updateGroup(Long groupId,
                        GroupVO groupVO)
                 throws GroupNotFoundException,
                        GroupOperationNotPermittedException

Description copied from interface: UserGroupManagement

Update an existing group. The alias won't be changed.

Specified by:

updateGroup in interface UserGroupManagement

Parameters:

groupId - the ID of the group to update

groupVO - a value object with details about the group

Throws:

GroupNotFoundException - in case the group to update does not exist

GroupOperationNotPermittedException