org.opencms.db

类 CmsImportFolder

java.lang.Object

org.opencms.db.CmsImportFolder

public class CmsImportFolder
extends java.lang.Object

Allows to import resources from the filesystem or a ZIP file into the OpenCms VFS.

从以下版本开始:

6.0.0

构造器概要

构造器

构造器和说明
CmsImportFolder() Default Constructor.
CmsImportFolder(byte[] content, java.lang.String importPath, CmsObject cms, boolean noSubFolder) Constructor for a new CmsImportFolder that will read from a ZIP file.
CmsImportFolder(java.lang.String importFolderName, java.lang.String importPath, CmsObject cms) Constructor for a new CmsImportFolder that will read from the real file system.

方法概要

方法

限定符和类型	方法和说明
java.util.List<CmsResource>	getImportedResources() Returns the list of imported resources.
void	importFolder(java.lang.String importFolderName, java.lang.String importPath, CmsObject cms) Import that will read from the real file system.
void	importZip(byte[] content, java.lang.String importPath, CmsObject cms, boolean noSubFolder) Import that will read from a ZIP file.
boolean	isValidZipFile() Returns true if a valid ZIP file was imported.

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

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

构造器详细资料

CmsImportFolder

public CmsImportFolder()

Default Constructor.

CmsImportFolder

public CmsImportFolder(byte[] content,
               java.lang.String importPath,
               CmsObject cms,
               boolean noSubFolder)
                throws CmsException

Constructor for a new CmsImportFolder that will read from a ZIP file.

参数:

content - the zip file to import

importPath - the path to the OpenCms VFS to import to

cms - a OpenCms context to provide the permissions

noSubFolder - if true no sub folders will be created, if false the content of the zip file is created 1:1 inclusive sub folders

抛出:

CmsException - if something goes wrong

CmsImportFolder

public CmsImportFolder(java.lang.String importFolderName,
               java.lang.String importPath,
               CmsObject cms)
                throws CmsException

Constructor for a new CmsImportFolder that will read from the real file system.

参数:

importFolderName - the folder to import

importPath - the path to the OpenCms VFS to import to

cms - a OpenCms context to provide the permissions

抛出:

CmsException - if something goes wrong

方法详细资料

getImportedResources

public java.util.List<CmsResource> getImportedResources()

Returns the list of imported resources.

返回:

the list of imported resources

importFolder

public void importFolder(java.lang.String importFolderName,
                java.lang.String importPath,
                CmsObject cms)
                  throws CmsException

Import that will read from the real file system.

参数:

importFolderName - the folder to import

importPath - the path to the OpenCms VFS to import to

cms - a OpenCms context to provide the permissions

抛出:

CmsException - if something goes wrong

importZip

public void importZip(byte[] content,
             java.lang.String importPath,
             CmsObject cms,
             boolean noSubFolder)
               throws CmsException

Import that will read from a ZIP file.

参数:

content - the zip file to import

importPath - the path to the OpenCms VFS to import to

cms - a OpenCms context to provide the permissions

noSubFolder - if true no sub folders will be created, if false the content of the zip file is created 1:1 inclusive sub folders

抛出:

CmsException - if something goes wrong

isValidZipFile

public boolean isValidZipFile()

Returns true if a valid ZIP file was imported.

返回:

true if a valid ZIP file was imported