Package org.ametys.plugins.webcontentio.archive

Interface SitePluginArchiver

All Known Implementing Classes:
DefaultSitePluginArchiver
public interface SitePluginArchiver
Component responsible to archive site plugin data.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    export(Site site, String pluginName, javax.jcr.Node pluginNode, ZipOutputStream zos, String prefix)
    Export plugin data into the destination archive
    ImportReport
    partialImport(Site site, String pluginName, javax.jcr.Node allPluginsNode, Path zipPath, String zipPluginEntryPath, Merger merger)
    Import plugin data from the source archive

  • Method Details

    • export

      void export(Site site, String pluginName, javax.jcr.Node pluginNode, ZipOutputStream zos, String prefix) throws IOException
      Export plugin data into the destination archive
      Parameters:
      site - the current site.
      pluginName - the plugin name.
      pluginNode - the plugin Node.
      zos - the output data stream.
      prefix - the prefix for ZIP entries.
      Throws:
      IOException - if an error occurs while writing entries to the archive.

    • partialImport

      ImportReport partialImport(Site site, String pluginName, javax.jcr.Node allPluginsNode, Path zipPath, String zipPluginEntryPath, Merger merger) throws IOException
      Import plugin data from the source archive
      Parameters:
      site - the current site.
      pluginName - the plugin name.
      allPluginsNode - the Node for all plugins.
      zipPath - The input ZIP file
      zipPluginEntryPath - The input ZIP entry
      merger - The Merger
      Returns:
      The ImportReport
      Throws:
      IOException - if an error occurs while reading the archive.