How to use org.opencms.importexport

/**
 * @see org.opencms.importexport.I_CmsImportExportHandler#importData(org.opencms.file.CmsObject, java.lang.String, java.lang.String, org.opencms.report.I_CmsReport)
 * 
 * @deprecated use {@link #importData(CmsObject, I_CmsReport)} instead
 */
public void importData(CmsObject cms, String importFile, String importPath, I_CmsReport report)
throws CmsXmlException, CmsImportExportException, CmsRoleViolationException, CmsException {
  CmsImportParameters parameters = new CmsImportParameters(importFile, importPath, true);
  setImportParameters(parameters);
  importData(cms, report);
}

/**
 * Sets the user Date Created.<p>
 *
 * @param userDateCreated the date to set
 */
public void setUserDateCreated(String userDateCreated) {
  try {
    m_userDateCreated = convertTimestamp(userDateCreated);
  } catch (Throwable e) {
    setThrowable(e);
  }
}

/**
 * Returns the extendedHtmlImportDefault.<p>
 *
 * @return the extendedHtmlImportDefault
 */
public CmsExtendedHtmlImportDefault getExtendedHtmlImportDefault() {
  return getExtendedHtmlImportDefault(false);
}

/**
 * Constructor.<p>
 *
 * @param path the file path, could be a folder or a zip file
 * @param destination path in the OpenCms VFS to import into
 * @param keepPermissions if set, the permissions set on existing resources will not be modified
 */
public CmsImportParameters(String path, String destination, boolean keepPermissions) {
  setPath(path);
  setDestinationPath(destination);
  setKeepPermissions(keepPermissions);
}

/**
 * Sets the extendedHtmlImportManager.<p>
 *
 * @param extendedHtmlImportManager the extendedHtmlImportManager to set
 */
public void setExtendedHtmlImportManager(CmsExtendedHtmlImportDefault extendedHtmlImportManager) {
  m_importExportManager.setExtendedHtmlImportDefault(extendedHtmlImportManager);
}

/**
 * Returns the name of the export file.<p>
 * 
 * @return the name of the export file
 */
protected String getExportFileName() {
  return m_parameters.getPath();
}

/**
 * @see org.opencms.main.CmsException#createException(org.opencms.i18n.CmsMessageContainer, java.lang.Throwable)
 */
@Override
public CmsException createException(CmsMessageContainer container, Throwable cause) {
  return new CmsImportExportException(container, cause);
}

/**
 * Sets the user settings for export and import.<p>
 *
 * @param userExportSettings the user settings for export and import
 */
public void setUserExportSettings(CmsUserExportSettings userExportSettings) {
  m_importExportManager.setUserExportSettings(userExportSettings);
}

/**
 * Adds a property from the current xml data, in case the type is implicit given.<p>
 * 
 * @see #addResourcePropertyRules(Digester, String)
 */
public void addProperty() {
  addProperty("individual");
}

/** @see #appendResourceToManifest(CmsResource, boolean, boolean)
 * @param resource @see #appendResourceToManifest(CmsResource, boolean, boolean)
 * @param source @see #appendResourceToManifest(CmsResource, boolean, boolean)
 * @throws CmsImportExportException @see #appendResourceToManifest(CmsResource, boolean, boolean)
 * @throws SAXException @see #appendResourceToManifest(CmsResource, boolean, boolean)
 */
protected void appendResourceToManifest(CmsResource resource, boolean source)
throws CmsImportExportException, SAXException {
  appendResourceToManifest(resource, source, false);
}

/**
 * Sets the user Date Created.<p>
 *
 * @param userDateCreated the date to set
 */
public void setUserDateCreated(String userDateCreated) {
  try {
    m_userDateCreated = convertTimestamp(userDateCreated);
  } catch (Throwable e) {
    setThrowable(e);
  }
}

/**
 * Adds a property from the current xml data, in case the type is implicit given.<p>
 *
 * @see #addResourcePropertyRules(Digester, String)
 */
public void addProperty() {
  addProperty("individual");
}

/**
 * Constructor.<p>
 * 
 * @param path the file path, could be a folder or a zip file
 * @param destination path in the OpenCms VFS to import into
 * @param keepPermissions if set, the permissions set on existing resources will not be modified
 */
public CmsImportParameters(String path, String destination, boolean keepPermissions) {
  setPath(path);
  setDestinationPath(destination);
  setKeepPermissions(keepPermissions);
}

/**
 * Sets the user Date Created.<p>
 *
 * @param userDateCreated the date to set
 */
public void setUserDateCreated(String userDateCreated) {
  try {
    m_userDateCreated = convertTimestamp(userDateCreated);
  } catch (Throwable e) {
    setThrowable(e);
  }
}

/**
 * Returns the extendedHtmlImportDefault.<p>
 *
 * @return the extendedHtmlImportDefault
 */
public CmsExtendedHtmlImportDefault getExtendedHtmlImportDefault() {
  return getExtendedHtmlImportDefault(false);
}

/**
 * Sets the extendedHtmlImportManager.<p>
 *
 * @param extendedHtmlImportManager the extendedHtmlImportManager to set
 */
public void setExtendedHtmlImportManager(CmsExtendedHtmlImportDefault extendedHtmlImportManager) {
  m_importExportManager.setExtendedHtmlImportDefault(extendedHtmlImportManager);
}

/**
 * Returns the name of the export file.<p>
 *
 * @return the name of the export file
 */
protected String getExportFileName() {
  return m_parameters.getPath();
}

/**
 * @see org.opencms.main.CmsException#createException(org.opencms.i18n.CmsMessageContainer, java.lang.Throwable)
 */
@Override
public CmsException createException(CmsMessageContainer container, Throwable cause) {
  return new CmsImportExportException(container, cause);
}

/**
 * Sets the user settings for export and import.<p>
 * 
 * @param userExportSettings the user settings for export and import
 */
public void setUserExportSettings(CmsUserExportSettings userExportSettings) {
  m_importExportManager.setUserExportSettings(userExportSettings);
}

/**
 * Adds a property from the current xml data, in case the type is implicit given.<p>
 *
 * @see #addResourcePropertyRules(Digester, String)
 */
public void addProperty() {
  addProperty("individual");
}