org.opencms.staticexport

类 A_CmsStaticExportHandler

java.lang.Object

org.opencms.staticexport.A_CmsStaticExportHandler

所有已实现的接口:

I_CmsStaticExportHandler

直接已知子类:

A_CmsOnDemandStaticExportHandler, CmsAfterPublishStaticExportHandler

public abstract class A_CmsStaticExportHandler
extends java.lang.Object
implements I_CmsStaticExportHandler

Abstract base implementation for the I_CmsStaticExportHandler interface.

This class provides several util methods to be used by static export handlers.

从以下版本开始:

6.1.7

另请参阅:

I_CmsStaticExportHandler

字段概要

字段

限定符和类型	字段和说明
protected boolean	m_busy Indicates if this content handler is busy.

构造器概要

构造器

构造器和说明
A_CmsStaticExportHandler()

方法概要

方法

限定符和类型	方法和说明
protected java.util.List<CmsPublishedResource>	addMovedLinkSources(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources) Add the link sources of moved resources to the list of published resources.
protected abstract 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<java.lang.String>	getSiblingsList(CmsObject cms, java.lang.String resPath) Returns a list containing the root paths of all siblings of a resource.
boolean	isBusy() Returns true if this static export handler is currently performing a static export operation.
abstract void	performEventPublishProject(CmsUUID publishHistoryId, I_CmsReport report) Scrubs files from the export folder that might have been changed.
protected void	purgeFile(java.lang.String rfsFilePath, java.lang.String vfsName) Deletes the given file from the RFS if it exists, also deletes all parameter variations of the file.
java.util.List<CmsPublishedResource>	scrubExportFolders(CmsUUID publishHistoryId) Scrubs all files from the export folder that might have been changed, so that the export is newly created after the next request to the resource.
protected void	scrubResource(CmsObject cms, CmsPublishedResource res, java.util.Set<java.lang.String> scrubbedFolders, java.util.Set<java.lang.String> scrubbedFiles) Scrub a single file or folder.

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

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

字段详细资料

m_busy

protected boolean m_busy

Indicates if this content handler is busy.

构造器详细资料

A_CmsStaticExportHandler

public A_CmsStaticExportHandler()

方法详细资料

isBusy

public boolean isBusy()

从接口复制的说明: I_CmsStaticExportHandler

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

指定者:

isBusy 在接口中 I_CmsStaticExportHandler

返回:

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

另请参阅:

I_CmsStaticExportHandler.isBusy()

performEventPublishProject

public abstract void performEventPublishProject(CmsUUID publishHistoryId,
                              I_CmsReport report)

从接口复制的说明: I_CmsStaticExportHandler

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

指定者:

performEventPublishProject 在接口中 I_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)

scrubExportFolders

public java.util.List<CmsPublishedResource> scrubExportFolders(CmsUUID publishHistoryId)

Scrubs all files from the export folder that might have been changed, so that the export is newly created after the next request to the resource.

参数:

publishHistoryId - id of the last published project

返回:

the list of CmsPublishedResource objects to export

addMovedLinkSources

protected java.util.List<CmsPublishedResource> addMovedLinkSources(CmsObject cms,
                                                       java.util.List<CmsPublishedResource> publishedResources)

Add the link sources of moved resources to the list of published resources.

参数:

cms - the cms context

publishedResources - the published resources

返回:

the list of published resources included the link sources of moved resources

getRelatedFilesToPurge

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

Returns a list of related files to purge.

参数:

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

getSiblingsList

protected java.util.List<java.lang.String> getSiblingsList(CmsObject cms,
                                               java.lang.String resPath)

Returns a list containing the root paths of all siblings of a resource.

参数:

cms - the export user context

resPath - the path of the resource to get the siblings for

返回:

a list containing the root paths of all siblings of a resource

purgeFile

protected void purgeFile(java.lang.String rfsFilePath,
             java.lang.String vfsName)

Deletes the given file from the RFS if it exists, also deletes all parameter variations of the file.

参数:

rfsFilePath - the path of the RFS file to delete

vfsName - the VFS name of the file to delete (required for logging)

scrubResource

protected void scrubResource(CmsObject cms,
                 CmsPublishedResource res,
                 java.util.Set<java.lang.String> scrubbedFolders,
                 java.util.Set<java.lang.String> scrubbedFiles)

Scrub a single file or folder.

参数:

cms - an export cms object

res - the resource to check

scrubbedFolders - the list of already scrubbed folders

scrubbedFiles - the list of already scrubbed files