001/*
002 *  Copyright 2010 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016
017package org.ametys.web.live;
018
019import java.util.List;
020
021import javax.jcr.Session;
022
023/**
024 * Component called on each rebuild of the live workspace.
025 */
026public interface LivePopulator
027{
028    /**
029     * Populates the live workspace.
030     * @param session the session on the default workspace.
031     * @param liveSession the session on the live workspace.
032     * @return A list of error technical messages. A message can use \n for carriage return.
033     * @throws Exception if an error occurs.
034     */
035    public List<String> populate(Session session, Session liveSession) throws Exception;
036}