org.opencms.staticexport

类 CmsAfterPublishStaticExportHandler

java.lang.Object

org.opencms.staticexport.A_CmsStaticExportHandler

org.opencms.staticexport.CmsAfterPublishStaticExportHandler

所有已实现的接口:

I_CmsStaticExportHandler

直接已知子类:

CmsAfterPublishMultiLanguageStaticExportHandler

public class CmsAfterPublishStaticExportHandler
extends A_CmsStaticExportHandler

Implementation for the I_CmsStaticExportHandler interface.

This handler exports all changes immediately after something is published.

从以下版本开始:

6.0.0

另请参阅:

I_CmsStaticExportHandler

字段概要

从类继承的字段 org.opencms.staticexport.A_CmsStaticExportHandler

m_busy

构造器概要

构造器

构造器和说明
CmsAfterPublishStaticExportHandler()

方法概要

方法

限定符和类型	方法和说明
void	doExportAfterPublish(java.util.List<CmsPublishedResource> resources, I_CmsReport report) Does the actual static export.
protected void	exportAfterPublish(CmsUUID publishHistoryId, I_CmsReport report) Starts the static export on publish.
protected boolean	exportNonTemplateResources(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources, I_CmsReport report) Exports all non template resources found in a list of published resources.
protected int	exportTemplateResource(CmsStaticExportData data, java.lang.StringBuffer cookies) Exports a single (template) resource specified by its export data.
protected void	exportTemplateResources(CmsObject cms, java.util.List<java.lang.String> publishedTemplateResources, I_CmsReport report) Exports all template resources found in a list of published resources.
java.util.List<CmsPublishedResource>	getAllResources(CmsObject cms) Returns all resources within the current OpenCms site that are not marked as internal.
protected java.util.List<java.io.File>	getRelatedFilesToPurge(java.lang.String exportFileName, java.lang.String vfsName) Returns a list of related files to purge.
protected java.util.List<CmsPublishedResource>	getRelatedResources(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources) Creates a list of CmsPublishedResource objects containing all related resources of the VFS tree.
protected java.util.Set<CmsPublishedResource>	getSiblings(CmsObject cms, CmsPublishedResource pubResource) Returns all siblings of the published resource as list of CmsPublishedResource.
void	performEventPublishProject(CmsUUID publishHistoryId, I_CmsReport report) Scrubs files from the export folder that might have been changed.
protected boolean	readNonTemplateResourcesToExport(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources, java.util.List<CmsStaticExportData> resourcesToExport) Returns all non template resources found in a list of published resources.

从类继承的方法 org.opencms.staticexport.A_CmsStaticExportHandler

addMovedLinkSources, getSiblingsList, isBusy, purgeFile, scrubExportFolders, scrubResource

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CmsAfterPublishStaticExportHandler

public CmsAfterPublishStaticExportHandler()

方法详细资料

doExportAfterPublish

public void doExportAfterPublish(java.util.List<CmsPublishedResource> resources,
                        I_CmsReport report)
                          throws CmsException,
                                 java.io.IOException,
                                 javax.servlet.ServletException

Does the actual static export.

参数:

resources - a list of CmsPublishedREsources to start the static export with

report - an I_CmsReport instance to print output message, or null to write messages to the log file

抛出:

CmsException - in case of errors accessing the VFS

java.io.IOException - in case of errors writing to the export output stream

javax.servlet.ServletException - in case of errors accessing the servlet

getAllResources

public java.util.List<CmsPublishedResource> getAllResources(CmsObject cms)
                                                     throws CmsException

Returns all resources within the current OpenCms site that are not marked as internal.

The result list contains objects of type CmsPublishedResource.

参数:

cms - the cms context

返回:

all resources within the current OpenCms site that are not marked as internal

抛出:

CmsException - if something goes wrong

performEventPublishProject

public void performEventPublishProject(CmsUUID publishHistoryId,
                              I_CmsReport report)

从接口复制的说明: I_CmsStaticExportHandler

Scrubs files from the export folder that might have been changed.

指定者:

performEventPublishProject 在接口中 I_CmsStaticExportHandler

指定者:

performEventPublishProject 在类中 A_CmsStaticExportHandler

参数:

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

另请参阅:

I_CmsStaticExportHandler.performEventPublishProject(org.opencms.util.CmsUUID, org.opencms.report.I_CmsReport)

exportAfterPublish

protected void exportAfterPublish(CmsUUID publishHistoryId,
                      I_CmsReport report)
                           throws CmsException,
                                  java.io.IOException,
                                  javax.servlet.ServletException

Starts the static export on publish.

Exports all modified resources after a publish process into the real FS.

参数:

publishHistoryId - the publichHistoryId of the published project

report - an I_CmsReport instance to print output message, or null to write messages to the log file

抛出:

CmsException - in case of errors accessing the VFS

java.io.IOException - in case of errors writing to the export output stream

javax.servlet.ServletException - in case of errors accessing the servlet

exportNonTemplateResources

protected boolean exportNonTemplateResources(CmsObject cms,
                                 java.util.List<CmsPublishedResource> publishedResources,
                                 I_CmsReport report)
                                      throws CmsException,
                                             java.io.IOException,
                                             javax.servlet.ServletException

Exports all non template resources found in a list of published resources.

参数:

cms - the current cms object

publishedResources - the list of published resources

report - an I_CmsReport instance to print output message, or null to write messages to the log file

返回:

true if some template resources were found while looping the list of published resources

抛出:

CmsException - in case of errors accessing the VFS

java.io.IOException - in case of errors writing to the export output stream

javax.servlet.ServletException - in case of errors accessing the servlet

exportTemplateResource

protected int exportTemplateResource(CmsStaticExportData data,
                         java.lang.StringBuffer cookies)
                              throws java.io.IOException

Exports a single (template) resource specified by its export data.

参数:

data - the export data

cookies - cookies to keep the session

返回:

the status of the http request used to perform the export

抛出:

java.io.IOException - if the http request fails

exportTemplateResources

protected void exportTemplateResources(CmsObject cms,
                           java.util.List<java.lang.String> publishedTemplateResources,
                           I_CmsReport report)

Exports all template resources found in a list of published resources.

参数:

cms - the cms context, in the root site as Export user

publishedTemplateResources - list of potential candidates to export

report - an I_CmsReport instance to print output message, or null to write messages to the log file

getRelatedFilesToPurge

protected java.util.List<java.io.File> getRelatedFilesToPurge(java.lang.String exportFileName,
                                                  java.lang.String vfsName)

从类复制的说明: A_CmsStaticExportHandler

Returns a list of related files to purge.

指定者:

getRelatedFilesToPurge 在类中 A_CmsStaticExportHandler

参数:

exportFileName - the previous exported rfs filename (already purged)

vfsName - the vfs name of the resource (to be used to compute more sofisticated sets of related files to purge

返回:

a list of related files to purge

另请参阅:

A_CmsStaticExportHandler.getRelatedFilesToPurge(java.lang.String, java.lang.String)

getRelatedResources

protected java.util.List<CmsPublishedResource> getRelatedResources(CmsObject cms,
                                                       java.util.List<CmsPublishedResource> publishedResources)
                                                            throws CmsException

Creates a list of CmsPublishedResource objects containing all related resources of the VFS tree.

If the static export has been triggered by the OpenCms workplace, publishedResources is null and all resources in the VFS tree are returned.

If really an after publish static export is triggered, then only the related resources are returned.

参数:

cms - the current cms object

publishedResources - the list of published resources

返回:

list of CmsPulishedResource objects containing all resources of the VFS tree

抛出:

CmsException - in case of errors accessing the VFS

getSiblings

protected java.util.Set<CmsPublishedResource> getSiblings(CmsObject cms,
                                              CmsPublishedResource pubResource)
                                                   throws CmsException

Returns all siblings of the published resource as list of CmsPublishedResource.

参数:

cms - the cms object

pubResource - the published resource

返回:

all siblings of the published resource

抛出:

CmsException - if something goes wrong

readNonTemplateResourcesToExport

protected boolean readNonTemplateResourcesToExport(CmsObject cms,
                                       java.util.List<CmsPublishedResource> publishedResources,
                                       java.util.List<CmsStaticExportData> resourcesToExport)
                                            throws CmsException

Returns all non template resources found in a list of published resources.

参数:

cms - the current cms object

publishedResources - the list of published resources

resourcesToExport - the list of non-template resources

返回:

true if some template resources were found while looping the list of published resources

抛出:

CmsException - in case of errors accessing the VFS