KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > staticexport > I_CmsStaticExportHandler


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/staticexport/I_CmsStaticExportHandler.java,v $
3  * Date : $Date: 2005/06/23 11:11:28 $
4  * Version: $Revision: 1.9 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.staticexport;
33
34 import org.opencms.report.I_CmsReport;
35 import org.opencms.util.CmsUUID;
36
37 /**
38  * Provides a method
39  * for scrubbing files from the export folder that might have been changed,
40  * so that the export is newly created after the next request to the resource.<p>
41  *
42  * @author Michael Moossen
43  *
44  * @version $Revision: 1.9 $
45  *
46  * @since 6.0.0
47  */
48 public interface I_CmsStaticExportHandler {
49
50     /**
51      * Returns <code>true</code> if this static export handler is currently
52      * performing a static export operation.<p>
53      *
54      * @return <code>true</code> if this static export handler is currently
55      * performing a static export operation
56      */
57     boolean isBusy();
58
59     /**
60      * Scrubs files from the export folder that might have been changed.
61      *
62      * @param publishHistoryId the <code>{@link CmsUUID}</code> of the published project
63      * @param report an <code>{@link I_CmsReport}</code> instance to print output message,
64      * or <code>null</code> to write messages to the log file
65      */
66     void performEventPublishProject(CmsUUID publishHistoryId, I_CmsReport report);
67 }
Popular Tags