org.ametys.plugins.workspaces

Class AbstractWorkspaceModule

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceModule

All Implemented Interfaces:

WorkspaceModule, LogEnabled, PluginAware, Contextualizable, Serviceable

Direct Known Subclasses:

CalendarWorkspaceModule, DocumentWorkspaceModule, EditionFOWorkspaceModule, TasksWorkspaceModule, ThreadWorkspaceModule

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

Abstract class for WorkspaceModule implementation

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	_context The avalon context
protected CurrentUserProvider	_currentUserProvider The current user provider.
protected I18nUtils	_i18nUtils The i18n utils.
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

Constructor Summary

Constructors

Constructor and Description
AbstractWorkspaceModule()

Method Summary

Modifier and Type	Method and Description
protected ModifiablePage	_createModulePage(Sitemap sitemap, String name, I18nizableText pageTitle, String skinTemplate) Create a new page if not already exists
protected void	_deletePages(Project project, String pageName) Delete all pages of the project sites matching the page name
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 void	_internalActivateModule(Project project) Internal process when module is activated
protected void	_internalDeactivateModule(Project project) Internal process when module is deactivated
void	activateModule(Project project) Activate the module for the project, creating the module pages
void	contextualize(Context context)
void	deactivateModule(Project project) Delete all data related to the module in the project, and the module pages
protected abstract String	getModulePageName() Returns the module page's name
AmetysObjectIterable<Page>	getModulePages(Project project, String language) Retrieves the pages of the module
protected String	getModulePageTemplate() Returns the template to use for module's page
protected abstract I18nizableText	getModulePageTitle() Returns the module page's title as i18n
protected abstract String	getModuleTagName() Returns the tag of apply to module page
protected abstract void	initializeModulePage(ModifiablePage modulePage) Initialize the module page
void	initializeSitemap(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

getAllowedEventTypes, getId, getModuleName, getModuleRoot, getModuleTitle

Field Detail

_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

Constructor Detail

AbstractWorkspaceModule

public AbstractWorkspaceModule()

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

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

deactivateModule

public void deactivateModule(Project project)

Description copied from interface: WorkspaceModule

Delete all data related to the module in the project, and the module pages

Specified by:

deactivateModule in interface WorkspaceModule

Parameters:

project - The project

activateModule

public void activateModule(Project project)

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

initializeSitemap

public void initializeSitemap(Sitemap sitemap)

Description copied from interface: WorkspaceModule

Initialize the sitemap for the module

Specified by:

initializeSitemap in interface WorkspaceModule

Parameters:

sitemap - The sitemap

getModulePages

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

Description copied from interface: WorkspaceModule

Retrieves the pages of the module

Specified by:

getModulePages in interface WorkspaceModule

Parameters:

project - The project

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

Returns:

the pages iterator

_createModulePage

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

Create a new page if not already exists

Parameters:

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

_deletePages

protected void _deletePages(Project project,
                            String pageName)

Delete all pages of the project sites matching the page name

Parameters:

project - The project

pageName - The page name

_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.

getModuleTagName

protected abstract String getModuleTagName()

Returns the tag of apply to module page

Returns:

The tag for module page

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

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

_internalActivateModule

protected void _internalActivateModule(Project project)

Internal process when module is activated

Parameters:

project - The project

_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