Package org.cyclos.impl.users

Class GroupsHandlerImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseNetworkedHandlerImpl

org.cyclos.impl.users.GroupsHandlerImpl

All Implemented Interfaces:

BasicGroupListViewFactoryAccessor, GroupListViewFactoryAccessor, GroupsHandler, GroupsHandlerInternal

@Component
public class GroupsHandlerImpl
extends BaseNetworkedHandlerImpl
implements GroupsHandlerInternal

Implementation for GroupsHandler.

WARNING: All methods returning a collection of (basic)groups are to be implemented in this class (and NOT in GroupServiceImpl). If needed, the implementation is delegated to SessionData. Rule of thumb for placing implementations of group retrieving methods:

• filtering away disabled groups is always done in GroupsHandler and never in SessionData.
• Other filtering is preferable done in GroupsHandler.
• Cases in which the returned result depends on the type of the Session (User, System, Guest), are (logically) placed in SessionData.
• Queries are placed in SessionData if they are simple and don't filter on disabled groups. More complicated filtering via the query is done in GroupsHandler, except when the result depends on the Session type.

Field Summary

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

Fields inherited from interface org.cyclos.impl.users.GroupsHandler

VO_MAPPINGS

Constructor Summary

Constructors

Constructor	Description
GroupsHandlerImpl()

Method Summary

Modifier and Type	Method	Description
GroupListViewFactoryImpl	accessibles()	Returns a container for the GroupList.ACCESSIBLE group list
GroupListViewFactoryImpl	ads()	Returns a container for the GroupList.ADS group list without applying the group visibility.
GroupListViewFactory	all()	Only for administrators or system it will include disabled groups, for members it returns the same as BasicGroupListViewFactoryAccessor.accessibles().
GroupListViewFactoryImpl	directory()	Returns a view factory for the GroupList.DIRECTORY group list.
Set<Group>	flatten(Collection<? extends BasicGroup> basicGroups)	Expands the given groups / group sets into a set of groups.
Set<Group>	flattenVOs(Collection<? extends BasicGroupVO> basicGroupVOs)	See GroupsHandler.flatten(Collection), but takes the VO's as input.
Set<Group>	flattenVOs(Collection<? extends BasicGroupVO> basicGroupVOs, boolean includeDisabledGroups)	See GroupsHandler.flatten(Collection), but takes the VO's as input, and includes disabled groups depending on the boolean parameter.
Set<BasicGroup>	getAccessibleBasicGroups(boolean overBrokered, BasicGroup basicGroup, ProductsAccessor products)	Gets accessible basic groups for the given group and products.
Set<AdminGroup>	getAccessibleGlobalGroups()	Returns the accessible admin global groups the logged user can access.
Set<UserGroup>	getAccessibleUserGroups(User user)	Returns the accessible groups with type=USER and enabled=true for the given user
ConversionHandler	getConversionHandler()	Returns the unique conversion handler present in the context (as a utility for the GroupListView)
Set<BasicGroupVO>	getDefaultGroupFilter(boolean overBrokered, Collection<? extends BasicGroupVO> availableGroups)	Returns the groups used by default for searches, if any, contained in the available for search collection
Set<BasicGroup>	getDefaultGroupFilter(boolean overBrokered, BasicGroup group, ProductsAccessor products)	Returns the groups used by default for searches, if any, for the given group and accessor
GroupVisibility	getGroupVisibility(boolean overBrokered)	Returns the GroupVisibility for the current user.
GroupVisibility	getGroupVisibility(ProductsAccessor accessor, boolean overBrokered)	Returns the GroupVisibility in the given accessor or the one for the current user when null.
List<InitialGroupVO>	getPossiblePublicInitialGroups()	Returns the groups either a public user may use to register himself, or a broker to register a new member
Set<Group>	getPossibleRegistrationGroups(boolean onlyUserGroups, boolean asMember)	Returns the possible groups for registering new users for the logged user: if admin: all visible groups if admin products allow registration (Permission.USERS_REGISTER). if broker: depends on the flag asMember: if true then all groups for registration according to the member products, otherwise all groups for registration according to the broker products.
List<InitialGroupVO>	getPossibleRegistrationInitialGroups(boolean asMember)	Same as {@link #getPossibleRegistrationGroups(false, boolean)} but in case of a broker registering "as member" or a member the name and description are those set for registration.
Set<BasicGroup>	getSearchOnGroups(boolean overBrokered, BasicGroup group, ProductsAccessor products)	Returns the groups a user can search other users on with the given group and products
Set<BasicGroup>	getUserDirectoryOnGroups(BasicGroup group, ProductsAccessor products)	Returns the groups a user can view on the directory (map) with the given group and products
Set<BasicGroup>	getViewProfileOnGroups()	Returns the groups the logged user can view profile of users
Set<BasicGroup>	getViewProfileOnGroups(BasicGroup group, ProductsAccessor products)	Returns the groups a user view profile with the given group and products
void	initialize()
GroupListViewFactory	menu()	Returns a view factory for the GroupList.MENU group list.
List<BasicGroupVO>	sortHierarchy(Collection<? extends BasicGroup> groups)	Returns a sorted list with the groups hierarchically organized
GroupListViewFactoryImpl	users()	Returns a view factory for the GroupList.USERS group list.
GroupListViewFactory	viewFactory(Collection<? extends BasicGroup> basicGroups)	Return a view factory for the given set of basic groups.
GroupListViewFactory	viewFactory(GroupList list)	Returns a view factory for working with brokeredMembers = false and without applying group visibility.
GroupListViewFactoryAccessor	visibles()	This method must be used to send the available groups to use as filter (e.g in a search data) and must used in conjunction with GroupListView.check(Collection) to check the selected groups in the corresponding search. It applies the GroupVisibility before returning the groups (the other factory methods (BasicGroupListViewFactoryAccessor.accessibles(), GroupListViewFactoryAccessor.ads(), etc) don't). For examples how to use it please search for references to this method. Guests has GroupVisibility.NONE as visibility then a factory returning empty views is returned (never null) and administrators has GroupVisibility.GROUP.

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, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, 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

Constructor Detail

GroupsHandlerImpl

public GroupsHandlerImpl()

Method Detail

accessibles

public GroupListViewFactoryImpl accessibles()

Returns a container for the GroupList.ACCESSIBLE group list

Specified by:

accessibles in interface BasicGroupListViewFactoryAccessor

ads

public GroupListViewFactoryImpl ads()

Returns a container for the GroupList.ADS group list without applying the group visibility.

Specified by:

ads in interface GroupListViewFactoryAccessor

all

public GroupListViewFactory all()

Description copied from interface: GroupsHandler

Only for administrators or system it will include disabled groups, for members it returns the same as BasicGroupListViewFactoryAccessor.accessibles(). This method must be used if we want to include the disabled basic groups in the views returned by the factory. We directly return a factory because only the accessible groups has support to include disabled.

Specified by:

all in interface GroupsHandler

directory

public GroupListViewFactoryImpl directory()

Description copied from interface: GroupListViewFactoryAccessor

Returns a view factory for the GroupList.DIRECTORY group list.

Specified by:

directory in interface GroupListViewFactoryAccessor

flatten

public Set<Group> flatten(Collection<? extends BasicGroup> basicGroups)

Description copied from interface: GroupsHandler

Expands the given groups / group sets into a set of groups. Of each encountered groupSet, all the belonging groups are added. The groupset itself is left out.
Disabled groups are included if they are explicitly included in the input collection. If the disabled group belongs to a groupset, and this groupset is included in the input collection (without the disabled group itself being explicitly included), then the disabled group is NOT included in the result. So if you want to include any disabled group, be sure to add it explicitly in the input parameter.

Specified by:

flatten in interface GroupsHandler

flattenVOs

public Set<Group> flattenVOs(Collection<? extends BasicGroupVO> basicGroupVOs)

Description copied from interface: GroupsHandler

See GroupsHandler.flatten(Collection), but takes the VO's as input.

Specified by:

flattenVOs in interface GroupsHandler

flattenVOs

public Set<Group> flattenVOs(Collection<? extends BasicGroupVO> basicGroupVOs,
                             boolean includeDisabledGroups)

Description copied from interface: GroupsHandler

See GroupsHandler.flatten(Collection), but takes the VO's as input, and includes disabled groups depending on the boolean parameter.

Specified by:

flattenVOs in interface GroupsHandler

includeDisabledGroups - boolean, if false, the behavior is as flattenVOs(Collection). If true, the disabled groups are included if they are part of a groupSet which is selected, no matter if they are explicitly selected or not.

getAccessibleBasicGroups

public Set<BasicGroup> getAccessibleBasicGroups(boolean overBrokered,
                                                BasicGroup basicGroup,
                                                ProductsAccessor products)

Description copied from interface: GroupsHandlerInternal

Gets accessible basic groups for the given group and products. Groupsets are included, but groups with enabled=false are excluded. If groupsets are included, their contained groups are automatically also included.

Specified by:

getAccessibleBasicGroups in interface GroupsHandlerInternal

getAccessibleGlobalGroups

public Set<AdminGroup> getAccessibleGlobalGroups()

Description copied from interface: GroupsHandler

Returns the accessible admin global groups the logged user can access. If the logged user is not global then an empty set is returned. Otherwise, if it has the Role.GLOBAL_ADMIN role then returns all global groups, it not, returns a set containing its own group.

Specified by:

getAccessibleGlobalGroups in interface GroupsHandler

getAccessibleUserGroups

public Set<UserGroup> getAccessibleUserGroups(User user)

Description copied from interface: GroupsHandler

Returns the accessible groups with type=USER and enabled=true for the given user

Specified by:

getAccessibleUserGroups in interface GroupsHandler

getConversionHandler

public ConversionHandler getConversionHandler()

Description copied from interface: GroupsHandlerInternal

Returns the unique conversion handler present in the context (as a utility for the GroupListView)

Specified by:

getConversionHandler in interface GroupsHandlerInternal

getDefaultGroupFilter

public Set<BasicGroup> getDefaultGroupFilter(boolean overBrokered,
                                             BasicGroup group,
                                             ProductsAccessor products)

Description copied from interface: GroupsHandlerInternal

Returns the groups used by default for searches, if any, for the given group and accessor

Specified by:

getDefaultGroupFilter in interface GroupsHandlerInternal

getDefaultGroupFilter

public Set<BasicGroupVO> getDefaultGroupFilter(boolean overBrokered,
                                               Collection<? extends BasicGroupVO> availableGroups)

Description copied from interface: GroupsHandlerInternal

Returns the groups used by default for searches, if any, contained in the available for search collection

Specified by:

getDefaultGroupFilter in interface GroupsHandlerInternal

getGroupVisibility

public GroupVisibility getGroupVisibility(boolean overBrokered)

Description copied from interface: GroupsHandler

Returns the GroupVisibility for the current user. As broker we must have the same or bigger visibility than as member, so when brokering, it is used as base-line the visibility set in member products.

Specified by:

getGroupVisibility in interface GroupsHandler

getGroupVisibility

public GroupVisibility getGroupVisibility(ProductsAccessor accessor,
                                          boolean overBrokered)

Description copied from interface: GroupsHandlerInternal

Returns the GroupVisibility in the given accessor or the one for the current user when null. As broker we must have the same or bigger visibility than as member, so when brokering, it is used as base-line the visibility set in member products.

Specified by:

getGroupVisibility in interface GroupsHandlerInternal

getPossiblePublicInitialGroups

public List<InitialGroupVO> getPossiblePublicInitialGroups()

Description copied from interface: GroupsHandler

Returns the groups either a public user may use to register himself, or a broker to register a new member

Specified by:

getPossiblePublicInitialGroups in interface GroupsHandler

getPossibleRegistrationGroups

public Set<Group> getPossibleRegistrationGroups(boolean onlyUserGroups,
                                                boolean asMember)

Description copied from interface: GroupsHandler

Returns the possible groups for registering new users for the logged user:

• if admin: all visible groups if admin products allow registration (Permission.USERS_REGISTER).
• if broker: depends on the flag asMember: if true then all groups for registration according to the member products, otherwise all groups for registration according to the broker products. In both cases the groups are filtered by the accessible groups.
• if member / operator: then all groups for registration according to the member products filtered by the accessible groups.

Specified by:

getPossibleRegistrationGroups in interface GroupsHandler

Parameters:

onlyUserGroups - if true then only user groups will be returned.

asMember - only used in case of the logged user is a broker.

getPossibleRegistrationInitialGroups

public List<InitialGroupVO> getPossibleRegistrationInitialGroups(boolean asMember)

Description copied from interface: GroupsHandler

Same as {@link #getPossibleRegistrationGroups(false, boolean)} but in case of a broker registering "as member" or a member the name and description are those set for registration.

Specified by:

getPossibleRegistrationInitialGroups in interface GroupsHandler

getSearchOnGroups

public Set<BasicGroup> getSearchOnGroups(boolean overBrokered,
                                         BasicGroup group,
                                         ProductsAccessor products)

Description copied from interface: GroupsHandlerInternal

Returns the groups a user can search other users on with the given group and products

Specified by:

getSearchOnGroups in interface GroupsHandlerInternal

getUserDirectoryOnGroups

public Set<BasicGroup> getUserDirectoryOnGroups(BasicGroup group,
                                                ProductsAccessor products)

Description copied from interface: GroupsHandlerInternal

Returns the groups a user can view on the directory (map) with the given group and products

Specified by:

getUserDirectoryOnGroups in interface GroupsHandlerInternal

getViewProfileOnGroups

public Set<BasicGroup> getViewProfileOnGroups()

Description copied from interface: GroupsHandler

Returns the groups the logged user can view profile of users

Specified by:

getViewProfileOnGroups in interface GroupsHandler

getViewProfileOnGroups

public Set<BasicGroup> getViewProfileOnGroups(BasicGroup group,
                                              ProductsAccessor products)

Description copied from interface: GroupsHandlerInternal

Returns the groups a user view profile with the given group and products

Specified by:

getViewProfileOnGroups in interface GroupsHandlerInternal

initialize

@PostConstruct
public void initialize()

menu

public GroupListViewFactory menu()

Description copied from interface: GroupListViewFactoryAccessor

Returns a view factory for the GroupList.MENU group list.

Specified by:

menu in interface GroupListViewFactoryAccessor

sortHierarchy

public List<BasicGroupVO> sortHierarchy(Collection<? extends BasicGroup> groups)

Description copied from interface: GroupsHandlerInternal

Returns a sorted list with the groups hierarchically organized

Specified by:

sortHierarchy in interface GroupsHandlerInternal

users

public GroupListViewFactoryImpl users()

Description copied from interface: GroupListViewFactoryAccessor

Returns a view factory for the GroupList.USERS group list.

Specified by:

users in interface GroupListViewFactoryAccessor

viewFactory

public GroupListViewFactory viewFactory(Collection<? extends BasicGroup> basicGroups)

Description copied from interface: GroupsHandler

Return a view factory for the given set of basic groups.

Specified by:

viewFactory in interface GroupsHandler

viewFactory

public GroupListViewFactory viewFactory(GroupList list)

Description copied from interface: GroupsHandler

Returns a view factory for working with brokeredMembers = false and without applying group visibility.

Specified by:

viewFactory in interface GroupsHandler

visibles

public GroupListViewFactoryAccessor visibles()

Description copied from interface: GroupsHandler

This method must be used to send the available groups to use as filter (e.g in a search data) and must used in conjunction with GroupListView.check(Collection) to check the selected groups in the corresponding search.
It applies the GroupVisibility before returning the groups (the other factory methods (BasicGroupListViewFactoryAccessor.accessibles(), GroupListViewFactoryAccessor.ads(), etc) don't).
For examples how to use it please search for references to this method.
Guests has GroupVisibility.NONE as visibility then a factory returning empty views is returned (never null) and administrators has GroupVisibility.GROUP.

Specified by:

visibles in interface GroupsHandler