Package org.opencms.module

Class CmsModuleImportExportRepository

java.lang.Object

org.opencms.module.CmsModuleImportExportRepository

public class CmsModuleImportExportRepository
extends Object

Class which manages import/export of modules from repositories configured in opencms-importexport.xml.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CmsModuleImportExportRepository.ModuleExportData	Holds exported module data and a modification date.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXPORT_FOLDER_PATH	Export folder path.
static final String	IMPORT_FOLDER_PATH	Import folder path.
static final String	SUFFIX	Suffix for module zip files.

Constructor Summary

Constructors

Constructor	Description
CmsModuleImportExportRepository()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	deleteModule(String fileName)	Deletes the module corresponding to the given virtual module file name.
CmsModuleImportExportRepository.ModuleExportData	getExportedModuleData(String virtualModuleFileName, CmsProject project)	Exports a module and returns the export zip file content in a byte array.
List<String>	getModuleFileNames()	Gets the list of modules as file names.
CmsModuleLog	getModuleLog()	Gets the object used to access the module log.
void	importModule(String name, byte[] content)	Imports module data.
void	initialize(CmsObject adminCms)	Initializes the CMS context.

Methods inherited from class java.lang.Object

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

Field Details

EXPORT_FOLDER_PATH

public static final String EXPORT_FOLDER_PATH

Export folder path.

See Also:

• Constant Field Values

IMPORT_FOLDER_PATH

public static final String IMPORT_FOLDER_PATH

Import folder path.

See Also:

• Constant Field Values

SUFFIX

public static final String SUFFIX

Suffix for module zip files.

See Also:

• Constant Field Values

Constructor Details

CmsModuleImportExportRepository

public CmsModuleImportExportRepository()

Creates a new instance.

Method Details

deleteModule

public boolean deleteModule(String fileName)
                     throws CmsException

Deletes the module corresponding to the given virtual module file name.

Parameters:

fileName - the file name

Returns:

true if the module could be deleted

Throws:

CmsException - if something goes wrong

getExportedModuleData

public CmsModuleImportExportRepository.ModuleExportData getExportedModuleData(String virtualModuleFileName,
 CmsProject project)
                                                                       throws CmsException

Exports a module and returns the export zip file content in a byte array.

Parameters:

virtualModuleFileName - the virtual file name for the module

project - the project from which the module should be exported

Returns:

the module export data

Throws:

CmsException - if something goes wrong

getModuleFileNames

public List<String> getModuleFileNames()

Gets the list of modules as file names.

Returns:

the list of modules as file names

getModuleLog

public CmsModuleLog getModuleLog()

Gets the object used to access the module log.

Returns:

the module log

importModule

public void importModule(String name,
 byte[] content)
                  throws CmsException

Imports module data.

Parameters:

name - the module file name

content - the module ZIP file data

Throws:

CmsException - if something goes wrong

initialize

public void initialize(CmsObject adminCms)

Initializes the CMS context.

Parameters:

adminCms - the admin CMS context