org.opencms.db
Class CmsImportFolder

java.lang.Object
  org.opencms.db.CmsImportFolder

public class CmsImportFolder
extends Object

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

Since:

6.0.0

Constructor Summary

CmsImportFolder()
Default Constructor.

CmsImportFolder(byte[] content, String importPath, CmsObject cms, boolean noSubFolder)
Constructor for a new CmsImportFolder that will read from a ZIP file.

CmsImportFolder(String importFolderName, String importPath, CmsObject cms)
Constructor for a new CmsImportFolder that will read from the real file system.

Method Summary

List<String>	getCreatedResourceNames() Returns the names of resources that have been created or replaced during the import.
void	importFolder(String importFolderName, String importPath, CmsObject cms) Import that will read from the real file system.
void	importZip(byte[] content, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsImportFolder

public CmsImportFolder()

Default Constructor.

CmsImportFolder

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

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

Parameters:

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

Throws:

CmsException - if something goes wrong

CmsImportFolder

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

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

Parameters:

importFolderName - the folder to import

importPath - the path to the OpenCms VFS to import to

cms - a OpenCms context to provide the permissions

Throws:

CmsException - if something goes wrong

Method Detail

getCreatedResourceNames

public List<String> getCreatedResourceNames()

Returns the names of resources that have been created or replaced during the import.

Returns:

the names of resources that have been created or replaced during the import

importFolder

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

Import that will read from the real file system.

Parameters:

importFolderName - the folder to import

importPath - the path to the OpenCms VFS to import to

cms - a OpenCms context to provide the permissions

Throws:

CmsException - if something goes wrong

importZip

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

Import that will read from a ZIP file.

Parameters:

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

Throws:

CmsException - if something goes wrong

isValidZipFile

public boolean isValidZipFile()

Returns true if a valid ZIP file was imported.

Returns:

true if a valid ZIP file was imported