Package org.ametys.plugins.workspaces

Class PagePopulator

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.PagePopulator

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class PagePopulator
extends AbstractLogEnabled
implements Serviceable, Component

Component allowing to create and fill a page from a configuration file

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeEP	the content type extension point
protected CurrentUserProvider	_currentUserProvider	the current user provider
protected I18nUtils	_i18nUtils	the i18n utils component
protected ObservationManager	_observationManager	the observation manager
protected PageDAO	_pageDAO	the page dao
protected ProfileAssignmentStorageExtensionPoint	_profileAssignementStorageEP	the profile assignment storage extension point
protected SAXParser	_saxParser	Excalibur SaxParser
protected ServiceExtensionPoint	_serviceEP	the service extension point
protected SkinsManager	_skinsManager	the skins manager
protected SourceResolver	_sourceResolver	the source resolver
protected ContentWorkflowHelper	_workflowHelper	the workflow helper
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
PagePopulator()

Method Summary

Modifier and Type	Method	Description
protected void	_notifyACLChange(Object context, Set<String> profilesId)	Utility method to notify a change of ACL on a context
protected void	configurePage(ModifiablePage newPage, Configuration configuration)	Use a configuration to edit a page.
protected void	createAndConfigureContentItem(ModifiableZone zone, Configuration contentCfg)	Create a new content based on configuration and add it to a new zone item
protected void	createAndConfigureServiceItem(ModifiableZone zone, Configuration serviceCfg)	Create and configure a zone item based on a service configuration
protected void	createAndConfigureZone(ModifiablePage newPage, Configuration zoneCfg)	Create and configure a zone based on configuration
protected Optional<ModifiablePage>	createPage(ModifiableSitemapElement parent, Configuration configuration)	Create a new page based on a configuration.
Optional<ModifiablePage>	initPage(ModifiableSitemapElement parent, String path)	Create a new page based on a configuration file.
Optional<ModifiablePage>	initPage(ModifiableSitemapElement parent, Configuration configuration)	Create and configure a new page based on a configuration.
void	service(ServiceManager manager)
protected void	setReaderAccess(ModifiablePage newPage, Configuration configuration)	Set page reader access based on configuration

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 Details

ROLE

public static final String ROLE

The avalon role

_sourceResolver

protected SourceResolver _sourceResolver

the source resolver

_i18nUtils

protected I18nUtils _i18nUtils

the i18n utils component

_serviceEP

protected ServiceExtensionPoint _serviceEP

the service extension point

_observationManager

protected ObservationManager _observationManager

the observation manager

_workflowHelper

protected ContentWorkflowHelper _workflowHelper

the workflow helper

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

the current user provider

_pageDAO

protected PageDAO _pageDAO

the page dao

_profileAssignementStorageEP

protected ProfileAssignmentStorageExtensionPoint _profileAssignementStorageEP

the profile assignment storage extension point

_skinsManager

protected SkinsManager _skinsManager

the skins manager

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

the content type extension point

_saxParser

protected SAXParser _saxParser

Excalibur SaxParser

Constructor Details

PagePopulator

public PagePopulator()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initPage

public Optional<ModifiablePage> initPage(ModifiableSitemapElement parent,
 String path)
                                  throws IOException,
SAXException,
ConfigurationException

Create a new page based on a configuration file.

Parameters:

parent - the parent where the page should be inserted

path - the path where the configuration can be found

Returns:

the newly created page or Optional#empty() if no page was created.

Throws:

IOException - if an error occurred while reading the file

SAXException - if an error occurred while parsing the configuration file

ConfigurationException - if the configuration is not valid; A required info is missing.

initPage

public Optional<ModifiablePage> initPage(ModifiableSitemapElement parent,
 Configuration configuration)
                                  throws ConfigurationException

Create and configure a new page based on a configuration.

Parameters:

parent - the parent where the page should be added

configuration - the page configuration

Returns:

the newly created page or Optional#empty() if no page was created.

Throws:

ConfigurationException - if the configuration is not valid; A required info is missing.

createPage

protected Optional<ModifiablePage> createPage(ModifiableSitemapElement parent,
 Configuration configuration)
                                       throws ConfigurationException

Create a new page based on a configuration.

Parameters:

parent - the sitemap element where the page should be added

configuration - the page configuration

Returns:

the newly created page or Optional#empty() if the page already exist.

Throws:

ConfigurationException - if the configuration is not valid; A required info is missing.

configurePage

protected void configurePage(ModifiablePage newPage,
 Configuration configuration)
                      throws ConfigurationException

Use a configuration to edit a page. Via configuration, it's possible to define the page tags, template and zone items (service or content)

Parameters:

newPage - the page that needs configuration

configuration - the configuration describing the expected page

Throws:

ConfigurationException - if the configuration is not valid

createAndConfigureZone

protected void createAndConfigureZone(ModifiablePage newPage,
 Configuration zoneCfg)
                               throws ConfigurationException

Create and configure a zone based on configuration

Parameters:

newPage - the new page where the zone should be added

zoneCfg - the configuration to use

Throws:

ConfigurationException - if the configuration is invalid

createAndConfigureServiceItem

protected void createAndConfigureServiceItem(ModifiableZone zone,
 Configuration serviceCfg)
                                      throws ConfigurationException

Create and configure a zone item based on a service configuration

Parameters:

zone - the zone where the zone item should be added

serviceCfg - the configuration to use

Throws:

ConfigurationException - if the configuration is invalid

createAndConfigureContentItem

protected void createAndConfigureContentItem(ModifiableZone zone,
 Configuration contentCfg)
                                      throws ConfigurationException

Create a new content based on configuration and add it to a new zone item

Parameters:

zone - the zone where the zone item should be added

contentCfg - the configuration to use

Throws:

ConfigurationException - if the configuration is invalid

setReaderAccess

protected void setReaderAccess(ModifiablePage newPage,
 Configuration configuration)
                        throws ConfigurationException

Set page reader access based on configuration

Parameters:

newPage - the newly created page

configuration - the page configuration

Throws:

ConfigurationException - if an unrecognized group is present in configuration

_notifyACLChange

protected void _notifyACLChange(Object context,
 Set<String> profilesId)

Utility method to notify a change of ACL on a context

Parameters:

context - the impacted context

profilesId - the assigned or removed profiles