Package org.ametys.plugins.workspaces

Class AbstractWorkspaceModule

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceModule

All Implemented Interfaces:

Comparable<WorkspaceModule>, WorkspaceModule, LogEnabled, PluginAware, Contextualizable, Serviceable

Direct Known Subclasses:

AboutWorkspaceModule, AlertWorkspaceModule, CalendarWorkspaceModule, DocumentWorkspaceModule, ForumWorkspaceModule, MembersWorkspaceModule, MiniSiteWorkspaceModule, NewsWorkspaceModule, TasksWorkspaceModule, WallContentModule

public abstract class AbstractWorkspaceModule
extends AbstractLogEnabled
implements WorkspaceModule, Serviceable, Contextualizable, PluginAware

Abstract class for WorkspaceModule implementation

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Long	__SIZE_ERROR	Size value constants in case of size computation error
protected static final Long	__SIZE_INACTIVE	Size value constants for inactive modules
protected ActivityStreamClientInteraction	_activityStream	The activity stream manager
protected Context	_context	The avalon context
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected I18nUtils	_i18nUtils	The i18n utils.
protected WorkspaceModuleExtensionPoint	_modulesEP	The modules extension point
protected ObservationManager	_observationManager	Observer manager.
protected PageDAO	_pageDAO	The page DAO
protected String	_pluginName	The plugin name
protected ProjectManager	_projectManager	Project manager
protected ProjectRightHelper	_projectRightHelper	Project right helper
protected AmetysObjectResolver	_resolver	Ametys resolver
protected RightManager	_rightManager	The rights manager
protected ServiceExtensionPoint	_serviceEP	The services handler
protected SkinsManager	_skinsManager	The skins manager.
protected UserHelper	_userHelper	The users manager
protected UserManager	_userManager	User manager

Fields inherited from interface org.ametys.plugins.workspaces.project.modules.WorkspaceModule

GROUP_HEADER_ACTIVATED_ID, GROUP_HEADER_ELEMENTS_ID, GROUP_HEADER_LAST_ACTIVITY_ID, GROUP_HEADER_SIZE_ID, ORDER_ABOUT, ORDER_ALERTS, ORDER_CALENDAR, ORDER_DOCUMENTS, ORDER_FORUMS, ORDER_MEMBERS, ORDER_MINISITE, ORDER_NEWS, ORDER_TASKS, ORDER_WALLCONTENT

Constructor Summary

Constructors

Constructor	Description
AbstractWorkspaceModule()

Method Summary

Modifier and Type	Method	Description
protected ModifiablePage	_createModulePage(Project project, Sitemap sitemap, String name, I18nizableText pageTitle, String skinTemplate)	Create a new page if not already exists
protected void	_deleteActivities(Project project)	Delete all activities related to this module
protected void	_deletePages(Project project)	Delete the module pages and their related contents
protected <A extends AmetysObject> A	_getAmetysObject(ModifiableTraversableAmetysObject parent, String name, String type, boolean create)	Utility method to get or create an ametys object
protected String	_getDefaultXslt(String serviceId)	Get the default value of the XSLT parameter of the given service.
protected List<StatisticColumn>	_getInternalStatisticModel()	Get the headers of statistics
protected Map<String,Object>	_getInternalStatistics(Project project, boolean isActive)	Get the internal statistics of the module
protected ZonedDateTime	_getModuleLastActivity(Project project)	Get the size of module in bytes
protected List<Page>	_getModulePages(Project project)	Get the module pages
protected long	_getModuleSize(Project project)	Get the size of module in bytes
protected void	_internalActivateModule(Project project, Map<String,Object> additionalValues)	Internal process when module is activated
protected void	_internalDeactivateModule(Project project)	Internal process when module is deactivated
protected void	_internalDeleteData(Project project)	Internal process to delete data
protected void	_setPagesVisibility(Project project, boolean visible)	Change the visibility of module pages if needed
protected boolean	_showActivatedStatus()	Check if activated status should be shown or not
protected boolean	_showLastActivity()	Check if the last activity should be shown or not
protected boolean	_showModuleSize()	Check if module size should be shown or not
void	activateModule(Project project, Map<String,Object> additionalValues)	Activate the module for the project, creating the module pages
void	contextualize(Context context)
void	deactivateModule(Project project)	Deactivate a module
void	deleteData(Project project)	Delete a module and all related data (pages, events, resources, ...)
Set<String>	getAllEventTypes()	Get the set of all event type for the module
protected abstract String	getModulePageName()	Returns the module page's name
protected String	getModulePageTemplate()	Returns the template to use for module's page.
protected abstract I18nizableText	getModulePageTitle()	Returns the module page's title as i18n
ModifiableResourceCollection	getModuleRoot(Project project, boolean create)	Get the module root node for the given project
String	getModuleSizeKey()	Returns the key to get module size in statistics
String	getModuleUrl(Project project)	Get the URL of the first module's page
List<StatisticColumn>	getStatisticModel()	Get the headers of statistics
Map<String,Object>	getStatistics(Project project)	Get the statistics of the module
protected abstract void	initializeModulePage(ModifiablePage modulePage)	Initialize the module page
void	initializeSitemap(Project project, Sitemap sitemap)	Initialize the sitemap for the module
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

Methods inherited from interface org.ametys.plugins.workspaces.project.modules.WorkspaceModule

compareTo, getAllowedEventTypes, getId, getModuleDescription, getModuleName, getModuleTitle, getOrder, isUnactivatedByDefault

Field Details

__SIZE_ERROR

protected static final Long __SIZE_ERROR

Size value constants in case of size computation error

__SIZE_INACTIVE

protected static final Long __SIZE_INACTIVE

Size value constants for inactive modules

_projectManager

protected ProjectManager _projectManager

Project manager

_projectRightHelper

protected ProjectRightHelper _projectRightHelper

Project right helper

_userManager

protected UserManager _userManager

User manager

_resolver

protected AmetysObjectResolver _resolver

Ametys resolver

_rightManager

protected RightManager _rightManager

The rights manager

_observationManager

protected ObservationManager _observationManager

Observer manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

_userHelper

protected UserHelper _userHelper

The users manager

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils.

_skinsManager

protected SkinsManager _skinsManager

The skins manager.

_pageDAO

protected PageDAO _pageDAO

The page DAO

_context

protected Context _context

The avalon context

_pluginName

protected String _pluginName

The plugin name

_serviceEP

protected ServiceExtensionPoint _serviceEP

The services handler

_modulesEP

protected WorkspaceModuleExtensionPoint _modulesEP

The modules extension point

_activityStream

protected ActivityStreamClientInteraction _activityStream

The activity stream manager

Constructor Details

AbstractWorkspaceModule

public AbstractWorkspaceModule()

Method Details

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

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

deleteData

public void deleteData(Project project)

Description copied from interface: WorkspaceModule

Delete a module and all related data (pages, events, resources, ...)

Specified by:

deleteData in interface WorkspaceModule

Parameters:

project - The project

deactivateModule

public void deactivateModule(Project project)

Description copied from interface: WorkspaceModule

Deactivate a module

Specified by:

deactivateModule in interface WorkspaceModule

Parameters:

project - The project

activateModule

public void activateModule(Project project,
 Map<String,Object> additionalValues)

Description copied from interface: WorkspaceModule

Activate the module for the project, creating the module pages

Specified by:

activateModule in interface WorkspaceModule

Parameters:

project - The project

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

initializeSitemap

public void initializeSitemap(Project project,
 Sitemap sitemap)

Description copied from interface: WorkspaceModule

Initialize the sitemap for the module

Specified by:

initializeSitemap in interface WorkspaceModule

Parameters:

project - The project of the module

sitemap - The sitemap

getModuleUrl

public String getModuleUrl(Project project)

Description copied from interface: WorkspaceModule

Get the URL of the first module's page

Specified by:

getModuleUrl in interface WorkspaceModule

Parameters:

project - The project

Returns:

the module url

_createModulePage

protected ModifiablePage _createModulePage(Project project,
 Sitemap sitemap,
 String name,
 I18nizableText pageTitle,
 String skinTemplate)

Create a new page if not already exists

Parameters:

project - The module project

sitemap - The sitemap where the page will be created

name - The page's name

pageTitle - The page's title as i18nizable text

skinTemplate - The template from the skin to apply on the page

Returns:

the created page or null if page already exists

_setPagesVisibility

protected void _setPagesVisibility(Project project,
 boolean visible)

Change the visibility of module pages if needed

Parameters:

project - The project

visible - visible true to set pages as visible, false otherwise

_deletePages

protected void _deletePages(Project project)

Delete the module pages and their related contents

Parameters:

project - The project

_getModulePages

protected List<Page> _getModulePages(Project project)

Get the module pages

Parameters:

project - the project

Returns:

the module pages

_deleteActivities

protected void _deleteActivities(Project project)

Delete all activities related to this module

Parameters:

project - The project

_getDefaultXslt

protected String _getDefaultXslt(String serviceId)

Get the default value of the XSLT parameter of the given service.

Parameters:

serviceId - the service ID.

Returns:

the default XSLT parameter value.

getModulePageName

protected abstract String getModulePageName()

Returns the module page's name

Returns:

The module page's name

getModulePageTitle

protected abstract I18nizableText getModulePageTitle()

Returns the module page's title as i18n

Returns:

The module page's title

getModulePageTemplate

protected String getModulePageTemplate()

Returns the template to use for module's page. Can be null if the page should be a node page

Returns:

The template

initializeModulePage

protected abstract void initializeModulePage(ModifiablePage modulePage)

Initialize the module page

Parameters:

modulePage - The module page

_internalDeactivateModule

protected void _internalDeactivateModule(Project project)

Internal process when module is deactivated

Parameters:

project - The project

_internalDeleteData

protected void _internalDeleteData(Project project)

Internal process to delete data

Parameters:

project - The project

_internalActivateModule

protected void _internalActivateModule(Project project,
 Map<String,Object> additionalValues)

Internal process when module is activated

Parameters:

project - The project

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

_getAmetysObject

protected <A extends AmetysObject> A _getAmetysObject(ModifiableTraversableAmetysObject parent,
 String name,
 String type,
 boolean create)
                                               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

create - True to create the object if it does not exist

Returns:

ametys object

Throws:

AmetysRepositoryException - if an repository error occurs

getStatistics

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

Description copied from interface: WorkspaceModule

Get the statistics of the module

Specified by:

getStatistics in interface WorkspaceModule

Parameters:

project - The project

Returns:

a map of statistics

_getInternalStatistics

protected Map<String,Object> _getInternalStatistics(Project project,
 boolean isActive)

Get the internal statistics of the module

Parameters:

project - The project

isActive - true if module is active

Returns:

a map of internal statistics

getStatisticModel

public List<StatisticColumn> getStatisticModel()

Description copied from interface: WorkspaceModule

Get the headers of statistics

Specified by:

getStatisticModel in interface WorkspaceModule

Returns:

a list of statistics headers

_getInternalStatisticModel

protected List<StatisticColumn> _getInternalStatisticModel()

Get the headers of statistics

Returns:

a list of statistics headers

getModuleSizeKey

public String getModuleSizeKey()

Description copied from interface: WorkspaceModule

Returns the key to get module size in statistics

Specified by:

getModuleSizeKey in interface WorkspaceModule

Returns:

The key to get module size in statistics

_getModuleSize

protected long _getModuleSize(Project project)

Get the size of module in bytes

Parameters:

project - The project

Returns:

the size of module in bytes

_showActivatedStatus

protected boolean _showActivatedStatus()

Check if activated status should be shown or not

Returns:

true if activated status should be shown

_showModuleSize

protected boolean _showModuleSize()

Check if module size should be shown or not

Returns:

true if module size should be shown

getAllEventTypes

public Set<String> getAllEventTypes()

Description copied from interface: WorkspaceModule

Get the set of all event type for the module

Specified by:

getAllEventTypes in interface WorkspaceModule

Returns:

The set of all event types

_showLastActivity

protected boolean _showLastActivity()

Check if the last activity should be shown or not

Returns:

true if last activity should be shown

_getModuleLastActivity

protected ZonedDateTime _getModuleLastActivity(Project project)

Get the size of module in bytes

Parameters:

project - The project

Returns:

the size of module in bytes

getModuleRoot

public ModifiableResourceCollection getModuleRoot(Project project,
 boolean create)

Description copied from interface: WorkspaceModule

Get the module root node for the given project

Specified by:

getModuleRoot in interface WorkspaceModule

Parameters:

project - The project containing the module

create - True to create the node if it does not exists

Returns:

The root node, or null if it does not exists and was not created