Package org.ametys.plugins.workspaces.members

Class ProjectMemberManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.members.ProjectMemberManager

All Implemented Interfaces:

LogEnabled, Initializable, Component, Contextualizable, Serviceable

public class ProjectMemberManager
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable, Initializable

Helper component for managing project's users

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectMemberManager.ProjectMember	This class represents a member of a project.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	__WORKSPACES_SERVICE_MEMBERS	The id of the members service
protected AbstractCacheManager	_abstractCacheManager	The cache manager
protected Context	_context	Avalon context
protected CurrentUserProvider	_currentUserProvider	Current user provider
protected GroupDirectoryContextHelper	_groupDirectoryContextHelper	The group directory context helper
protected GroupManager	_groupManager	The groups manager
protected LanguagesManager	_languagesManager	The language manager
protected WorkspaceModuleExtensionPoint	_moduleManagerEP	Module managers EP
protected ObservationManager	_observationManager	The observation manager
protected PopulationContextHelper	_populationContextHelper	The population context helper
protected ProfileAssignmentStorageExtensionPoint	_profileAssignmentStorageExtensionPoint	Profile assignment storage
protected ProjectInvitationHelper	_projectInvitationHelper	The project invitation helper
protected ProjectManager	_projectManager	Project manager
protected ProjectRightHelper	_projectRightHelper	Project rights helper
protected AmetysObjectResolver	_resolver	Ametys object resolver
protected RightManager	_rightManager	Rights manager
protected RightProfilesDAO	_rightProfilesDAO	Profiles right manager
protected URIResolverExtensionPoint	_uriResolver	The page URI resolver.
protected UserDirectoryHelper	_userDirectoryHelper	The user directory helper
protected UserDirectoryPageResolver	_userDirectoryPageResolver	The resolver for user directory pages
protected UserHelper	_userHelper	The user helper
protected UserManager	_userManager	Users manager
protected UserSignupManager	_userSignupManager	The user signup manager
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
ProjectMemberManager()

Method Summary

Modifier and Type	Method	Description
protected Map<String,String>	_getDefaultProfilesByModule()	Get a map of each available module, with the default profile
protected JCRProjectMember	_getOrCreateJCRProjectMember(Project project, Predicate<? super AmetysObject> findMemberPredicate)	Retrieve or create a member in a project
protected ModifiableTraversableAmetysObject	_getProjectMembersNode(Project project)	Retrieves the users node of the project The users node will be created if necessary
protected Map<String,Object>	_setProjectMemberData(String projectName, String identity, String type, Map<String,String> newProfiles, String role, boolean isNewUser)	Set the user data in the project
Map<String,Object>	addMember(String projectName, String identity, String type)	Add a new member
Map<String,Object>	addMembers(String projectName, List<Map<String,String>> newMembers, List<String> invitEmails)	Add new members and invitation by email
JCRProjectMember	addOrUpdateProjectMember(Project project, GroupIdentity group, Map<String,String> allowedProfiles)	Add a group to a project, using the provided profile values
JCRProjectMember	addOrUpdateProjectMember(Project project, UserIdentity user, Map<String,String> allowedProfiles)	Add a user to a project, using the provided profile values
JCRProjectMember	addOrUpdateProjectMember(Project project, UserIdentity user, Map<String,String> allowedProfiles, UserIdentity issuer)	Add a user to a project, using the provided profile values
JCRProjectMember	addProjectMember(Project project, UserIdentity user)	Add a user to a project with open inscriptions, using the default values
void	contextualize(Context context)
Map<String,Object>	getCurrentUser()	Get the current user information
List<User>	getGroupUsersFromProject(Group group, Project project, BiPredicate<Project,UserIdentity> filteringPredicate)	Get the users from a group that are part of the project.
Map<JCRProjectMember,Object>	getJCRProjectMembers(Project project)	Get the list of users of the project
Map<String,Object>	getMemberModuleRights(String projectName)	Retrieves the rights for the current user in the project
Long	getMembersCount(Project project)	Count the total of unique users in the project and in the project's group
ProjectMemberManager.ProjectMember	getProjectMember(Project project, UserIdentity userIdentity)	Retrieve the member of a project corresponding to the user identity
ProjectMemberManager.ProjectMember	getProjectMember(Project project, UserIdentity userIdentity, Set<GroupIdentity> userGroups)	Retrieve the member of a project corresponding to the user identity
Map<String,Object>	getProjectMemberData(String projectName, String identity, String type)	Retrieve the data of a member of a project, or the default data if no user is provided
Map<String,Object>	getProjectMembers()	Get the members of current project or all the members of all projects in where is no current project
Map<String,Object>	getProjectMembers(String projectName, String lang)	Get the members of a project, sorted by managers, non empty role and name
Map<String,Object>	getProjectMembers(String projectName, String lang, boolean expandGroup)	Get the members of a project, sorted by managers, non empty role and name
Set<ProjectMemberManager.ProjectMember>	getProjectMembers(Project project, boolean expandGroup)	Get the members of a project, sorted by managers, non empty role and name
Set<ProjectMemberManager.ProjectMember>	getProjectMembers(Project project, boolean expandGroup, Set<ProjectMemberManager.ProjectMember> defaultSet)	Get the members of a project, sorted by managers, non empty role and name
Content	getUserContent(String lang, User user)	Get user content
protected Map<String,Object>	group2Json(Group group)	Get the JSON representation of a group
void	initialize()
boolean	isProjectMember(Project project, UserIdentity userIdentity)	Test if an user is a member of a project (directly or by a group)
Map<String,Object>	removeMember(String projectName, String identity, String type)	Remove a user from a project
void	service(ServiceManager manager)
void	setProfileOnModule(JCRProjectMember member, Project project, WorkspaceModule module, Set<String> allowedProfiles)	Affect profiles for a member on a given module
void	setProjectManager(String projectName, String profileId, List<UserIdentity> managers)	Set the manager of a project
Map<String,Object>	setProjectMemberData(String projectName, String identity, String type, Map<String,String> newProfiles, String role)	Set the user data in the project

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon Role

__WORKSPACES_SERVICE_MEMBERS

public static final String __WORKSPACES_SERVICE_MEMBERS

The id of the members service

See Also:

• Constant Field Values

_context

protected Context _context

Avalon context

_projectManager

protected ProjectManager _projectManager

Project manager

_projectRightHelper

protected ProjectRightHelper _projectRightHelper

Project rights helper

_rightProfilesDAO

protected RightProfilesDAO _rightProfilesDAO

Profiles right manager

_profileAssignmentStorageExtensionPoint

protected ProfileAssignmentStorageExtensionPoint _profileAssignmentStorageExtensionPoint

Profile assignment storage

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

_rightManager

protected RightManager _rightManager

Rights manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

Current user provider

_userManager

protected UserManager _userManager

Users manager

_observationManager

protected ObservationManager _observationManager

The observation manager

_moduleManagerEP

protected WorkspaceModuleExtensionPoint _moduleManagerEP

Module managers EP

_userHelper

protected UserHelper _userHelper

The user helper

_groupManager

protected GroupManager _groupManager

The groups manager

_populationContextHelper

protected PopulationContextHelper _populationContextHelper

The population context helper

_userDirectoryHelper

protected UserDirectoryHelper _userDirectoryHelper

The user directory helper

_projectInvitationHelper

protected ProjectInvitationHelper _projectInvitationHelper

The project invitation helper

_languagesManager

protected LanguagesManager _languagesManager

The language manager

_userDirectoryPageResolver

protected UserDirectoryPageResolver _userDirectoryPageResolver

The resolver for user directory pages

_uriResolver

protected URIResolverExtensionPoint _uriResolver

The page URI resolver.

_groupDirectoryContextHelper

protected GroupDirectoryContextHelper _groupDirectoryContextHelper

The group directory context helper

_abstractCacheManager

protected AbstractCacheManager _abstractCacheManager

The cache manager

_userSignupManager

protected UserSignupManager _userSignupManager

The user signup manager

Constructor Details

ProjectMemberManager

public ProjectMemberManager()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getProjectMemberData

public Map<String,Object> getProjectMemberData(String projectName,
 String identity,
 String type)

Retrieve the data of a member of a project, or the default data if no user is provided

Parameters:

projectName - The name of the project

identity - The user or group identity. If null, return the default profiles for a new user

type - The type of the identity. Can be "user" or "group"

Returns:

The map of profiles per module for the user

addMembers

public Map<String,Object> addMembers(String projectName,
 List<Map<String,String>> newMembers,
 List<String> invitEmails)

Add new members and invitation by email

Parameters:

projectName - The project name

newMembers - The members to add (users or groups)

invitEmails - The invitation emails

Returns:

the result with errors

addMember

public Map<String,Object> addMember(String projectName,
 String identity,
 String type)

Add a new member

Parameters:

projectName - The project name

identity - The user or group identity.

type - The type of the identity. Can be "user" or "group"

Returns:

the result

_getDefaultProfilesByModule

protected Map<String,String> _getDefaultProfilesByModule()

Get a map of each available module, with the default profile

Returns:

A map with moduleId : profileId

setProjectMemberData

public Map<String,Object> setProjectMemberData(String projectName,
 String identity,
 String type,
 Map<String,String> newProfiles,
 String role)

Set the user data in the project

Parameters:

projectName - The project name

identity - The user or group identity.

type - The type of the identity. Can be "user" or "group"

newProfiles - The profiles to affect, mapped by module

role - The user role inside the project

Returns:

The result

_setProjectMemberData

protected Map<String,Object> _setProjectMemberData(String projectName,
 String identity,
 String type,
 Map<String,String> newProfiles,
 String role,
 boolean isNewUser)

Set the user data in the project

Parameters:

projectName - The project name

identity - The user or group identity.

type - The type of the identity. Can be "user" or "group"

newProfiles - The profiles to affect, mapped by module

role - The user role inside the project

isNewUser - true if the user is just added

Returns:

The result

addProjectMember

public JCRProjectMember addProjectMember(Project project,
 UserIdentity user)

Add a user to a project with open inscriptions, using the default values

Parameters:

project - The project

user - The user

Returns:

the added member in case of success, null otherwise

addOrUpdateProjectMember

public JCRProjectMember addOrUpdateProjectMember(Project project,
 UserIdentity user,
 Map<String,String> allowedProfiles)

Add a user to a project, using the provided profile values

Parameters:

project - The project

user - The user

allowedProfiles - the profile values

Returns:

the added member in case of success, null otherwise

addOrUpdateProjectMember

public JCRProjectMember addOrUpdateProjectMember(Project project,
 UserIdentity user,
 Map<String,String> allowedProfiles,
 UserIdentity issuer)

Add a user to a project, using the provided profile values

Parameters:

project - The project

user - The user

allowedProfiles - the profile values

issuer - identity of the user that approved the member

Returns:

the added member in case of success, null otherwise

addOrUpdateProjectMember

public JCRProjectMember addOrUpdateProjectMember(Project project,
 GroupIdentity group,
 Map<String,String> allowedProfiles)

Add a group to a project, using the provided profile values

Parameters:

project - The project

group - The group

allowedProfiles - the profile values

Returns:

the added member in case of success, null otherwise

setProfileOnModule

public void setProfileOnModule(JCRProjectMember member,
 Project project,
 WorkspaceModule module,
 Set<String> allowedProfiles)

Affect profiles for a member on a given module

Parameters:

member - The member

project - The project

module - The module

allowedProfiles - The allowed profiles for the module

getCurrentUser

public Map<String,Object> getCurrentUser()

Get the current user information

Returns:

The user

getProjectMembers

public Map<String,Object> getProjectMembers()

Get the members of current project or all the members of all projects in where is no current project

Returns:

The members

getProjectMembers

public Map<String,Object> getProjectMembers(String projectName,
 String lang)
                                     throws IllegalAccessException,
AmetysRepositoryException

Get the members of a project, sorted by managers, non empty role and name

Parameters:

projectName - the project's name

lang - the language to get user content

Returns:

the members of project

Throws:

IllegalAccessException - if an error occurred

AmetysRepositoryException - if an error occurred

getProjectMembers

public Map<String,Object> getProjectMembers(String projectName,
 String lang,
 boolean expandGroup)
                                     throws AmetysRepositoryException

Get the members of a project, sorted by managers, non empty role and name

Parameters:

projectName - the project's name

lang - the language to get user content

expandGroup - true if groups are expanded

Returns:

the members of project

Throws:

AmetysRepositoryException - if an error occurred

getUserContent

public Content getUserContent(String lang,
 User user)

Get user content

Parameters:

lang - the lang

user - the user

Returns:

the user content or null if no exist

getProjectMembers

public Set<ProjectMemberManager.ProjectMember> getProjectMembers(Project project,
 boolean expandGroup)
                                                          throws AmetysRepositoryException

Get the members of a project, sorted by managers, non empty role and name

Parameters:

project - the project

expandGroup - true to expand the user of a group

Returns:

the members of project

Throws:

AmetysRepositoryException - if an error occurred

getProjectMembers

public Set<ProjectMemberManager.ProjectMember> getProjectMembers(Project project,
 boolean expandGroup,
 Set<ProjectMemberManager.ProjectMember> defaultSet)
                                                          throws AmetysRepositoryException

Get the members of a project, sorted by managers, non empty role and name

Parameters:

project - the project

expandGroup - true to expand the user of a group

defaultSet - default set to return when project has no site

Returns:

the members of project

Throws:

AmetysRepositoryException - if an error occurred

getMemberModuleRights

public Map<String,Object> getMemberModuleRights(String projectName)

Retrieves the rights for the current user in the project

Parameters:

projectName - The project Name

Returns:

The project

getJCRProjectMembers

public Map<JCRProjectMember,Object> getJCRProjectMembers(Project project)

Get the list of users of the project

Parameters:

project - The project

Returns:

The list of users

isProjectMember

public boolean isProjectMember(Project project,
 UserIdentity userIdentity)

Test if an user is a member of a project (directly or by a group)

Parameters:

project - The project

userIdentity - The user identity

Returns:

True if this user is a member of this project

getProjectMember

public ProjectMemberManager.ProjectMember getProjectMember(Project project,
 UserIdentity userIdentity)

Retrieve the member of a project corresponding to the user identity

Parameters:

project - The project

userIdentity - The user identity

Returns:

The member of this project, which can be of type "user" or "group", or null if the user is not in the project

getProjectMember

public ProjectMemberManager.ProjectMember getProjectMember(Project project,
 UserIdentity userIdentity,
 Set<GroupIdentity> userGroups)

Retrieve the member of a project corresponding to the user identity

Parameters:

project - The project

userIdentity - The user identity

userGroups - The user groups. If null the user's groups will be expanded.

Returns:

The member of this project, which can be of type "user" or "group", or null if the user is not in the project

setProjectManager

public void setProjectManager(String projectName,
 String profileId,
 List<UserIdentity> managers)

Set the manager of a project

Parameters:

projectName - The project name

profileId - The profile id to affect

managers - The managers' user identity

_getOrCreateJCRProjectMember

protected JCRProjectMember _getOrCreateJCRProjectMember(Project project,
 Predicate<? super AmetysObject> findMemberPredicate)

Retrieve or create a member in a project

Parameters:

project - The project

findMemberPredicate - The predicate to find the member node

Returns:

The member node. A new node is created if the member node was not found

removeMember

public Map<String,Object> removeMember(String projectName,
 String identity,
 String type)

Remove a user from a project

Parameters:

projectName - The project name

identity - The identity of the user or group, who must be a member of the project

type - The type of the member, user or group

Returns:

The error code, if an error occurred

_getProjectMembersNode

protected ModifiableTraversableAmetysObject _getProjectMembersNode(Project project)

Retrieves the users node of the project The users node will be created if necessary

Parameters:

project - The project

Returns:

The users node of the project

group2Json

protected Map<String,Object> group2Json(Group group)

Get the JSON representation of a group

Parameters:

group - The group

Returns:

The group

getMembersCount

public Long getMembersCount(Project project)

Count the total of unique users in the project and in the project's group

Parameters:

project - The project

Returns:

The total of members

getGroupUsersFromProject

public List<User> getGroupUsersFromProject(Group group,
 Project project,
 BiPredicate<Project,UserIdentity> filteringPredicate)

Get the users from a group that are part of the project. They can be filtered with a predicate

Parameters:

group - The group

project - The project

filteringPredicate - The predicate to filter

Returns:

The list of users