org.ametys.plugins.workspaces.project

Class ProjectsCatalogueManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.workspaces.project.ProjectsCatalogueManager

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable

public class ProjectsCatalogueManager
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable

Manager for the Projects Catalogue service

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__RIGHT_PROJECT_CREATE
private static String	__RIGHT_PROJECT_DELETE
private static String	__RIGHT_PROJECT_EDIT
private static String	__RIGHT_PROJECT_FO_CREATE
private static String	__RIGHT_PROJECT_FO_DELETE
private static String	__RIGHT_PROJECT_FO_EDIT
private Context	_context
private CurrentUserProvider	_currentUserProvider
private GroupDirectoryContextHelper	_groupDirectoryContextHelper
private I18nUtils	_i18nUtils
private LanguagesManager	_languagesManager
private WorkspaceModuleExtensionPoint	_moduleManagerEP
private ObservationManager	_observationManager
private PopulationContextHelper	_populationContextHelper
private ProfileAssignmentStorageExtensionPoint	_profileAssignmentStorageExtensionPoint
private ProjectManager	_projectManager
private ProjectMemberManager	_projectMemberManager
private ProjectRightHelper	_projectRightHelper
private AmetysObjectResolver	_resolver
private RightManager	_rightManager
private SiteConfigurationExtensionPoint	_siteConfiguration
private SiteConfigurationExtensionPoint	_siteConfigurationEP
private SiteDAO	_siteDAO
private SourceResolver	_sourceResolver
private UserManager	_userManager
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
ProjectsCatalogueManager()

Method Summary

Modifier and Type	Method and Description
private void	_assignPopulationsAndManager(Project project, Map<String,Object> formData)
private Project	_createProject(String parentId, Map<String,Object> formData, CompositeMetadata serviceParameters, Map<String,Object> siteConfiguration, List<String> errors)
private Map<String,Object>	_getNewSiteConfiguration(Map<String,Object> formData, CompositeMetadata serviceParameters)
private Map<String,Object>	_getProjectParameters(String projectId, CompositeMetadata serviceParameters)
private Map<String,Object>	_getSiteConfiguration(String siteName)
private Map<String,Object>	_node2Json(Object treeNode, boolean includeProjects, List<String> filterCategories)
private void	_sendAskToJoinMail(String message, Project project, UserIdentity joiningUser)
private void	_setProjectIllustration(Project project, Map<String,Object> formData, Part illustration)
private void	_updateCategory(Project project, Map<String,Object> formData)
private void	_updateModules(Project project, Map<String,Object> formData)
private void	_updateProject(Project project, Map<String,Object> formData, CompositeMetadata serviceParameters)
private void	_updateSiteConfiguration(Project project, Map<String,Object> formData, CompositeMetadata serviceParameters, List<String> errors)
Map<String,Object>	askToJoinProject(String projectId, String message) Send a demand to join a project to the project's manager, if the project's inscriptions are moderated
void	contextualize(Context context)
Map<String,Object>	createProject(Map<String,Object> formData, String zoneItemId) Create a new project
Map<String,Object>	createProject(Part illustration, Map<String,Object> formData, String zoneItemId) Create a new project
Map<String,Object>	deleteProject(String projectId) Delete a project
Map<String,Object>	editProject(Part illustration, String projectId, Map<String,Object> formData, String zoneItemId) edit a project
Map<String,Object>	editProject(String projectId, Map<String,Object> formData, String zoneItemId) edit a project
List<Map<String,Object>>	getCategoriesTree(String id) Get the categories tree
Map<String,Object>	getNewProjectData(String zoneItemId) Retrieve the data required to create a new project
Map<String,Object>	getProjectData(String projectId, String zoneItemId) Retrieve the data of a project to edit, or the data for a new project
List<Map<String,Object>>	getProjectTreeNode(String id, boolean includeProjects) Get the node information of a specific project or category from the project tree
List<Map<String,Object>>	getProjectTreeNode(String id, boolean includeProjects, boolean memberOnly) Get the node information of a specific project or category from the project tree
List<Map<String,Object>>	getProjectTreeNode(String id, boolean includeProjects, boolean memberOnly, List<String> filterCategories) Get the node information of a specific project or category from the project tree
List<Map<String,Object>>	getProjectTreeNode(String id, String zoneItemId, boolean includeProjects) Get the node information of a specific project or category from the project tree
Map<String,Object>	getRights() Get the rights to create, edit or delete projects, for the current user
Map<String,Object>	joinProject(String projectId) Add the current user to the project, if the project's inscriptions are opened
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

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

__RIGHT_PROJECT_CREATE

private static final String __RIGHT_PROJECT_CREATE

See Also:

Constant Field Values

__RIGHT_PROJECT_EDIT

private static final String __RIGHT_PROJECT_EDIT

See Also:

Constant Field Values

__RIGHT_PROJECT_DELETE

private static final String __RIGHT_PROJECT_DELETE

See Also:

Constant Field Values

__RIGHT_PROJECT_FO_CREATE

private static final String __RIGHT_PROJECT_FO_CREATE

See Also:

Constant Field Values

__RIGHT_PROJECT_FO_EDIT

private static final String __RIGHT_PROJECT_FO_EDIT

See Also:

Constant Field Values

__RIGHT_PROJECT_FO_DELETE

private static final String __RIGHT_PROJECT_FO_DELETE

See Also:

Constant Field Values

_rightManager

private RightManager _rightManager

_projectManager

private ProjectManager _projectManager

_projectMemberManager

private ProjectMemberManager _projectMemberManager

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_projectRightHelper

private ProjectRightHelper _projectRightHelper

_resolver

private AmetysObjectResolver _resolver

_languagesManager

private LanguagesManager _languagesManager

_sourceResolver

private SourceResolver _sourceResolver

_siteDAO

private SiteDAO _siteDAO

_siteConfigurationEP

private SiteConfigurationExtensionPoint _siteConfigurationEP

_context

private Context _context

_populationContextHelper

private PopulationContextHelper _populationContextHelper

_moduleManagerEP

private WorkspaceModuleExtensionPoint _moduleManagerEP

_siteConfiguration

private SiteConfigurationExtensionPoint _siteConfiguration

_profileAssignmentStorageExtensionPoint

private ProfileAssignmentStorageExtensionPoint _profileAssignmentStorageExtensionPoint

_userManager

private UserManager _userManager

_i18nUtils

private I18nUtils _i18nUtils

_observationManager

private ObservationManager _observationManager

_groupDirectoryContextHelper

private GroupDirectoryContextHelper _groupDirectoryContextHelper

Constructor Detail

ProjectsCatalogueManager

public ProjectsCatalogueManager()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getRights

public Map<String,Object> getRights()

Get the rights to create, edit or delete projects, for the current user

Returns:

The map of rights for the current user

getCategoriesTree

public List<Map<String,Object>> getCategoriesTree(String id)

Get the categories tree

Parameters:

id - The tree root. Can be null

Returns:

The tree data

getProjectTreeNode

public List<Map<String,Object>> getProjectTreeNode(String id,
                                                   boolean includeProjects)

Get the node information of a specific project or category from the project tree

Parameters:

id - The category or project id

includeProjects - False to only get the categories tree

Returns:

The node informations

getProjectTreeNode

public List<Map<String,Object>> getProjectTreeNode(String id,
                                                   String zoneItemId,
                                                   boolean includeProjects)

Get the node information of a specific project or category from the project tree

Parameters:

id - The category or project id

zoneItemId - The zone item of the project catalogue

includeProjects - False to only get the categories tree

Returns:

The node informations

getProjectTreeNode

public List<Map<String,Object>> getProjectTreeNode(String id,
                                                   boolean includeProjects,
                                                   boolean memberOnly)

Get the node information of a specific project or category from the project tree

Parameters:

id - The category or project id

includeProjects - False to only get the categories tree

memberOnly - Only return projects for which the current user is a member

Returns:

The node informations

getProjectTreeNode

public List<Map<String,Object>> getProjectTreeNode(String id,
                                                   boolean includeProjects,
                                                   boolean memberOnly,
                                                   List<String> filterCategories)

Get the node information of a specific project or category from the project tree

Parameters:

id - The category or project id

includeProjects - False to only get the categories tree

memberOnly - Only return projects for which the current user is a member

filterCategories - The list of categories to filter. Can be null to ignore

Returns:

The node informations

_node2Json

private Map<String,Object> _node2Json(Object treeNode,
                                      boolean includeProjects,
                                      List<String> filterCategories)

getNewProjectData

public Map<String,Object> getNewProjectData(String zoneItemId)

Retrieve the data required to create a new project

Parameters:

zoneItemId - The zone item of the project catalogue

Returns:

The new project data

getProjectData

public Map<String,Object> getProjectData(String projectId,
                                         String zoneItemId)

Retrieve the data of a project to edit, or the data for a new project

Parameters:

projectId - The project id. Can be null.

zoneItemId - The zone item of the project catalog

Returns:

The project data

_getProjectParameters

private Map<String,Object> _getProjectParameters(String projectId,
                                                 CompositeMetadata serviceParameters)

createProject

public Map<String,Object> createProject(Map<String,Object> formData,
                                        String zoneItemId)
                                 throws IllegalAccessException,
                                        AmetysRepositoryException,
                                        IOException

Create a new project

Parameters:

formData - The project data

zoneItemId - The zone item of the project catalogue

Returns:

The result

Throws:

IllegalAccessException - If an error occurred

IOException - If an error occurred

AmetysRepositoryException - If an error occurred

createProject

public Map<String,Object> createProject(Part illustration,
                                        Map<String,Object> formData,
                                        String zoneItemId)
                                 throws IllegalAccessException,
                                        AmetysRepositoryException,
                                        IOException

Create a new project

Parameters:

illustration - The project illustration file. Can be null

formData - The project data

zoneItemId - The zone item of the project catalogue

Returns:

The result

Throws:

IllegalAccessException - If an error occurred

IOException - If an error occurred

AmetysRepositoryException - If an error occurred

_getNewSiteConfiguration

private Map<String,Object> _getNewSiteConfiguration(Map<String,Object> formData,
                                                    CompositeMetadata serviceParameters)

_createProject

private Project _createProject(String parentId,
                               Map<String,Object> formData,
                               CompositeMetadata serviceParameters,
                               Map<String,Object> siteConfiguration,
                               List<String> errors)

_assignPopulationsAndManager

private void _assignPopulationsAndManager(Project project,
                                          Map<String,Object> formData)

editProject

public Map<String,Object> editProject(String projectId,
                                      Map<String,Object> formData,
                                      String zoneItemId)
                               throws IllegalAccessException,
                                      AmetysRepositoryException,
                                      RepositoryException,
                                      IOException

edit a project

Parameters:

projectId - the project id

formData - The project data

zoneItemId - The zone item of the project catalogue

Returns:

The result

Throws:

IllegalAccessException - If an error occurred

RepositoryException - If an error occurred

AmetysRepositoryException - If an error occurred

IOException - If an error occurred

editProject

public Map<String,Object> editProject(Part illustration,
                                      String projectId,
                                      Map<String,Object> formData,
                                      String zoneItemId)
                               throws IllegalAccessException,
                                      AmetysRepositoryException,
                                      RepositoryException,
                                      IOException

edit a project

Parameters:

illustration - The project illustration file. Can be null

projectId - the project id

formData - The project data

zoneItemId - The zone item of the project catalogue

Returns:

The result

Throws:

IllegalAccessException - If an error occurred

RepositoryException - If an error occurred

AmetysRepositoryException - If an error occurred

IOException - If an error occurred

_updateProject

private void _updateProject(Project project,
                            Map<String,Object> formData,
                            CompositeMetadata serviceParameters)

_updateSiteConfiguration

private void _updateSiteConfiguration(Project project,
                                      Map<String,Object> formData,
                                      CompositeMetadata serviceParameters,
                                      List<String> errors)

_getSiteConfiguration

private Map<String,Object> _getSiteConfiguration(String siteName)

_updateCategory

private void _updateCategory(Project project,
                             Map<String,Object> formData)
                      throws AmetysRepositoryException,
                             RepositoryException

Throws:

AmetysRepositoryException

RepositoryException

_updateModules

private void _updateModules(Project project,
                            Map<String,Object> formData)

_setProjectIllustration

private void _setProjectIllustration(Project project,
                                     Map<String,Object> formData,
                                     Part illustration)
                              throws AmetysRepositoryException,
                                     IOException

Throws:

AmetysRepositoryException

IOException

deleteProject

public Map<String,Object> deleteProject(String projectId)
                                 throws IllegalAccessException

Delete a project

Parameters:

projectId - The project id

Returns:

The result

Throws:

IllegalAccessException - if an error occurred

joinProject

public Map<String,Object> joinProject(String projectId)
                               throws javax.mail.MessagingException

Add the current user to the project, if the project's inscriptions are opened

Parameters:

projectId - The project id

Returns:

The result

Throws:

javax.mail.MessagingException - If an error occurred sending a notification mail to the project manager

askToJoinProject

public Map<String,Object> askToJoinProject(String projectId,
                                           String message)
                                    throws javax.mail.MessagingException

Send a demand to join a project to the project's manager, if the project's inscriptions are moderated

Parameters:

projectId - The project to join

message - A message to send to the project's manager.

Returns:

The result

Throws:

javax.mail.MessagingException - If an error occurred sending the email to the project's manager

_sendAskToJoinMail

private void _sendAskToJoinMail(String message,
                                Project project,
                                UserIdentity joiningUser)
                         throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException