Package org.ametys.plugins.contentio.archive

Interface PluginArchiver

All Known Implementing Classes:

DefaultPluginArchiver, DefaultSitePluginArchiver, WebExplorerArchiver

public interface PluginArchiver

Component responsible to archive plugin data.

Method Summary

Modifier and Type	Method	Description
default void	deleteBeforePartialImport(String pluginName, Node allPluginsNode)	When in MergePolicy.DELETE_BEFORE, the plugin needs to delete its Node before importing (if it exists).
void	export(String pluginName, Node pluginNode, ZipOutputStream zos, String prefix)	Export plugin data into the destination archive
ImportReport	partialImport(String pluginName, Node allPluginsNode, Path zipPath, String zipPluginEntryPath, Merger merger)	Import plugin data from the source archive

Method Detail

export

void export(String pluginName,
            Node pluginNode,
            ZipOutputStream zos,
            String prefix)
     throws IOException

Export plugin data into the destination archive

Parameters:

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.

deleteBeforePartialImport

default void deleteBeforePartialImport(String pluginName,
                                       Node allPluginsNode)
                                throws RepositoryException

When in MergePolicy.DELETE_BEFORE, the plugin needs to delete its Node before importing (if it exists).

Parameters:

pluginName - the plugin name.

allPluginsNode - the Node for all plugins.

Throws:

RepositoryException - if a Repository error occured

partialImport

ImportReport partialImport(String pluginName,
                           Node allPluginsNode,
                           Path zipPath,
                           String zipPluginEntryPath,
                           Merger merger)
                    throws IOException

Import plugin data from the source archive

Parameters:

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.