org.opencms.synchronize

接口 I_CmsSynchronizeModification

public interface I_CmsSynchronizeModification

Defines methods which can be pluged into the syncronisation process between VFS and "real" FS.

从以下版本开始:

6.0.0

方法概要

方法

限定符和类型	方法和说明
void	modifyFs(CmsObject cms, CmsResource vfsRes, java.io.File fsFile) Possibility to modify a resource after it has benn exported or updated to the FS.
void	modifyVfs(CmsObject cms, CmsResource vfsRes, java.io.File fsFile) Possibility to modify a resource after it has been imported or updated into the VFS.
java.lang.String	translate(CmsObject cms, java.lang.String resName) Translates the resource name.

方法详细资料

modifyFs

void modifyFs(CmsObject cms,
            CmsResource vfsRes,
            java.io.File fsFile)
              throws CmsSynchronizeException

Possibility to modify a resource after it has benn exported or updated to the FS.

参数:

cms - the current CmsObject

vfsRes - the resource in the VFS

fsFile - the resource in the FS

抛出:

CmsSynchronizeException - if something goes wrong

modifyVfs

void modifyVfs(CmsObject cms,
             CmsResource vfsRes,
             java.io.File fsFile)
               throws CmsSynchronizeException

Possibility to modify a resource after it has been imported or updated into the VFS.

参数:

cms - the current CmsObject

vfsRes - the resource in the VFS

fsFile - the resource in the FS

抛出:

CmsSynchronizeException - if something goes wrong

translate

java.lang.String translate(CmsObject cms,
                         java.lang.String resName)
                           throws CmsSynchronizeException

Translates the resource name.

This is nescessary since the server FS does allow different naming conventions than the VFS. If no special translation is required and the default OpenCms FS-VFS translation should be used, null must be returned.

参数:

cms - the current CmsObject

resName - the resource name to be translated

返回:

the translated resource name or null

抛出:

CmsSynchronizeException - if something goes wrong