org.ametys.plugins.workspaces.project.rights

Class ProjectRightHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.project.rights.ProjectRightHelper

All Implemented Interfaces:

LogEnabled, PluginAware, Component, Serviceable

public class ProjectRightHelper
extends AbstractLogEnabled
implements Serviceable, Component, PluginAware

Helper related to rights management for projects.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__PROJECT_RIGHT_PROFILE
private static String	__RIGHT_ADD_MEMBER Project Right to add a member to a project
private static String	__RIGHT_ADD_PLACE Right to add a place
private static String	__RIGHT_ADD_TAG Right to add a tag
private static String	__RIGHT_DELETE_PLACE Right to delete a place
private static String	__RIGHT_DELETE_TAG Right to delete a tag
private static String	__RIGHT_REMOVE_MEMBER Project Right to remove a member from the project
protected CurrentUserProvider	_currentUserProvider Current user provider
protected WorkspaceModuleExtensionPoint	_moduleManagerEP Module managers EP
private String	_pluginName
private ProfileAssignmentStorageExtensionPoint	_profileAssignmentStorageEP The profile storage
protected ProjectManager	_projectManager Project manager
protected AmetysObjectResolver	_resolver Ametys object resolver
protected RightManager	_rightManager Right manager
protected RightProfilesDAO	_rightProfilesDao Right profiles manager
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
ProjectRightHelper()

Method Summary

Modifier and Type	Method and Description
private Map<String,Object>	_getModuleRightData(Project project, WorkspaceModule module)
private Map<String,Object>	_getProfileRightData(Profile profile)
private Map<String,Object>	_getProjectRightData()
private boolean	_hasRightOnMembers(Project project, String rightId)
private boolean	_hasRightOnTagsOrPlaces(Project project, String rightId)
boolean	canAddMember(Project project) Determines if the current user has right to add member on project
boolean	canAddPlace(Project project) Determines if the current user has right to add places on project
boolean	canAddTag(Project project) Determines if the current user has right to add tags on project
boolean	canEditMember(Project project) Determines if the current user has right to edit member on project
boolean	canRemoveMember(Project project) Determines if the current user has right to add member on project
boolean	canRemovePlace(Project project) Determines if the current user has right to remove places on project
boolean	canRemoveTag(Project project) Determines if the current user has right to remove tags on project
boolean	canViewMembers(Project project) Determines if the current user can view the members of a project
String	getAllowedProfileOnModule(Project project, WorkspaceModule module, JCRProjectMember member) Get the first allowed profile on project's module for a given member
String	getAllowedProfileOnProject(Project project, JCRProjectMember member) Get the first allowed profile on project for a given member
List<Profile>	getProfileList() Retrieves all project profile given the "profile list" configuration parameter Profile order is guaranteed to be the same as in the configuration parameter.
Map<String,Object>	getProjectRightsData(String projectName) Get the list of profiles and the list of modules available for rights affectation in the project.
Map<String,Object>	getProjectRightsData(String projectName, boolean includeAllModules) Get the list of profiles and the list of modules available for rights affectation in the project.
boolean	hasReadAccess(ExplorerNode explorerNode) Test if the current user has a read access on an explorer node
boolean	hasReadAccess(Project project) Test if the current user has a read access on the project
boolean	hasReadAccess(Resource resource) Test if the current user has a read access on a resource
boolean	hasReadAccessOnExplorerNode(String explorerNodeId) Test if the current user has a read access on an explorer node
boolean	hasReadAccessOnProject(String projectId) Test if the current user has a read access on the project
boolean	hasRight(String rightId, ExplorerNode explorerNode) Test if the current user has the right on an explorer node
boolean	hasRight(String rightId, Project project) Test if the current user has the right on the project
boolean	hasRightOnExplorerNode(String rightId, String explorerNodeId) Test if the current user has the right on an explorer node
boolean	hasRightOnProject(String rightId, String projectId) Test if the current user has the right on the project
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

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

__PROJECT_RIGHT_PROFILE

@Obsolete
private static final String __PROJECT_RIGHT_PROFILE

See Also:

Constant Field Values

__RIGHT_ADD_MEMBER

private static final String __RIGHT_ADD_MEMBER

Project Right to add a member to a project

See Also:

Constant Field Values

__RIGHT_REMOVE_MEMBER

private static final String __RIGHT_REMOVE_MEMBER

Project Right to remove a member from the project

See Also:

Constant Field Values

__RIGHT_ADD_TAG

private static final String __RIGHT_ADD_TAG

Right to add a tag

See Also:

Constant Field Values

__RIGHT_DELETE_TAG

private static final String __RIGHT_DELETE_TAG

Right to delete a tag

See Also:

Constant Field Values

__RIGHT_ADD_PLACE

private static final String __RIGHT_ADD_PLACE

Right to add a place

See Also:

Constant Field Values

__RIGHT_DELETE_PLACE

private static final String __RIGHT_DELETE_PLACE

Right to delete a place

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

_projectManager

protected ProjectManager _projectManager

Project manager

_rightManager

protected RightManager _rightManager

Right manager

_rightProfilesDao

protected RightProfilesDAO _rightProfilesDao

Right profiles manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

Current user provider

_moduleManagerEP

protected WorkspaceModuleExtensionPoint _moduleManagerEP

Module managers EP

_profileAssignmentStorageEP

private ProfileAssignmentStorageExtensionPoint _profileAssignmentStorageEP

The profile storage

_pluginName

private String _pluginName

Constructor Detail

ProjectRightHelper

public ProjectRightHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getProfileList

public List<Profile> getProfileList()

Retrieves all project profile given the "profile list" configuration parameter Profile order is guaranteed to be the same as in the configuration parameter.

Returns:

the projects

getAllowedProfileOnProject

@Obsolete
public String getAllowedProfileOnProject(Project project,
                                                   JCRProjectMember member)

Get the first allowed profile on project for a given member

Parameters:

project - the project

member - the member

Returns:

the first allowed profile or null if not found

getAllowedProfileOnModule

public String getAllowedProfileOnModule(Project project,
                                        WorkspaceModule module,
                                        JCRProjectMember member)

Get the first allowed profile on project's module for a given member

Parameters:

project - the project

module - The workspace module

member - the member

Returns:

the first allowed profile or null if not found

getProjectRightsData

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

Get the list of profiles and the list of modules available for rights affectation in the project.

Parameters:

projectName - The project to check if the modules are activated. Can be null to ignore

Returns:

the project rights data

getProjectRightsData

@Obsolete
public Map<String,Object> getProjectRightsData(String projectName,
                                                         boolean includeAllModules)

Get the list of profiles and the list of modules available for rights affectation in the project.

Parameters:

projectName - The project to check if the modules are activated. Can be null to ignore

includeAllModules - True to include modules not manager by the WorkspaceModuleManagerExtensionPoint

Returns:

the project rights data

_getProfileRightData

private Map<String,Object> _getProfileRightData(Profile profile)

_getModuleRightData

private Map<String,Object> _getModuleRightData(Project project,
                                               WorkspaceModule module)

_getProjectRightData

@Obsolete
private Map<String,Object> _getProjectRightData()

canViewMembers

public boolean canViewMembers(Project project)

Determines if the current user can view the members of a project

Parameters:

project - the project

Returns:

true if user can view members

canAddMember

public boolean canAddMember(Project project)

Determines if the current user has right to add member on project

Parameters:

project - the project

Returns:

true if user can add member

canEditMember

public boolean canEditMember(Project project)

Determines if the current user has right to edit member on project

Parameters:

project - the project

Returns:

true if user can edit member

canRemoveMember

public boolean canRemoveMember(Project project)

Determines if the current user has right to add member on project

Parameters:

project - the project

Returns:

true if user can remove member

_hasRightOnMembers

private boolean _hasRightOnMembers(Project project,
                                   String rightId)

canAddTag

public boolean canAddTag(Project project)

Determines if the current user has right to add tags on project

Parameters:

project - the project

Returns:

true if user can add tags

canRemoveTag

public boolean canRemoveTag(Project project)

Determines if the current user has right to remove tags on project

Parameters:

project - the project

Returns:

true if user can remove tags

canAddPlace

public boolean canAddPlace(Project project)

Determines if the current user has right to add places on project

Parameters:

project - the project

Returns:

true if user can add places

canRemovePlace

public boolean canRemovePlace(Project project)

Determines if the current user has right to remove places on project

Parameters:

project - the project

Returns:

true if user can remove places

_hasRightOnTagsOrPlaces

private boolean _hasRightOnTagsOrPlaces(Project project,
                                        String rightId)

hasRightOnProject

public boolean hasRightOnProject(String rightId,
                                 String projectId)

Test if the current user has the right on the project

Parameters:

rightId - The right id

projectId - The project id

Returns:

true if has right

hasRight

public boolean hasRight(String rightId,
                        Project project)

Test if the current user has the right on the project

Parameters:

rightId - The right id

project - The project

Returns:

true if has right

hasReadAccessOnProject

public boolean hasReadAccessOnProject(String projectId)

Test if the current user has a read access on the project

Parameters:

projectId - The project id

Returns:

true if has read access

hasReadAccess

public boolean hasReadAccess(Project project)

Test if the current user has a read access on the project

Parameters:

project - The project

Returns:

true if has read access

hasRightOnExplorerNode

public boolean hasRightOnExplorerNode(String rightId,
                                      String explorerNodeId)

Test if the current user has the right on an explorer node

Parameters:

rightId - The right id

explorerNodeId - The explorer node id

Returns:

true if has right

hasRight

public boolean hasRight(String rightId,
                        ExplorerNode explorerNode)

Test if the current user has the right on an explorer node

Parameters:

rightId - The right id

explorerNode - The explorer node

Returns:

true if has right

hasReadAccessOnExplorerNode

public boolean hasReadAccessOnExplorerNode(String explorerNodeId)

Test if the current user has a read access on an explorer node

Parameters:

explorerNodeId - The explorer node id

Returns:

true if has read access

hasReadAccess

public boolean hasReadAccess(ExplorerNode explorerNode)

Test if the current user has a read access on an explorer node

Parameters:

explorerNode - The explorer node

Returns:

true if has read access

hasReadAccess

public boolean hasReadAccess(Resource resource)

Test if the current user has a read access on a resource

Parameters:

resource - The resource

Returns:

true if has read access