Package org.ametys.web.live
Interface LivePopulator
- All Known Implementing Classes:
ContentsLivePopulator
,PluginsLivePopulator
,SitesLivePopulator
public interface LivePopulator
Component called on each rebuild of the live workspace.
-
Method Summary
Modifier and TypeMethodDescriptiongetLabel()
A readable label of the populatorReturn a logger for the progression trackerpopulate
(javax.jcr.Session session, javax.jcr.Session liveSession) Populates the live workspace.populate
(javax.jcr.Session session, javax.jcr.Session liveSession, ContainerProgressionTracker progressionTracker) Populates the live workspace.
-
Method Details
-
getProgressionTrackerLogger
Return a logger for the progression tracker- Returns:
- The logger
-
getLabel
A readable label of the populator- Returns:
- A non null value
-
populate
default List<String> populate(javax.jcr.Session session, javax.jcr.Session liveSession) throws Exception Populates the live workspace.- Parameters:
session
- the session on the default workspace.liveSession
- the session on the live workspace.- Returns:
- A list of error technical messages. A message can use \n for carriage return.
- Throws:
Exception
- if an error occurs.
-
populate
List<String> populate(javax.jcr.Session session, javax.jcr.Session liveSession, ContainerProgressionTracker progressionTracker) throws Exception Populates the live workspace.- 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.
-