Package org.cyclos.impl.users

Class GroupServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

org.cyclos.impl.users.GroupServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<BasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>, GroupServiceLocal, CRUDService<BasicGroupDTO,BasicGroupData,BasicGroupNature>, CRUDWithConfirmationPasswordService<BasicGroupDTO,BasicGroupData,BasicGroupNature>, Service, GroupService

@Service
public class GroupServiceImpl
extends CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>
implements GroupServiceLocal

implementation for GroupService. Note that methods for retrieving collections of groups are to be placed in GroupsHandler.

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
GroupServiceImpl()

Method Summary

Modifier and Type	Method	Description
boolean	canChangeEnabled(Group group)	Returns true if the group enabled attribute can be changed.
boolean	canManage(BasicGroup group)	Returns whether the group can be managed by the logged user
boolean	canView(BasicGroup group)	Returns whether the group can be viewed by the logged user
void	changeConfiguration(BasicGroupVO basicGroupVO, ConfigurationVO configurationVO)	Changes the configuration for the specified BasicGroup by assigning a new Configuration.
AdminGroup	createNetworkAdmins(Network network)	Creates the network administrators group for the given network
protected void	doRemove(BasicGroup entity, boolean flush)	May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well
Group	findByName(String name)	Find a group by name
ActiveConfigurationForGroupsData	getActiveConfiguration(BasicGroupVO basicGroupVO)	Returns the ActiveConfigurationForGroupsData, containing all the actual configuration for the given group or group set
List<AdminGroup>	getAdminGroups()	Return all enabled admin groups.
Set<BasicGroup>	getBasicUserGroups()	Returns all enabled groups (including GroupSets) but excluding admin in the system In case groupsets are included, all of the groups contained in that groupset are also automatically included.
protected BasicGroupData	getData(BasicGroup basicGroup)	Returns details data for the given entity
List<BasicGroup>	getGroupsUsingConfiguration(Configuration configuration)	Returns all groups which are associated with the given configuration
List<BasicGroup>	getGroupsUsingProduct(Product product)	Returns all groups which are associated to the given product
GroupSearchData	getSearchData()	Returns the data for searching groups
AdminGroup	getSystemAdmins()	Returns the default admins group, that is, either global admins if in global mode, or the current network admins otherwise
Boolean	hasUsers(BasicGroup basicGroup)	returns true if there are users in the basic group
Collection<BasicGroup>	listEntities(BasicGroupQuery params)	List group entities that satisfy the given conditions
BasicGroup	newEntity(BasicGroupNature nature)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterRemove(BasicGroup entity)	May be overridden in order to perform custom logic after removing an entity
protected void	onAfterSave(BasicGroup entity, BasicGroup currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected void	onBeforeRemove(BasicGroup basicGroup)	May be overridden in order to perform custom logic before removing an entity
protected Object	onBeforeSave(BasicGroup group, BasicGroup currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected Validator	resolveValidator(BasicGroupDTO dto)
Page<BasicGroupVO>	search(BasicGroupQuery params)	Searches for groups, returning results hierarchically
protected org.apache.commons.collections4.BidiMap<Class<? extends BasicGroup>,Class<? extends BasicGroupDTO>>	subClassMappings()	Should be overridden by subclasses which handle entity / dto hierarchies.
BasicGroupDTO	toDTO(BasicGroup entity)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses
BasicGroup	toEntity(BasicGroupDTO dto)	Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, delete, detach, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, validate

Constructor Detail

GroupServiceImpl

public GroupServiceImpl()

Method Detail

canChangeEnabled

public boolean canChangeEnabled(Group group)

Description copied from interface: GroupServiceLocal

Returns true if the group enabled attribute can be changed. It can be changed if all the users in the group are removed or the group has no users.

Specified by:

canChangeEnabled in interface GroupServiceLocal

canManage

public boolean canManage(BasicGroup group)

Description copied from interface: GroupServiceLocal

Returns whether the group can be managed by the logged user

Specified by:

canManage in interface GroupServiceLocal

canView

public boolean canView(BasicGroup group)

Description copied from interface: GroupServiceLocal

Returns whether the group can be viewed by the logged user

Specified by:

canView in interface GroupServiceLocal

changeConfiguration

public void changeConfiguration(BasicGroupVO basicGroupVO,
                                ConfigurationVO configurationVO)

Description copied from interface: GroupService

Changes the configuration for the specified BasicGroup by assigning a new Configuration. As a result, the configuration formerly assigned is not assigned anymore to the group.

Specified by:

changeConfiguration in interface GroupService

createNetworkAdmins

public AdminGroup createNetworkAdmins(Network network)
                               throws FrameworkException

Description copied from interface: GroupServiceLocal

Creates the network administrators group for the given network

Specified by:

createNetworkAdmins in interface GroupServiceLocal

Throws:

FrameworkException

findByName

public Group findByName(String name)

Description copied from interface: GroupServiceLocal

Find a group by name

Specified by:

findByName in interface GroupServiceLocal

getActiveConfiguration

public ActiveConfigurationForGroupsData getActiveConfiguration(BasicGroupVO basicGroupVO)
                                                        throws EntityNotFoundException

Description copied from interface: GroupService

Returns the ActiveConfigurationForGroupsData, containing all the actual configuration for the given group or group set

Specified by:

getActiveConfiguration in interface GroupService

Throws:

EntityNotFoundException

getAdminGroups

public List<AdminGroup> getAdminGroups()

Description copied from interface: GroupServiceLocal

Return all enabled admin groups.

Specified by:

getAdminGroups in interface GroupServiceLocal

getBasicUserGroups

public Set<BasicGroup> getBasicUserGroups()

Description copied from interface: GroupServiceLocal

Returns all enabled groups (including GroupSets) but excluding admin in the system In case groupsets are included, all of the groups contained in that groupset are also automatically included.

Specified by:

getBasicUserGroups in interface GroupServiceLocal

getGroupsUsingConfiguration

public List<BasicGroup> getGroupsUsingConfiguration(Configuration configuration)
                                             throws FrameworkException

Description copied from interface: GroupServiceLocal

Returns all groups which are associated with the given configuration

Specified by:

getGroupsUsingConfiguration in interface GroupServiceLocal

Throws:

FrameworkException

getGroupsUsingProduct

public List<BasicGroup> getGroupsUsingProduct(Product product)

Description copied from interface: GroupServiceLocal

Returns all groups which are associated to the given product

Specified by:

getGroupsUsingProduct in interface GroupServiceLocal

getSearchData

public GroupSearchData getSearchData()

Description copied from interface: GroupService

Returns the data for searching groups

Specified by:

getSearchData in interface GroupService

getSystemAdmins

public AdminGroup getSystemAdmins()
                           throws FrameworkException

Description copied from interface: GroupServiceLocal

Returns the default admins group, that is, either global admins if in global mode, or the current network admins otherwise

Specified by:

getSystemAdmins in interface GroupServiceLocal

Throws:

FrameworkException

hasUsers

public Boolean hasUsers(BasicGroup basicGroup)

Description copied from interface: GroupServiceLocal

returns true if there are users in the basic group

Specified by:

hasUsers in interface GroupServiceLocal

listEntities

public Collection<BasicGroup> listEntities(BasicGroupQuery params)

Description copied from interface: GroupServiceLocal

List group entities that satisfy the given conditions

Specified by:

listEntities in interface GroupServiceLocal

newEntity

public BasicGroup newEntity(BasicGroupNature nature)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<BasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

Specified by:

newEntity in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

search

public Page<BasicGroupVO> search(BasicGroupQuery params)

Description copied from interface: GroupService

Searches for groups, returning results hierarchically

Specified by:

search in interface GroupService

toDTO

public BasicGroupDTO toDTO(BasicGroup entity)

Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses
Note that the method takes the entity's accessibleBasicGroups property, and divides this over the DTO's accessibleUserGroups property and the DTO's accessibleAdminGroups property. Also Note that the userGroups are flattened, so entities having only a GroupSet in accessibleBasicGroups turn out with a DTO having bothe the GroupSet and its containing groups in the accessibleBasicGroups.

Specified by:

toDTO in interface CRUDServiceLocal<BasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

Overrides:

toDTO in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

toEntity

public BasicGroup toEntity(BasicGroupDTO dto)

Description copied from class: CRUDServiceImpl

Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toEntity in interface CRUDServiceLocal<BasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

Overrides:

toEntity in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

doRemove

protected void doRemove(BasicGroup entity,
                        boolean flush)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well

Overrides:

doRemove in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

getData

protected BasicGroupData getData(BasicGroup basicGroup)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

onAfterRemove

protected void onAfterRemove(BasicGroup entity)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after removing an entity

Overrides:

onAfterRemove in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

onAfterSave

protected void onAfterSave(BasicGroup entity,
                           BasicGroup currentCopy,
                           Object dataFromOnBeforeSave)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after saving an entity

Overrides:

onAfterSave in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

onBeforeRemove

protected void onBeforeRemove(BasicGroup basicGroup)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before removing an entity

Overrides:

onBeforeRemove in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

onBeforeSave

protected Object onBeforeSave(BasicGroup group,
                              BasicGroup currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveValidator

protected Validator resolveValidator(BasicGroupDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>

subClassMappings

protected org.apache.commons.collections4.BidiMap<Class<? extends BasicGroup>,Class<? extends BasicGroupDTO>> subClassMappings()

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which handle entity / dto hierarchies. The map key should be the entity class, while the map value, the DTO class

Overrides:

subClassMappings in class CRUDServiceImpl<BasicGroup,QBasicGroup,BasicGroupDTO,BasicGroupData,BasicGroupNature>