|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.importexport.CmsVfsImportExportHandler
public class CmsVfsImportExportHandler
Import/export handler implementation for VFS data.
Constructor Summary | |
---|---|
CmsVfsImportExportHandler()
Creates a new VFS import/export handler. |
Method Summary | |
---|---|
void |
exportData(CmsObject cms,
I_CmsReport report)
Exports the data from the Cms. |
long |
getContentAge()
Deprecated. 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 |
getExportPaths()
Deprecated. use setExportParams(CmsExportParameters) instead |
java.lang.String |
getFileName()
Deprecated. 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)
Deprecated. use importData(CmsObject, I_CmsReport) instead |
boolean |
isExportUserdata()
Deprecated. use setExportParams(CmsExportParameters) instead |
boolean |
isIncludeSystem()
Deprecated. use setExportParams(CmsExportParameters) instead |
boolean |
isIncludeUnchanged()
Deprecated. use setExportParams(CmsExportParameters) instead |
boolean |
isProjectOnly()
Deprecated. use setExportParams(CmsExportParameters) instead |
boolean |
isRecursive()
Deprecated. 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)
Deprecated. 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 exportPaths)
Deprecated. use setExportParams(CmsExportParameters) instead |
void |
setExportUserdata(boolean exportUserdata)
Deprecated. use setExportParams(CmsExportParameters) instead |
void |
setFileName(java.lang.String fileName)
Deprecated. use setExportParams(CmsExportParameters) instead |
void |
setImportParameters(CmsImportParameters importParams)
Sets the import parameters. |
void |
setIncludeSystem(boolean excludeSystem)
Deprecated. use setExportParams(CmsExportParameters) instead |
void |
setIncludeUnchanged(boolean excludeUnchanged)
Deprecated. use setExportParams(CmsExportParameters) instead |
void |
setProjectOnly(boolean projectOnly)
Deprecated. use setExportParams(CmsExportParameters) instead |
void |
setRecursive(boolean recursive)
Deprecated. use setExportParams(CmsExportParameters) instead |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CmsVfsImportExportHandler()
Method Detail |
---|
public void exportData(CmsObject cms, I_CmsReport report) throws CmsImportExportException, CmsRoleViolationException
I_CmsImportExportHandler
exportData
in interface I_CmsImportExportHandler
cms
- the current OpenCms context objectreport
- a Cms report to print log messages
CmsImportExportException
- if operation was not successful
CmsRoleViolationException
- if the current user has not the required roleI_CmsImportExportHandler.exportData(org.opencms.file.CmsObject, org.opencms.report.I_CmsReport)
public long getContentAge()
setExportParams(CmsExportParameters)
instead
Only resources that have been modified after this date will be exported.
public java.lang.String getDescription()
I_CmsImportExportHandler
The description is useful to print some info about the purpose of this handler.
getDescription
in interface I_CmsImportExportHandler
I_CmsImportExportHandler.getDescription()
public CmsExportParameters getExportParams()
public java.util.List getExportPaths()
setExportParams(CmsExportParameters)
instead
public java.lang.String getFileName()
setExportParams(CmsExportParameters)
instead
public CmsImportParameters getImportParameters()
getImportParameters
in interface I_CmsImportExportHandler
public void importData(CmsObject cms, I_CmsReport report) throws CmsImportExportException, CmsXmlException, CmsRoleViolationException
I_CmsImportExportHandler
importData
in interface I_CmsImportExportHandler
cms
- the current OpenCms context objectreport
- 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 roleI_CmsImportExportHandler.importData(CmsObject, I_CmsReport)
public void importData(CmsObject cms, java.lang.String importFile, java.lang.String importPath, I_CmsReport report) throws CmsXmlException, CmsImportExportException, CmsRoleViolationException, CmsException
importData(CmsObject, I_CmsReport)
instead
I_CmsImportExportHandler
importData
in interface I_CmsImportExportHandler
cms
- the current OpenCms context objectimportFile
- the name (absolute path) of the resource (zip file or folder) to be importedimportPath
- 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 VFSI_CmsImportExportHandler.importData(org.opencms.file.CmsObject, java.lang.String, java.lang.String, org.opencms.report.I_CmsReport)
public boolean isExportUserdata()
setExportParams(CmsExportParameters)
instead
public boolean isIncludeSystem()
setExportParams(CmsExportParameters)
instead
public boolean isIncludeUnchanged()
setExportParams(CmsExportParameters)
instead
public boolean isProjectOnly()
setExportParams(CmsExportParameters)
instead
public boolean isRecursive()
setExportParams(CmsExportParameters)
instead
public boolean matches(org.dom4j.Document manifest)
I_CmsImportExportHandler
matches
in interface I_CmsImportExportHandler
manifest
- the manifest.xml of the import as a dom4j XML document
I_CmsImportExportHandler.matches(org.dom4j.Document)
public void setContentAge(long contentAge)
setExportParams(CmsExportParameters)
instead
Only resources that have been modified after this date will be exported.
contentAge
- the timestamp to limit the resources to be exported by datepublic void setDescription(java.lang.String description)
I_CmsImportExportHandler
The description is useful to print some info about the purpose of this handler.
setDescription
in interface I_CmsImportExportHandler
description
- the description of this import/export handlerI_CmsImportExportHandler.setDescription(java.lang.String)
public void setExportParams(CmsExportParameters exportParams)
exportParams
- the parameters to setpublic void setExportPaths(java.util.List exportPaths)
setExportParams(CmsExportParameters)
instead
exportPaths
- the list with VFS paths to be exportedpublic void setExportUserdata(boolean exportUserdata)
setExportParams(CmsExportParameters)
instead
exportUserdata
- true, if user/group data should not be exportedpublic void setFileName(java.lang.String fileName)
setExportParams(CmsExportParameters)
instead
fileName
- the name of the export file in the real file systempublic void setImportParameters(CmsImportParameters importParams)
setImportParameters
in interface I_CmsImportExportHandler
importParams
- the parameters to setpublic void setIncludeSystem(boolean excludeSystem)
setExportParams(CmsExportParameters)
instead
excludeSystem
- true, if VFS resources under /system/ should not be exportedpublic void setIncludeUnchanged(boolean excludeUnchanged)
setExportParams(CmsExportParameters)
instead
excludeUnchanged
- true, if unchanged resources should not be exportedpublic void setProjectOnly(boolean projectOnly)
setExportParams(CmsExportParameters)
instead
projectOnly
- the projectOnly to setpublic void setRecursive(boolean recursive)
setExportParams(CmsExportParameters)
instead
recursive
- the recursive flag to set
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |