org.opencms.importexport

类 CmsVfsImportExportHandler

java.lang.Object

org.opencms.importexport.CmsVfsImportExportHandler

所有已实现的接口:

I_CmsImportExportHandler

public class CmsVfsImportExportHandler
extends java.lang.Object
implements I_CmsImportExportHandler

Import/export handler implementation for VFS data.

从以下版本开始:

6.0.0

构造器概要

构造器

构造器和说明
CmsVfsImportExportHandler() Creates a new VFS import/export handler.

方法概要

方法

限定符和类型	方法和说明
void	exportData(CmsObject cms, I_CmsReport report) Exports the data from the Cms.
long	getContentAge() 已过时。 use setExportParams(CmsExportParameters) instead
java.lang.String	getDescription() Returns the description of this import/export handler.
CmsExportParameters	getExportParams() Returns the export parameters.
java.util.List<java.lang.String>	getExportPaths() 已过时。 use setExportParams(CmsExportParameters) instead
java.lang.String	getFileName() 已过时。 use setExportParams(CmsExportParameters) instead
CmsImportParameters	getImportParameters() Returns the import parameters.
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	isExportUserdata() 已过时。 use setExportParams(CmsExportParameters) instead
boolean	isIncludeSystem() 已过时。 use setExportParams(CmsExportParameters) instead
boolean	isIncludeUnchanged() 已过时。 use setExportParams(CmsExportParameters) instead
boolean	isProjectOnly() 已过时。 use setExportParams(CmsExportParameters) instead
boolean	isRecursive() 已过时。 use setExportParams(CmsExportParameters) 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.
void	setContentAge(long contentAge) 已过时。 use setExportParams(CmsExportParameters) instead
void	setDescription(java.lang.String description) Sets the description of this import/export handler.
void	setExportParams(CmsExportParameters exportParams) Sets the export parameters.
void	setExportPaths(java.util.List<java.lang.String> exportPaths) 已过时。 use setExportParams(CmsExportParameters) instead
void	setExportUserdata(boolean exportUserdata) 已过时。 use setExportParams(CmsExportParameters) instead
void	setFileName(java.lang.String fileName) 已过时。 use setExportParams(CmsExportParameters) instead
void	setImportParameters(CmsImportParameters importParams) Sets the import parameters.
void	setIncludeSystem(boolean excludeSystem) 已过时。 use setExportParams(CmsExportParameters) instead
void	setIncludeUnchanged(boolean excludeUnchanged) 已过时。 use setExportParams(CmsExportParameters) instead
void	setProjectOnly(boolean projectOnly) 已过时。 use setExportParams(CmsExportParameters) instead
void	setRecursive(boolean recursive) 已过时。 use setExportParams(CmsExportParameters) instead

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

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

构造器详细资料

CmsVfsImportExportHandler

public CmsVfsImportExportHandler()

Creates a new VFS import/export handler.

方法详细资料

exportData

public void exportData(CmsObject cms,
              I_CmsReport report)
                throws 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

抛出:

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)

getContentAge

@Deprecated
public long getContentAge()

已过时。 use setExportParams(CmsExportParameters) instead

Returns the timestamp to limit the resources to be exported by date.

Only resources that have been modified after this date will be exported.

返回:

the timestamp to limit the resources to be exported by date

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()

getExportParams

public CmsExportParameters getExportParams()

Returns the export parameters.

返回:

the export parameters

getExportPaths

@Deprecated
public java.util.List<java.lang.String> getExportPaths()

已过时。 use setExportParams(CmsExportParameters) instead

Returns the list with VFS paths to be exported.

返回:

the list with VFS paths to be exported

getFileName

@Deprecated
public java.lang.String getFileName()

已过时。 use setExportParams(CmsExportParameters) instead

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

importData

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

从接口复制的说明: 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

抛出:

CmsImportExportException - if operation was not successful

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

CmsRoleViolationException - if the current user has not the required role

另请参阅:

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)

isExportUserdata

@Deprecated
public boolean isExportUserdata()

已过时。 use setExportParams(CmsExportParameters) instead

Returns the boolean flag to decide whether user/group data should be exported or not.

返回:

true, if user/group data should be exported

isIncludeSystem

@Deprecated
public boolean isIncludeSystem()

已过时。 use setExportParams(CmsExportParameters) instead

Returns the boolean flag to decide whether VFS resources under /system/ should be exported or not.

返回:

true, if VFS resources under /system/ should not be exported

isIncludeUnchanged

@Deprecated
public boolean isIncludeUnchanged()

已过时。 use setExportParams(CmsExportParameters) instead

Returns the boolean flag to decide whether unchanged resources should be exported or not.

返回:

true, if unchanged resources should not be exported

isProjectOnly

@Deprecated
public boolean isProjectOnly()

已过时。 use setExportParams(CmsExportParameters) instead

Returns the projectOnly.

返回:

the projectOnly

isRecursive

@Deprecated
public boolean isRecursive()

已过时。 use setExportParams(CmsExportParameters) instead

Returns the recursive flag.

返回:

the recursive flag

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)

setContentAge

@Deprecated
public void setContentAge(long contentAge)

已过时。 use setExportParams(CmsExportParameters) instead

Sets the timestamp to limit the resources to be exported by date.

Only resources that have been modified after this date will be exported.

参数:

contentAge - the timestamp to limit the resources to be exported by date

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)

setExportParams

public void setExportParams(CmsExportParameters exportParams)

Sets the export parameters.

参数:

exportParams - the parameters to set

setExportPaths

@Deprecated
public void setExportPaths(java.util.List<java.lang.String> exportPaths)

已过时。 use setExportParams(CmsExportParameters) instead

Sets the list with VFS paths to be exported.

参数:

exportPaths - the list with VFS paths to be exported

setExportUserdata

@Deprecated
public void setExportUserdata(boolean exportUserdata)

已过时。 use setExportParams(CmsExportParameters) instead

Sets the boolean flag to decide whether user/group data should be exported or not.

参数:

exportUserdata - true, if user/group data should not be exported

setFileName

@Deprecated
public void setFileName(java.lang.String fileName)

已过时。 use setExportParams(CmsExportParameters) instead

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

setIncludeSystem

@Deprecated
public void setIncludeSystem(boolean excludeSystem)

已过时。 use setExportParams(CmsExportParameters) instead

Sets the boolean flag to decide whether VFS resources under /system/ should be exported or not.

参数:

excludeSystem - true, if VFS resources under /system/ should not be exported

setIncludeUnchanged

@Deprecated
public void setIncludeUnchanged(boolean excludeUnchanged)

已过时。 use setExportParams(CmsExportParameters) instead

Sets the boolean flag to decide whether unchanged resources should be exported or not.

参数:

excludeUnchanged - true, if unchanged resources should not be exported

setProjectOnly

@Deprecated
public void setProjectOnly(boolean projectOnly)

已过时。 use setExportParams(CmsExportParameters) instead

Sets the projectOnly.

参数:

projectOnly - the projectOnly to set

setRecursive

@Deprecated
public void setRecursive(boolean recursive)

已过时。 use setExportParams(CmsExportParameters) instead

Sets the recursive flag.

参数:

recursive - the recursive flag to set