org.ametys.plugins.workspaces.project.observers

Class InitializeProjectSitemapObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.project.observers.InitializeProjectSitemapObserver

All Implemented Interfaces:

Observer, LogEnabled, PluginAware, Contextualizable, Serviceable

public class InitializeProjectSitemapObserver
extends AbstractLogEnabled
implements Observer, Serviceable, PluginAware, Contextualizable

Initializes all project workspace pages when a sitemap is created.

Field Summary

Fields

Modifier and Type	Field and Description
private Context	_cocoonContext
protected CurrentUserProvider	_currentUserProvider Current user provider
protected String	_i18nCatalogue The i18n catalogue.
protected I18nUtils	_i18nUtils The i18n utils.
protected ObservationManager	_observationManager The observation manager.
protected String	_pluginName The plugin name.
protected ProjectManager	_projectManager Workspaces project manager
protected ServiceExtensionPoint	_serviceEP The service extension point.
protected SkinsManager	_skinsManager The skins manager.
protected WorkflowProvider	_workflowProvider The workflow provider

Fields inherited from interface org.ametys.core.observation.Observer

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
InitializeProjectSitemapObserver()

Method Summary

Modifier and Type	Method and Description
protected ModifiablePage	_createPage(Sitemap sitemap, String name, I18nizableText i18nTitle) Create a new page if not already exists
protected void	_initializeIndexPage(Project project, ModifiablePage indexPage) Initialize the index page.
protected void	_initializeIndexPage(Project project, Skin skin, ModifiablePage indexPage, File cfgFile) Initialize the index page from a configuration file
protected void	_initializeSitemap(Sitemap sitemap, Project project) Initialize the given sitemap.
private void	_setServiceParameters(Collection<ModelItem> modelItems, ModifiableModelAwareDataHolder dataHolder, Configuration paramsConf, String lang)
void	contextualize(Context context)
int	getPriority(Event event) Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
void	observe(Event event, Map<String,Object> transientVars) Observes an event.
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.
boolean	supports(Event event) Checks if the event is supported.

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

_projectManager

protected ProjectManager _projectManager

Workspaces project manager

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils.

_observationManager

protected ObservationManager _observationManager

The observation manager.

_skinsManager

protected SkinsManager _skinsManager

The skins manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

Current user provider

_serviceEP

protected ServiceExtensionPoint _serviceEP

The service extension point.

_pluginName

protected String _pluginName

The plugin name.

_i18nCatalogue

protected String _i18nCatalogue

The i18n catalogue.

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_cocoonContext

private Context _cocoonContext

Constructor Detail

InitializeProjectSitemapObserver

public InitializeProjectSitemapObserver()

Method Detail

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

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

supports

public boolean supports(Event event)

Description copied from interface: Observer

Checks if the event is supported. If true, the observe(Event) method will be called.

Specified by:

supports in interface Observer

Parameters:

event - the event.

Returns:

true for observing this event, false otherwise.

getPriority

public int getPriority(Event event)

Description copied from interface: Observer

Retrieves the priority to observe this event.
This can be used to process a supported event before others observers.

Specified by:

getPriority in interface Observer

Parameters:

event - the event.

Returns:

the priority where 0 the max priority and Integer.MAX_VALUE the min priority.

observe

public void observe(Event event,
                    Map<String,Object> transientVars)
             throws Exception

Description copied from interface: Observer

Observes an event.

Specified by:

observe in interface Observer

Parameters:

event - the event.

transientVars - transientVars passed from one Observer to another when processing a single Event. This may allow optimizations between observers.

Throws:

Exception - if an error occurs. All exceptions will be logged but not propagated, as the observation mechanism should never fail.

_initializeSitemap

protected void _initializeSitemap(Sitemap sitemap,
                                  Project project)

Initialize the given sitemap.

Parameters:

sitemap - the Sitemap object.

project - the corresponding project

_createPage

protected ModifiablePage _createPage(Sitemap sitemap,
                                     String name,
                                     I18nizableText i18nTitle)

Create a new page if not already exists

Parameters:

sitemap - The sitemap where the page will be created

name - The page's name

i18nTitle - The page's title

Returns:

the created page or null if page already exists

_initializeIndexPage

protected void _initializeIndexPage(Project project,
                                    ModifiablePage indexPage)

Initialize the index page.

Parameters:

project - The project

indexPage - the index page.

_initializeIndexPage

protected void _initializeIndexPage(Project project,
                                    Skin skin,
                                    ModifiablePage indexPage,
                                    File cfgFile)

Initialize the index page from a configuration file

Parameters:

project - the project

skin - the skin

indexPage - the index page

cfgFile - the configuration file

_setServiceParameters

private void _setServiceParameters(Collection<ModelItem> modelItems,
                                   ModifiableModelAwareDataHolder dataHolder,
                                   Configuration paramsConf,
                                   String lang)
                            throws ConfigurationException

Throws:

ConfigurationException