Package org.opencms.importexport

Class CmsImportParameters

java.lang.Object

org.opencms.importexport.CmsImportParameters

public class CmsImportParameters
extends Object

Import parameters.

Since:

7.0.4

Constructor Summary

Constructors

Constructor	Description
CmsImportParameters(String path, String destination, boolean keepPermissions)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getDestinationPath()	Returns the path in the OpenCms VFS to import into.
String	getPath()	Returns the file path, could be a folder or a zip file.
boolean	isKeepPermissions()	Returns the keep permissions flags.
boolean	isXmlValidation()	Checks if the manifest.xml file will be validated during the import.
void	setDestinationPath(String importPath)	Sets the path in the OpenCms VFS to import into.
void	setKeepPermissions(boolean keepPermissions)	Sets the keep permissions flag.
void	setPath(String path)	Sets the file path, could be a folder or a zip file.
void	setXmlValidation(boolean xmlValidation)	Sets the xml validation flag.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsImportParameters

public CmsImportParameters(String path,
 String destination,
 boolean keepPermissions)

Constructor.

Parameters:

path - the file path, could be a folder or a zip file

destination - path in the OpenCms VFS to import into

keepPermissions - if set, the permissions set on existing resources will not be modified

Method Details

getDestinationPath

public String getDestinationPath()

Returns the path in the OpenCms VFS to import into.

Returns:

the path in the OpenCms VFS to import into

getPath

public String getPath()

Returns the file path, could be a folder or a zip file.

Returns:

the file path

isKeepPermissions

public boolean isKeepPermissions()

Returns the keep permissions flags. if set, the permissions set on existing resources will not be modified.

Returns:

the keep permissions flag

isXmlValidation

public boolean isXmlValidation()

Checks if the manifest.xml file will be validated during the import.

Returns:

the xml validation flag

setDestinationPath

public void setDestinationPath(String importPath)

Sets the path in the OpenCms VFS to import into.

Parameters:

importPath - the import path to set

setKeepPermissions

public void setKeepPermissions(boolean keepPermissions)

Sets the keep permissions flag. If set, the permissions set on existing resources will not be modified.

Parameters:

keepPermissions - the keep permissions flag to set

setPath

public void setPath(String path)

Sets the file path, could be a folder or a zip file.

Parameters:

path - the file path, could be a folder or a zip file

setXmlValidation

public void setXmlValidation(boolean xmlValidation)

Sets the xml validation flag. If set, the manifest.xml file will be validated during the import.

Parameters:

xmlValidation - the xml validation flag to set