Package org.ametys.web.live

Class ContentsLivePopulator

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.live.ContentsLivePopulator

All Implemented Interfaces:

LogEnabled, LivePopulator, Serviceable

Direct Known Subclasses:

PluginsLivePopulator

public class ContentsLivePopulator
extends AbstractLogEnabled
implements LivePopulator, Serviceable

LivePopulator for synchronizing '/ametys:root/ametys:contents'.

Field Summary

Fields

Modifier and Type	Field	Description
protected I18nUtils	_i18nUtils	The utils for i18n
protected AmetysObjectResolver	_resolver	The Ametys resolver
protected SynchronizeComponent	_synchronizeHelper	The synchronize helper

Constructor Summary

Constructors

Constructor	Description
ContentsLivePopulator()

Method Summary

Modifier and Type	Method	Description
protected void	_cloneContents(javax.jcr.Node contentsNode, javax.jcr.Session liveSession, SimpleProgressionTracker progressionTracker)	Clone contents in live workspace
protected AmetysObjectIterable<Content>	_getContents(javax.jcr.Node contentsNode)	Get the contents of root contents node
I18nizableText	getLabel()	A readable label of the populator
Logger	getProgressionTrackerLogger()	Return a logger for the progression tracker
List<String>	populate(javax.jcr.Session session, javax.jcr.Session liveSession, ContainerProgressionTracker progressionTracker)	Populates the live workspace.
void	service(ServiceManager smanager)

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.web.live.LivePopulator

populate

Field Details

_synchronizeHelper

protected SynchronizeComponent _synchronizeHelper

The synchronize helper

_resolver

protected AmetysObjectResolver _resolver

The Ametys resolver

_i18nUtils

protected I18nUtils _i18nUtils

The utils for i18n

Constructor Details

ContentsLivePopulator

public ContentsLivePopulator()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getLabel

public I18nizableText getLabel()

Description copied from interface: LivePopulator

A readable label of the populator

Specified by:

getLabel in interface LivePopulator

Returns:

A non null value

getProgressionTrackerLogger

public Logger getProgressionTrackerLogger()

Description copied from interface: LivePopulator

Return a logger for the progression tracker

Specified by:

getProgressionTrackerLogger in interface LivePopulator

Returns:

The logger

populate

public List<String> populate(javax.jcr.Session session,
 javax.jcr.Session liveSession,
 ContainerProgressionTracker progressionTracker)
                      throws Exception

Description copied from interface: LivePopulator

Populates the live workspace.

Specified by:

populate in interface LivePopulator

Parameters:

session - the session on the default workspace.

liveSession - the session on the live workspace.

progressionTracker - The static progression tracker

Returns:

A list of error technical messages. A message can use \n for carriage return.

Throws:

Exception - if an error occurs.

_cloneContents

protected void _cloneContents(javax.jcr.Node contentsNode,
 javax.jcr.Session liveSession,
 SimpleProgressionTracker progressionTracker)
                       throws javax.jcr.RepositoryException

Clone contents in live workspace

Parameters:

contentsNode - The root contents node

liveSession - The live session

progressionTracker - The progression tracker

Throws:

javax.jcr.RepositoryException - if failed to clone contents in live

_getContents

protected AmetysObjectIterable<Content> _getContents(javax.jcr.Node contentsNode)
                                              throws javax.jcr.RepositoryException

Get the contents of root contents node

Parameters:

contentsNode - The root contents node

Returns:

The child contents

Throws:

javax.jcr.RepositoryException - if failed to get the child contents