001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.staticexport;
029
030import org.opencms.report.I_CmsReport;
031import org.opencms.util.CmsUUID;
032
033/**
034 * Provides a method
035 * for scrubbing files from the export folder that might have been changed,
036 * so that the export is newly created after the next request to the resource.<p>
037 *
038 * @since 6.0.0
039 */
040public interface I_CmsStaticExportHandler {
041
042    /**
043     * Returns <code>true</code> if this static export handler is currently
044     * performing a static export operation.<p>
045     *
046     * @return <code>true</code> if this static export handler is currently
047     *              performing a static export operation
048     */
049    boolean isBusy();
050
051    /**
052     * Scrubs files from the export folder that might have been changed.
053     *
054     * @param publishHistoryId the <code>{@link CmsUUID}</code> of the published project
055     * @param report an <code>{@link I_CmsReport}</code> instance to print output message,
056     *              or <code>null</code> to write messages to the log file
057     */
058    void performEventPublishProject(CmsUUID publishHistoryId, I_CmsReport report);
059}