Package org.opencms.importexport

Class CmsImportParameters

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsImportParameters​(java.lang.String path, java.lang.String destination, boolean keepPermissions)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDestinationPath()
      Returns the path in the OpenCms VFS to import into.
      java.lang.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​(java.lang.String importPath)
      Sets the path in the OpenCms VFS to import into.
      void setKeepPermissions​(boolean keepPermissions)
      Sets the keep permissions flag.
      void setPath​(java.lang.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 Detail

      • CmsImportParameters

        public CmsImportParameters​(java.lang.String path,
                           java.lang.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 Detail

      • getDestinationPath

        public java.lang.String getDestinationPath()
        Returns the path in the OpenCms VFS to import into.

        Returns:
        the path in the OpenCms VFS to import into

      • getPath

        public java.lang.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​(java.lang.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​(java.lang.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