org.ametys.plugins.workspaces.project

Class ProjectManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.workspaces.project.ProjectManager

All Implemented Interfaces:

PluginAware, Component, Contextualizable, LogEnabled, Serviceable

public class ProjectManager
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable, PluginAware

Helper component for managing project workspaces

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__PROJECTS_PLACES_PROPERTY Constants for places metadata
private static String	__PROJECTS_ROOT_NODE_NAME The name of the projects root node
private static String	__PROJECTS_ROOT_NODE_TYPE The type of the projects root node
private static String	__PROJECTS_TAGS_PROPERTY Constants for tags metadata
private static String	__WORKSPACES_PLUGIN_NODE_NAME Workspaces plugin node name
private static String	__WORKSPACES_PLUGIN_NODE_TYPE Workspaces plugin node name
protected Context	_context Avalon context
private CurrentUserProvider	_currentUserProvider
protected I18nUtils	_i18nUtils The i18n utils.
protected WorkspaceModuleExtensionPoint	_moduleManagerEP Module Managers EP
private ObservationManager	_observationManager
private String	_pluginName
private ProjectMemberManager	_projectMemberManager
private ProjectMemberManager	_projectMembers
private ProjectRightHelper	_projectRightHelper
protected AmetysObjectResolver	_resolver Ametys object resolver
protected SiteConfigurationExtensionPoint	_siteConfiguration Site configuration EP
protected SiteDAO	_siteDao Site DAO
protected SiteManager	_siteManager Site manager
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
ProjectManager()

Method Summary

Modifier and Type	Method and Description
protected Site	_createProjectWorkspace(Project project, List<String> errors) Create the project workspace for a given project.
private List<Object>	_filterProjectTree(List<Object> projectTree, Map<String,Object> filters, String categoryId, int depth, int maxDepth)
private List<Object>	_filterProjectTreeCategory(Map<String,Object> categoryData, List<Object> filteredProjectTree, Map<String,Object> filters, boolean isCategoryInFilters, int depth, int maxDepth)
private <A extends AmetysObject> A	_getOrCreateObject(ModifiableTraversableAmetysObject parent, String name, String type) Utility method to get or create an ametys object
private Set<String>	_getProjectNonEmptyElements(Project project, Function<? super Site,? extends String> function)
private void	_projectTreeAccumulator(List<Map<String,Object>> projectTree, AmetysObject node, int depth, int maxDepth, boolean includeProjects, boolean memberOnly)
private void	_projectTreeNodeAccumulator(List<Object> projectTree, AmetysObject node, int depth, int maxDepth, boolean includeProjects, boolean memberOnly)
private void	_removeDescendants(AmetysObject object, List<Map<String,String>> deletedSitesInfo) Remove descendant ametys objects.
void	activateModules(Project project, Set<String> moduleIds) Activate the list of module of the project
void	addPlaces(Collection<String> newPlaces) Add project's places
void	addTags(Collection<String> newTags) Add project's tags
void	contextualize(Context context)
ProjectCategory	createCategory(ModifiableTraversableAmetysObject parent, String title, String description) Create a project category
String	createCategory(String title, String description) Create a project category from the projects root node.
String	createCategory(String parentId, String title, String description) Create a project category
Project	createProject(ModifiableTraversableAmetysObject parent, String name, String title, Map<String,Object> additionalValues, Set<String> modulesIds, List<String> errors) Create a project
String	createProject(String parentId, String name, String title, Map<String,Object> additionalValues, Set<String> modulesIds, List<String> errors) Create a project
Map<String,Object>	createProject(String name, String title, String description, String mailingList, String inscriptionStatus, String defaultProfileId) Create a project from the projects root node.
Map<String,Object>	createProject(String parentId, String name, String title, String description, String mailingList, String inscriptionStatus, String defaultProfileId) Create a project
void	deactivateModules(Project project, Set<String> moduleIds) Remove the explorer root node of the project module, remove all events related to that module and set it to deactivated
List<Map<String,String>>	deleteCategory(List<ProjectCategory> categories) Delete a list of project categories.
List<Map<String,String>>	deleteCategory(ProjectCategory category) Delete a list of project category
Map<String,Object>	deleteCategoryByIds(List<String> ids) Delete a list of project categories.
List<Map<String,String>>	deleteProject(List<Project> projects) Delete a project.
List<Map<String,String>>	deleteProject(Project project) Delete a project and its sites
Map<String,Object>	deleteProjectsByIds(List<String> ids) Delete a list of project.
void	editCategory(ProjectCategory category, String title, String description) Edit a project category
void	editCategory(String id, String title, String description) Edit a project category
void	editProject(Project project, String title, String description, String mailingList, String inscriptionStatus, String defaultProfile) Edit a project
void	editProject(String id, String title, String description, String mailingList, String inscriptionStatus, String defaultProfile) Edit a project
Map<String,Object>	getCategoryProperties(ProjectCategory projectCategory) Retrieves the standard information of a project category
Map<String,Object>	getCategoryProperties(String categoryId) Retrieves the standard information of a project category
AmetysObjectIterable<Page>	getModulePages(Project project, String moduleId, String language) Retrieves the page of the module for all available languages
List<WorkspaceModule>	getModules(Project project) Get the list of activated modules for a project
Project	getParentProject(AmetysObject object) Get the project of an ametys object inside a project.
Project	getParentProject(String id) Get the project of an ametys object inside a project.
List<String>	getPlaces() Get the project's places
Project	getProject(String name) Retrieves a project by its name
AmetysObjectIterable<Page>	getProjectDashboardPage(Project project, String language) Get the dashboard page in the site of a given project
Collection<String>	getProjectNames() Retrieves the project names
Set<String>	getProjectNames(Project project) Get the availables project names.
AmetysObjectIterable<Page>	getProjectPages(Project project, String tagName, String language) Get a page in the site of a given project with a specific tag
Collection<String>	getProjectPaths() Retrieves the project paths of all projects.
Map<String,Object>	getProjectProfiles() Get the list of profiles configured for the workspaces' projects
Map<String,Object>	getProjectProperties(Project project) Retrieves the standard information of a project
Map<String,Object>	getProjectProperties(String projectId) Retrieves the standard information of a project
AmetysObjectIterable<Project>	getProjects() Retrieves all projects
List<Map<String,String>>	getProjectsData() Retrieves the mapping of all the projects name with their title (regarless user rights)
List<Project>	getProjectsForSite(Site site) Get the list of project for a given site
List<String>	getProjectsForSite(String siteName) Get the list of project names for a given site
ModifiableTraversableAmetysObject	getProjectsRoot() Return the root for projects The root node will be created if necessary
List<Map<String,Object>>	getProjectTree(String treeRootId, int maxDepth, boolean includeProjects, boolean memberOnly, Map<String,Object> contextOptions) Get the tree of a project which contains information about the projects and categories in the tree.
List<Map<String,Object>>	getProjectTree(String treeRootId, int maxDepth, Map<String,Object> contextOptions) Get the tree of a project which contains information about the projects and categories in the tree.
List<Object>	getProjectTreeNodes(String treeRootId, int maxDepth) Get the tree of a project.
List<Object>	getProjectTreeNodes(String treeRootId, int maxDepth, boolean includeProjects, boolean memberOnly) Get the tree of a project.
List<Object>	getProjectTreeNodes(String treeRootId, int maxDepth, int maxResult, boolean includeProjects, boolean memberOnly, List<String> filterCategories) Get the tree of a project.
Set<String>	getProjectUrls(Project project) Get the availables project URLs.
List<String>	getTags() Get the project's tags
List<Project>	getUserProjects(UserIdentity user) Get the user's projects
List<Map<String,String>>	getUserProjectsData() Retrieves the mapping of all the projects name with their title on which the current user has access
boolean	hasProject(String projectName) Returns true if the given project exists.
void	initializeModulesSitemap(Project project, Sitemap sitemap) Initialize the sitemap with the active module of the project
boolean	isCategoryInFilters(String categoryId, List<String> filterCategories, boolean includeProjects) Test if a category child is contained in the list of filters
boolean	isModuleActivated(Project project, String moduleId) Determines if a module is activated
Map<String,Object>	moveProjectTreeNode(String nodeId, String targetId) Move a node of the project tree into another node.
Map<String,Object>	moveProjectTreeNodeObject(JCRAmetysObject objectNode, JCRTraversableAmetysObject targetNode) Move a node of the project tree into another node.
void	service(ServiceManager manager)
void	setPlaces(List<String> places) Set the places
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.
void	setTags(List<String> tags) Set the tags

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

__WORKSPACES_PLUGIN_NODE_NAME

private static final String __WORKSPACES_PLUGIN_NODE_NAME

Workspaces plugin node name

See Also:

Constant Field Values

__WORKSPACES_PLUGIN_NODE_TYPE

private static final String __WORKSPACES_PLUGIN_NODE_TYPE

Workspaces plugin node name

See Also:

Constant Field Values

__PROJECTS_ROOT_NODE_NAME

private static final String __PROJECTS_ROOT_NODE_NAME

The name of the projects root node

See Also:

Constant Field Values

__PROJECTS_ROOT_NODE_TYPE

private static final String __PROJECTS_ROOT_NODE_TYPE

The type of the projects root node

See Also:

Constant Field Values

__PROJECTS_TAGS_PROPERTY

private static final String __PROJECTS_TAGS_PROPERTY

Constants for tags metadata

See Also:

Constant Field Values

__PROJECTS_PLACES_PROPERTY

private static final String __PROJECTS_PLACES_PROPERTY

Constants for places metadata

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils.

_siteManager

protected SiteManager _siteManager

Site manager

_siteDao

protected SiteDAO _siteDao

Site DAO

_siteConfiguration

protected SiteConfigurationExtensionPoint _siteConfiguration

Site configuration EP

_moduleManagerEP

protected WorkspaceModuleExtensionPoint _moduleManagerEP

Module Managers EP

_context

protected Context _context

Avalon context

_observationManager

private ObservationManager _observationManager

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_projectMembers

private ProjectMemberManager _projectMembers

_projectMemberManager

private ProjectMemberManager _projectMemberManager

_pluginName

private String _pluginName

_projectRightHelper

private ProjectRightHelper _projectRightHelper

Constructor Detail

ProjectManager

public ProjectManager()

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

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

getProjects

public AmetysObjectIterable<Project> getProjects()

Retrieves all projects

Returns:

the projects

getProject

public Project getProject(String name)

Retrieves a project by its name

Parameters:

name - The project name

Returns:

the project or null if not found

getUserProjects

public List<Project> getUserProjects(UserIdentity user)

Get the user's projects

Parameters:

user - the user

Returns:

the user's projects

hasProject

public boolean hasProject(String projectName)

Returns true if the given project exists.

Parameters:

projectName - the project name.

Returns:

true if the given project exists.

getUserProjectsData

public List<Map<String,String>> getUserProjectsData()

Retrieves the mapping of all the projects name with their title on which the current user has access

Returns:

the map (projectName, projectTitle) for all projects

getProjectsData

public List<Map<String,String>> getProjectsData()

Retrieves the mapping of all the projects name with their title (regarless user rights)

Returns:

the map (projectName, projectTitle) for all projects

getProjectNames

public Collection<String> getProjectNames()

Retrieves the project names

Returns:

the project names

getProjectPaths

public Collection<String> getProjectPaths()

Retrieves the project paths of all projects.

Returns:

A list of project paths

getProjectsRoot

public ModifiableTraversableAmetysObject getProjectsRoot()

Return the root for projects The root node will be created if necessary

Returns:

The root for projects

getProjectTree

public List<Map<String,Object>> getProjectTree(String treeRootId,
                                               int maxDepth,
                                               Map<String,Object> contextOptions)

Get the tree of a project which contains information about the projects and categories in the tree.

Parameters:

treeRootId - The desired root node of the tree

maxDepth - The maximal depth of the tree. Set to a value of zero or less to get the whole tree.

contextOptions - An optional map of context options. Valid context options are: "user", which holds an user identity, the project tree will be filtered given that user rights.

Returns:

The project tree which is a list of map. Each map is a node of the tree structure.

getProjectTree

public List<Map<String,Object>> getProjectTree(String treeRootId,
                                               int maxDepth,
                                               boolean includeProjects,
                                               boolean memberOnly,
                                               Map<String,Object> contextOptions)

Get the tree of a project which contains information about the projects and categories in the tree.

Parameters:

treeRootId - The desired root node of the tree

maxDepth - The maximal depth of the tree. Set to a value of zero or less to get the whole tree.

includeProjects - False to only return the categories tree.

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

contextOptions - An optional map of context options. Valid context options are: "user", which holds an user identity, the project tree will be filtered given that user rights.

Returns:

The project tree which is a list of map. Each map is a node of the tree structure.

_projectTreeAccumulator

private void _projectTreeAccumulator(List<Map<String,Object>> projectTree,
                                     AmetysObject node,
                                     int depth,
                                     int maxDepth,
                                     boolean includeProjects,
                                     boolean memberOnly)

getProjectProperties

public Map<String,Object> getProjectProperties(String projectId)

Retrieves the standard information of a project

Parameters:

projectId - Identifier of the project

Returns:

The map of information

getProjectProperties

public Map<String,Object> getProjectProperties(Project project)

Retrieves the standard information of a project

Parameters:

project - The project

Returns:

The map of information

getProjectUrls

public Set<String> getProjectUrls(Project project)

Get the availables project URLs.

Parameters:

project - The project

Returns:

The availables project URLs, can be empty.

getProjectNames

public Set<String> getProjectNames(Project project)

Get the availables project names.

Parameters:

project - The project

Returns:

The availables project names, can be empty.

_getProjectNonEmptyElements

private Set<String> _getProjectNonEmptyElements(Project project,
                                                Function<? super Site,? extends String> function)

getProjectTreeNodes

public List<Object> getProjectTreeNodes(String treeRootId,
                                        int maxDepth)

Get the tree of a project.

Parameters:

treeRootId - The desired root node of the tree

maxDepth - The maximal depth of the tree. Set to a value of zero or less to get the whole tree.

Returns:

The project tree which is a list of projects and categories. Each category is a map with the category node and a list of children.

getProjectTreeNodes

public List<Object> getProjectTreeNodes(String treeRootId,
                                        int maxDepth,
                                        boolean includeProjects,
                                        boolean memberOnly)

Get the tree of a project.

Parameters:

treeRootId - The desired root node of the tree

maxDepth - The maximal depth of the tree. Set to a value of zero or less to get the whole tree.

includeProjects - False to only return the categories tree.

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

Returns:

The project tree which is a list of projects and categories. Each category is a map with the category node and a list of children.

getProjectTreeNodes

public List<Object> getProjectTreeNodes(String treeRootId,
                                        int maxDepth,
                                        int maxResult,
                                        boolean includeProjects,
                                        boolean memberOnly,
                                        List<String> filterCategories)

Get the tree of a project.

Parameters:

treeRootId - The desired root node of the tree

maxDepth - The maximal depth of the tree. Set to a value of zero or less to get the whole tree.

maxResult - Limit the number of projects returned

includeProjects - False to only return 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 project tree which is a list of projects and categories. Each category is a map with the category node and a list of children.

_projectTreeNodeAccumulator

private void _projectTreeNodeAccumulator(List<Object> projectTree,
                                         AmetysObject node,
                                         int depth,
                                         int maxDepth,
                                         boolean includeProjects,
                                         boolean memberOnly)

_filterProjectTree

private List<Object> _filterProjectTree(List<Object> projectTree,
                                        Map<String,Object> filters,
                                        String categoryId,
                                        int depth,
                                        int maxDepth)

_filterProjectTreeCategory

private List<Object> _filterProjectTreeCategory(Map<String,Object> categoryData,
                                                List<Object> filteredProjectTree,
                                                Map<String,Object> filters,
                                                boolean isCategoryInFilters,
                                                int depth,
                                                int maxDepth)

isCategoryInFilters

public boolean isCategoryInFilters(String categoryId,
                                   List<String> filterCategories,
                                   boolean includeProjects)

Test if a category child is contained in the list of filters

Parameters:

categoryId - The category id

filterCategories - The list of category id that one of the children must match

includeProjects - True to test filters on all category children, false to only test on sub-categories

Returns:

True if the child is in the filters

createProject

public Map<String,Object> createProject(String name,
                                        String title,
                                        String description,
                                        String mailingList,
                                        String inscriptionStatus,
                                        String defaultProfileId)

Create a project from the projects root node.

Parameters:

name - The project name

title - The project title

description - The project description

mailingList - Project mailing list

inscriptionStatus - The inscription status of the project

defaultProfileId - The default profile for new members

Returns:

A map containing the id of the new project or an error key.

createProject

public Map<String,Object> createProject(String parentId,
                                        String name,
                                        String title,
                                        String description,
                                        String mailingList,
                                        String inscriptionStatus,
                                        String defaultProfileId)

Create a project

Parameters:

parentId - Identifier of the parent of the project to create

name - The project name

title - The project title

description - The project description

mailingList - Project mailing list

inscriptionStatus - The inscription status of the project

defaultProfileId - The default profile for new members

Returns:

A map containing the id of the new project or an error key.

createProject

public String createProject(String parentId,
                            String name,
                            String title,
                            Map<String,Object> additionalValues,
                            Set<String> modulesIds,
                            List<String> errors)

Create a project

Parameters:

parentId - Identifier of the parent of the project to create

name - The project name

title - The project title

additionalValues - A list of optional additional values. Accepted values are : description, mailingList, inscriptionStatus, defaultProfile, tags, categoryTags and keywords

modulesIds - The list of modules to activate. Can be null to activate all modules

errors - A list that will be populated with the encountered errors. If null, errors will not be tracked.

Returns:

The id of the new project

createProject

public Project createProject(ModifiableTraversableAmetysObject parent,
                             String name,
                             String title,
                             Map<String,Object> additionalValues,
                             Set<String> modulesIds,
                             List<String> errors)

Create a project

Parameters:

parent - the parent of the project to create

name - The project name

title - The project title

additionalValues - A list of optional additional values. Accepted values are : description, mailingList, inscriptionStatus, defaultProfile, tags, categoryTags and keywords

modulesIds - The list of modules to activate. Can be null to activate all modules

errors - A list that will be populated with the encountered errors. If null, errors will not be tracked.

Returns:

The id of the new project

editProject

public void editProject(String id,
                        String title,
                        String description,
                        String mailingList,
                        String inscriptionStatus,
                        String defaultProfile)

Edit a project

Parameters:

id - The project identifier

title - The title to set

description - The description to set

mailingList - Project mailing list

inscriptionStatus - The inscription status of the project

defaultProfile - The default profile for new members

editProject

public void editProject(Project project,
                        String title,
                        String description,
                        String mailingList,
                        String inscriptionStatus,
                        String defaultProfile)

Edit a project

Parameters:

project - The project

title - The title to set

description - The description to set

mailingList - Project mailing list

inscriptionStatus - The inscription status of the project

defaultProfile - The default profile for new members

deleteProjectsByIds

public Map<String,Object> deleteProjectsByIds(List<String> ids)

Delete a list of project.

Parameters:

ids - The ids of projects to delete

Returns:

The ids of the deleted projects, unknowns projects and the deleted sites

deleteProject

public List<Map<String,String>> deleteProject(List<Project> projects)

Delete a project.

Parameters:

projects - The list of projects to delete

Returns:

list of deleted sites (each list entry contains a data map with the id and the name of the delete site).

deleteProject

public List<Map<String,String>> deleteProject(Project project)

Delete a project and its sites

Parameters:

project - The project to delete

Returns:

list of deleted sites (each list entry contains a data map with the id and the name of the delete site).

getCategoryProperties

public Map<String,Object> getCategoryProperties(String categoryId)

Retrieves the standard information of a project category

Parameters:

categoryId - Identifier of the project category

Returns:

The map of information

getCategoryProperties

public Map<String,Object> getCategoryProperties(ProjectCategory projectCategory)

Retrieves the standard information of a project category

Parameters:

projectCategory - The project category

Returns:

The map of information

createCategory

public String createCategory(String title,
                             String description)

Create a project category from the projects root node.

Parameters:

title - The category title

description - The category description

Returns:

The id of the new category

createCategory

public String createCategory(String parentId,
                             String title,
                             String description)

Create a project category

Parameters:

parentId - Identifier of the parent of the category to create

title - The category title

description - The category description

Returns:

The id of the new category

createCategory

public ProjectCategory createCategory(ModifiableTraversableAmetysObject parent,
                                      String title,
                                      String description)

Create a project category

Parameters:

parent - the parent of the category to create

title - The category title

description - The category description

Returns:

The id of the new category

editCategory

public void editCategory(String id,
                         String title,
                         String description)

Edit a project category

Parameters:

id - The category identifier

title - The title to set

description - The description to set

editCategory

public void editCategory(ProjectCategory category,
                         String title,
                         String description)

Edit a project category

Parameters:

category - The project category

title - The title to set

description - The description to set

deleteCategoryByIds

public Map<String,Object> deleteCategoryByIds(List<String> ids)

Delete a list of project categories.

Parameters:

ids - The ids of categories to delete

Returns:

The ids of the deleted categories, unknowns categories and the deleted sites

deleteCategory

public List<Map<String,String>> deleteCategory(List<ProjectCategory> categories)

Delete a list of project categories.

Parameters:

categories - The list of categories to delete

Returns:

list of deleted sites (each list entry contains a data map with the id and the name of the delete site).

deleteCategory

public List<Map<String,String>> deleteCategory(ProjectCategory category)

Delete a list of project category

Parameters:

category - The category to delete

Returns:

list of deleted sites (each list entry contains a data map with the id and the name of the delete site).

_removeDescendants

private void _removeDescendants(AmetysObject object,
                                List<Map<String,String>> deletedSitesInfo)

Remove descendant ametys objects. Descendants should be a project or a category

Parameters:

object - The project or category for which descendants must be removed

deletedSitesInfo - list of deleted sites to be populated (each list entry contains a data map with the id and the name of the delete site).

moveProjectTreeNode

public Map<String,Object> moveProjectTreeNode(String nodeId,
                                              String targetId)
                                       throws RepositoryException

Move a node of the project tree into another node. Node can be a project or a category

Parameters:

nodeId - The identifier of the node to move

targetId - Identifier of the category which is the target of the move operation. Can be null if the target is the projects root node.

Returns:

A map containing a possible error.

Throws:

RepositoryException - if a repository error occurs.

moveProjectTreeNodeObject

public Map<String,Object> moveProjectTreeNodeObject(JCRAmetysObject objectNode,
                                                    JCRTraversableAmetysObject targetNode)
                                             throws RepositoryException

Move a node of the project tree into another node. Node can be a project or a category

Parameters:

objectNode - The node to move (must be a project or a category)

targetNode - The category which is the target of the move operation. Can be null if the target is the projects root node.

Returns:

A map containing a possible error.

Throws:

RepositoryException - if a repository error occurs.

_getOrCreateObject

private <A extends AmetysObject> A _getOrCreateObject(ModifiableTraversableAmetysObject parent,
                                                      String name,
                                                      String type)
                                               throws AmetysRepositoryException

Utility method to get or create an ametys object

Type Parameters:

A - A sub class of AmetysObject

Parameters:

parent - The parent object

name - The ametys object name

type - The ametys object type

Returns:

ametys object

Throws:

AmetysRepositoryException - if an repository error occurs

getParentProject

public Project getParentProject(String id)

Get the project of an ametys object inside a project. It can be an explorer node, or any type of resource in a module.

Parameters:

id - The identifier of the ametys object

Returns:

the project or null if not found

getParentProject

public Project getParentProject(AmetysObject object)

Get the project of an ametys object inside a project. It can be an explorer node, or any type of resource in a module.

Parameters:

object - The ametys object

Returns:

the project or null if not found

getProjectsForSite

public List<String> getProjectsForSite(String siteName)

Get the list of project names for a given site

Parameters:

siteName - The site name

Returns:

the list of project names

getProjectsForSite

public List<Project> getProjectsForSite(Site site)

Get the list of project for a given site

Parameters:

site - The site

Returns:

the list of project

_createProjectWorkspace

protected Site _createProjectWorkspace(Project project,
                                       List<String> errors)

Create the project workspace for a given project.

Parameters:

project - The project for which the workspace must be created

errors - A list of possible errors to populate. Can be null if the caller is not interested in error tracking.

Returns:

The site created for this workspace

getTags

public List<String> getTags()

Get the project's tags

Returns:

The project's tags

setTags

public void setTags(List<String> tags)

Set the tags

Parameters:

tags - The tags to set

addTags

public void addTags(Collection<String> newTags)

Add project's tags

Parameters:

newTags - The new tags to add

getPlaces

public List<String> getPlaces()

Get the project's places

Returns:

The project's places

addPlaces

public void addPlaces(Collection<String> newPlaces)

Add project's places

Parameters:

newPlaces - The new places to add

setPlaces

public void setPlaces(List<String> places)

Set the places

Parameters:

places - The places to set

getModules

public List<WorkspaceModule> getModules(Project project)

Get the list of activated modules for a project

Parameters:

project - The project

Returns:

The list of activated modules

getModulePages

public AmetysObjectIterable<Page> getModulePages(Project project,
                                                 String moduleId,
                                                 String language)

Retrieves the page of the module for all available languages

Parameters:

project - The project

moduleId - The project module id

language - the sitemap language or null for all sitemap languages.

Returns:

the page or null if not found

getProjectPages

public AmetysObjectIterable<Page> getProjectPages(Project project,
                                                  String tagName,
                                                  String language)

Get a page in the site of a given project with a specific tag

Parameters:

project - The project

tagName - The name of the tag

language - the sitemap language or null for all sitemap languages.

Returns:

The module's pages

getProjectDashboardPage

public AmetysObjectIterable<Page> getProjectDashboardPage(Project project,
                                                          String language)

Get the dashboard page in the site of a given project

Parameters:

project - The project

language - the sitemap language or null for all sitemap languages.

Returns:

The module's dashboard pages

activateModules

public void activateModules(Project project,
                            Set<String> moduleIds)

Activate the list of module of the project

Parameters:

project - The project

moduleIds - The list of modules. Can be null to activate all modules

initializeModulesSitemap

public void initializeModulesSitemap(Project project,
                                     Sitemap sitemap)

Initialize the sitemap with the active module of the project

Parameters:

project - The project

sitemap - The sitemap

isModuleActivated

public boolean isModuleActivated(Project project,
                                 String moduleId)

Determines if a module is activated

Parameters:

project - The project

moduleId - The id of module

Returns:

true if the module the currently activated

deactivateModules

public void deactivateModules(Project project,
                              Set<String> moduleIds)

Remove the explorer root node of the project module, remove all events related to that module and set it to deactivated

Parameters:

project - The project

moduleIds - The id of module to activate

getProjectProfiles

public Map<String,Object> getProjectProfiles()

Get the list of profiles configured for the workspaces' projects

Returns:

The list of profiles as JSON