Package org.opencms.staticexport

Interface I_CmsStaticExportHandler

All Known Implementing Classes:
A_CmsOnDemandStaticExportHandler, A_CmsStaticExportHandler, CmsAfterPublishMultiLanguageStaticExportHandler, CmsAfterPublishStaticExportHandler, CmsOnDemandHtmlSubTreeHandler, CmsOnDemandStaticExportHandler
public interface I_CmsStaticExportHandler
Provides a method for scrubbing files from the export folder that might have been changed, so that the export is newly created after the next request to the resource.

Since:
6.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isBusy()
    Returns true if this static export handler is currently performing a static export operation.
    void
    performEventPublishProject(CmsUUID publishHistoryId, I_CmsReport report)
    Scrubs files from the export folder that might have been changed.

  • Method Details

    • isBusy

      boolean isBusy()
      Returns true if this static export handler is currently performing a static export operation.

      Returns:
      true if this static export handler is currently performing a static export operation

    • performEventPublishProject

      void performEventPublishProject(CmsUUID publishHistoryId, I_CmsReport report)
      Scrubs files from the export folder that might have been changed.
      Parameters:
      publishHistoryId - the CmsUUID of the published project
      report - an I_CmsReport instance to print output message, or null to write messages to the log file