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, Component, Contextualizable, Serviceable

public class ProjectMemberManager
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable

Helper component for managing project's users

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__PROJECT_MEMBER_NODE_TYPE The type of a project user node type
private static String	__PROJECT_MEMBERS_NODE Constants for users project node
private static String	__PROJECT_MEMBERS_NODE_TYPE The type of the project users node type
private static String	__PROJECT_RIGHT_PROFILE
private static String	__RIGHTS_ADD_MEMBER_TO_PROJECT Project Right to add a member to a project
private static String	__RIGHTS_REMOVE_MEMBER_TO_PROJECT Project Right to remove a member from the project
static String	__WORKSPACES_SERVICE_MEMBERS The id of the members service
protected Context	_context Avalon context
protected CurrentUserProvider	_currentUserProvider Current user provider
protected GroupManager	_groupManager The groups manager
protected WorkspaceModuleExtensionPoint	_moduleManagerEP Module managers EP
protected ObservationManager	_observationManager The observation manager
private PopulationContextHelper	_populationContextHelper
protected ProfileAssignmentStorageExtensionPoint	_profileAssignmentStorageExtensionPoint Profile assignment storage
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 UserHelper	_userHelper The user helper
protected UserManager	_userManager Users manager
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
ProjectMemberManager()

Method Summary

Modifier and Type	Method and Description
private void	_allowReadAccessOnProjectDashboard(JCRProjectMember member, Project project)
private Map<String,String>	_getMemberProfiles(JCRProjectMember member, Project project)
protected JCRProjectMember	_getOrCreateProjectMember(Project project, Predicate<? super AmetysObject> findMemberPredicate) Retrieve or create a member in a project
private List<ModifiablePage>	_getProjectDashboardPages(Project project)
private JCRProjectMember	_getProjectMember(Project project, GroupIdentity group)
private JCRProjectMember	_getProjectMember(Project project, UserIdentity user)
protected ModifiableTraversableAmetysObject	_getProjectMembersNode(Project project) Retrieves the users node of the project The users node will be created if necessary
private void	_notifyAclUpdated(UserIdentity userIdentity, AmetysObject aclContext, Collection<String> aclProfiles)
private void	_removeManagerRights(Project project, UserIdentity userIdentity)
private void	_removeMemberProfiles(JCRProjectMember member, AmetysObject object)
private void	_removeMemberProfiles(JCRProjectMember member, List<Profile> projectProfiles, AmetysObject object, Set<String> updatedProfiles, Set<String> currentAllowedProfiles)
private void	_removeMemberProfiles(Project project, JCRProjectMember projectMember)
private void	_removeReadAccessOnProjectDashboard(JCRProjectMember member, Project project)
private void	_setMemberProfiles(JCRProjectMember member, List<Profile> projectProfiles, List<String> allowedProfiles, AmetysObject object)
private void	_setMemberProfiles(JCRProjectMember member, List<Profile> projectProfiles, List<String> allowedProfiles, AmetysObject object, Set<String> updatedProfiles, Set<String> currentAllowedProfiles)
private void	_setMemberProfiles(Map<String,String> newProfiles, JCRProjectMember projectMember, Project project, boolean newMember)
private void	_updateReadAccessOnModulePage(JCRProjectMember member, Page modulePage, boolean allowed)
boolean	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
Map<String,Object>	getMemberModuleRights(String projectName) Retrieves the rights for the current user in the project
JCRProjectMember	getOrCreateProjectMember(Project project, GroupIdentity groupIdentity) Retrieve or create a group as a member in a project
JCRProjectMember	getOrCreateProjectMember(Project project, UserIdentity userIdentity) Retrieve or create a user in a project
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
Set<JCRProjectMember>	getProjectMembers(Project project) Get the list of users of the project
Map<String,Object>	getProjectMembers(String projectName) Get the list of users of the project
protected Map<String,Object>	group2Json(Group group) Get the JSON representation of a group
boolean	isProjectMember(Project project, UserIdentity userIdentity) Test if an user is a member of a project
Map<String,Object>	removeMember(String projectName, String identity, String type) Remove a user from a project
void	service(ServiceManager manager)
void	setProjectManager(String projectName, String profileId, UserIdentity userIdentity) 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 Detail

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

__PROJECT_MEMBERS_NODE

private static final String __PROJECT_MEMBERS_NODE

Constants for users project node

See Also:

Constant Field Values

__PROJECT_MEMBERS_NODE_TYPE

private static final String __PROJECT_MEMBERS_NODE_TYPE

The type of the project users node type

See Also:

Constant Field Values

__PROJECT_MEMBER_NODE_TYPE

private static final String __PROJECT_MEMBER_NODE_TYPE

The type of a project user node type

See Also:

Constant Field Values

__RIGHTS_ADD_MEMBER_TO_PROJECT

private static final String __RIGHTS_ADD_MEMBER_TO_PROJECT

Project Right to add a member to a project

See Also:

Constant Field Values

__RIGHTS_REMOVE_MEMBER_TO_PROJECT

private static final String __RIGHTS_REMOVE_MEMBER_TO_PROJECT

Project Right to remove a member from the project

See Also:

Constant Field Values

__PROJECT_RIGHT_PROFILE

private static final String __PROJECT_RIGHT_PROFILE

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

private PopulationContextHelper _populationContextHelper

Constructor Detail

ProjectMemberManager

public ProjectMemberManager()

Method Detail

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

getProjectMemberData

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

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

Throws:

IllegalAccessException - If the user cannot execute this operation

_getMemberProfiles

private Map<String,String> _getMemberProfiles(JCRProjectMember member,
                                              Project project)

setProjectMemberData

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

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

Throws:

IllegalAccessException - If the user cannot execute this operation

addProjectMember

public boolean 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:

True if the user was successfully added

_setMemberProfiles

private void _setMemberProfiles(Map<String,String> newProfiles,
                                JCRProjectMember projectMember,
                                Project project,
                                boolean newMember)

_setMemberProfiles

private void _setMemberProfiles(JCRProjectMember member,
                                List<Profile> projectProfiles,
                                List<String> allowedProfiles,
                                AmetysObject object)

_setMemberProfiles

private void _setMemberProfiles(JCRProjectMember member,
                                List<Profile> projectProfiles,
                                List<String> allowedProfiles,
                                AmetysObject object,
                                Set<String> updatedProfiles,
                                Set<String> currentAllowedProfiles)

_removeMemberProfiles

private void _removeMemberProfiles(JCRProjectMember member,
                                   List<Profile> projectProfiles,
                                   AmetysObject object,
                                   Set<String> updatedProfiles,
                                   Set<String> currentAllowedProfiles)

_allowReadAccessOnProjectDashboard

private void _allowReadAccessOnProjectDashboard(JCRProjectMember member,
                                                Project project)

_getProjectDashboardPages

private List<ModifiablePage> _getProjectDashboardPages(Project project)

_removeReadAccessOnProjectDashboard

private void _removeReadAccessOnProjectDashboard(JCRProjectMember member,
                                                 Project project)

_updateReadAccessOnModulePage

private void _updateReadAccessOnModulePage(JCRProjectMember member,
                                           Page modulePage,
                                           boolean allowed)

_removeMemberProfiles

private void _removeMemberProfiles(JCRProjectMember member,
                                   AmetysObject object)

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)
                                     throws IllegalAccessException,
                                            AmetysRepositoryException

Get the list of users of the project

Parameters:

projectName - The project name

Returns:

The list of users

Throws:

AmetysRepositoryException - If an error occurred

IllegalAccessException - 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

getProjectMembers

public Set<JCRProjectMember> getProjectMembers(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

Parameters:

project - The project

userIdentity - The user identity

Returns:

True if this user is a member of this project

setProjectManager

public void setProjectManager(String projectName,
                              String profileId,
                              UserIdentity userIdentity)

Set the manager of a project

Parameters:

projectName - The project name

profileId - The profile id to affect

userIdentity - The user

_removeManagerRights

private void _removeManagerRights(Project project,
                                  UserIdentity userIdentity)

_notifyAclUpdated

private void _notifyAclUpdated(UserIdentity userIdentity,
                               AmetysObject aclContext,
                               Collection<String> aclProfiles)

getOrCreateProjectMember

public JCRProjectMember getOrCreateProjectMember(Project project,
                                                 UserIdentity userIdentity)

Retrieve or create a user in a project

Parameters:

project - The project

userIdentity - the user

Returns:

The user

getOrCreateProjectMember

public JCRProjectMember getOrCreateProjectMember(Project project,
                                                 GroupIdentity groupIdentity)

Retrieve or create a group as a member in a project

Parameters:

project - The project

groupIdentity - the group

Returns:

The user

_getOrCreateProjectMember

protected JCRProjectMember _getOrCreateProjectMember(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)
                                throws IllegalAccessException

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

Throws:

IllegalAccessException - If the user cannot execute this operation

_getProjectMember

private JCRProjectMember _getProjectMember(Project project,
                                           GroupIdentity group)

_getProjectMember

private JCRProjectMember _getProjectMember(Project project,
                                           UserIdentity user)

_removeMemberProfiles

private void _removeMemberProfiles(Project project,
                                   JCRProjectMember projectMember)

_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