org.opencms.module

类 CmsModuleImportExportHandler

java.lang.Object

org.opencms.module.CmsModuleImportExportHandler

所有已实现的接口:

I_CmsImportExportHandler

public class CmsModuleImportExportHandler
extends java.lang.Object
implements I_CmsImportExportHandler

Import/export handler implementation for Cms modules.

从以下版本开始:

6.0.0

构造器概要

构造器

构造器和说明
CmsModuleImportExportHandler() Creates a new Cms module import/export handler.

方法概要

方法

限定符和类型	方法和说明
void	exportData(CmsObject cms, I_CmsReport report) Exports the data from the Cms.
java.util.List<java.lang.String>	getAdditionalResources() Returns the VFS resources to be exported additionally with the module.
java.lang.String	getDescription() Returns the description of this import/export handler.
java.lang.String	getFileName() Returns the name of the export file in the real file system.
CmsImportParameters	getImportParameters() Returns the import parameters.
java.lang.String	getModuleName() Returns the (package) name of the module to be exported.
java.util.List<java.lang.String>	getResourcesAsList() Returns the VFS resources to be exported additionally with the module as a list.
void	importData(CmsObject cms, I_CmsReport report) Imports the data into the Cms.
void	importData(CmsObject cms, java.lang.String importFile, java.lang.String importPath, I_CmsReport report) 已过时。 use importData(CmsObject, I_CmsReport) instead
boolean	matches(org.dom4j.Document manifest) Checks, if this import/export handler matches with a specified manifest document of an import, so that it is able to import the data listed in the manifest document.
static CmsModule	readModuleFromImport(java.lang.String importResource) Reads a module object from an external file source.
void	setAdditionalResources(java.lang.String[] resources) Sets the VFS resources to be exported additionally with the module.
void	setDescription(java.lang.String description) Sets the description of this import/export handler.
void	setFileName(java.lang.String fileName) Sets the name of the export file in the real file system.
void	setImportParameters(CmsImportParameters importParams) Sets the import parameters.
void	setModule(CmsModuleXmlHandler moduleHandler) Will be called by the digester if a module was imported.
void	setModuleName(java.lang.String moduleName) Sets the (package) name of the module to be exported.

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

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

构造器详细资料

CmsModuleImportExportHandler

public CmsModuleImportExportHandler()

Creates a new Cms module import/export handler.

方法详细资料

readModuleFromImport

public static CmsModule readModuleFromImport(java.lang.String importResource)
                                      throws CmsConfigurationException

Reads a module object from an external file source.

参数:

importResource - the name of the input source

返回:

the imported module

抛出:

CmsConfigurationException - if the module could not be imported

exportData

public void exportData(CmsObject cms,
              I_CmsReport report)
                throws CmsConfigurationException,
                       CmsImportExportException,
                       CmsRoleViolationException

从接口复制的说明: I_CmsImportExportHandler

Exports the data from the Cms.

指定者:

exportData 在接口中 I_CmsImportExportHandler

参数:

cms - the current OpenCms context object

report - a Cms report to print log messages

抛出:

CmsConfigurationException - if a specified module to be exported does not exist

CmsImportExportException - if operation was not successful

CmsRoleViolationException - if the current user has not the required role

另请参阅:

I_CmsImportExportHandler.exportData(org.opencms.file.CmsObject, org.opencms.report.I_CmsReport)

getAdditionalResources

public java.util.List<java.lang.String> getAdditionalResources()

Returns the VFS resources to be exported additionally with the module.

返回:

the VFS resources to be exported additionally with the module

getDescription

public java.lang.String getDescription()

从接口复制的说明: I_CmsImportExportHandler

Returns the description of this import/export handler.

The description is useful to print some info about the purpose of this handler.

指定者:

getDescription 在接口中 I_CmsImportExportHandler

返回:

the description of this import/export handler

另请参阅:

I_CmsImportExportHandler.getDescription()

getFileName

public java.lang.String getFileName()

Returns the name of the export file in the real file system.

返回:

the name of the export file in the real file system

getImportParameters

public CmsImportParameters getImportParameters()

Returns the import parameters.

指定者:

getImportParameters 在接口中 I_CmsImportExportHandler

返回:

the import parameters

getModuleName

public java.lang.String getModuleName()

Returns the (package) name of the module to be exported.

返回:

the (package) name of the module to be exported

getResourcesAsList

public java.util.List<java.lang.String> getResourcesAsList()

Returns the VFS resources to be exported additionally with the module as a list.

返回:

the VFS resources to be exported additionally with the module as a list

importData

public void importData(CmsObject cms,
              I_CmsReport report)
                throws CmsXmlException,
                       CmsImportExportException,
                       CmsRoleViolationException,
                       CmsException

从接口复制的说明: I_CmsImportExportHandler

Imports the data into the Cms.

指定者:

importData 在接口中 I_CmsImportExportHandler

参数:

cms - the current OpenCms context object

report - a Cms report to print log messages

抛出:

CmsXmlException - if the manifest of the import could not be unmarshalled

CmsImportExportException - if operation was not successful

CmsRoleViolationException - if the current user has not the required role

CmsException - in case of errors accessing the VFS

另请参阅:

I_CmsImportExportHandler.importData(CmsObject, I_CmsReport)

importData

@Deprecated
public void importData(CmsObject cms,
                         java.lang.String importFile,
                         java.lang.String importPath,
                         I_CmsReport report)
                throws CmsXmlException,
                       CmsImportExportException,
                       CmsRoleViolationException,
                       CmsException

已过时。 use importData(CmsObject, I_CmsReport) instead

从接口复制的说明: I_CmsImportExportHandler

Imports the data into the Cms.

指定者:

importData 在接口中 I_CmsImportExportHandler

参数:

cms - the current OpenCms context object

importFile - the name (absolute path) of the resource (zip file or folder) to be imported

importPath - the name (absolute path) of the destination folder in the Cms (if required)

report - a Cms report to print log messages

抛出:

CmsXmlException - if the manifest of the import could not be unmarshalled

CmsImportExportException - if operation was not successful

CmsRoleViolationException - if the current user has not the required role

CmsException - in case of errors accessing the VFS

另请参阅:

I_CmsImportExportHandler.importData(org.opencms.file.CmsObject, java.lang.String, java.lang.String, org.opencms.report.I_CmsReport)

matches

public boolean matches(org.dom4j.Document manifest)

从接口复制的说明: I_CmsImportExportHandler

Checks, if this import/export handler matches with a specified manifest document of an import, so that it is able to import the data listed in the manifest document.

指定者:

matches 在接口中 I_CmsImportExportHandler

参数:

manifest - the manifest.xml of the import as a dom4j XML document

返回:

true, this handler is able to import the data listed in the manifest document

另请参阅:

I_CmsImportExportHandler.matches(org.dom4j.Document)

setAdditionalResources

public void setAdditionalResources(java.lang.String[] resources)

Sets the VFS resources to be exported additionally with the module.

参数:

resources - the VFS resources to be exported additionally with the module

setDescription

public void setDescription(java.lang.String description)

从接口复制的说明: I_CmsImportExportHandler

Sets the description of this import/export handler.

The description is useful to print some info about the purpose of this handler.

指定者:

setDescription 在接口中 I_CmsImportExportHandler

参数:

description - the description of this import/export handler

另请参阅:

I_CmsImportExportHandler.setDescription(java.lang.String)

setFileName

public void setFileName(java.lang.String fileName)

Sets the name of the export file in the real file system.

参数:

fileName - the name of the export file in the real file system

setImportParameters

public void setImportParameters(CmsImportParameters importParams)

Sets the import parameters.

指定者:

setImportParameters 在接口中 I_CmsImportExportHandler

参数:

importParams - the parameters to set

setModule

public void setModule(CmsModuleXmlHandler moduleHandler)

Will be called by the digester if a module was imported.

参数:

moduleHandler - contains the imported module

setModuleName

public void setModuleName(java.lang.String moduleName)

Sets the (package) name of the module to be exported.

参数:

moduleName - the (package) name of the module to be exported