Package org.ametys.plugins.contentio.archive

Interface Archiver

All Known Implementing Classes:

ContentArchiver, PluginsArchiver, ResourcesArchiver, SitesArchiver

public interface Archiver

Component responsible to archive data.

Method Summary

Modifier and Type	Method	Description
default List<I18nizableText>	additionalSuccessImportMail()	Potential additional information to append to the success mail of the import process
void	export(ZipOutputStream zos)	Export data into the destination archive
ManifestReaderWriter	getManifestReaderWriter()	Get the ManifestReaderWriter
Collection<String>	managedPartialImports(Collection<String> partialImports)	Returns the partial imports, among the given ones, that this Archiver is able to manage.
ImportReport	partialImport(Path zipPath, Collection<String> partialImports, Merger merger, boolean deleteBefore)	Import data (limited to the given partial imports) from the source archive

Method Details

getManifestReaderWriter

ManifestReaderWriter getManifestReaderWriter()

Get the ManifestReaderWriter

Returns:

the ManifestReaderWriter

export

void export(ZipOutputStream zos)
     throws IOException

Export data into the destination archive

Parameters:

zos - the output data stream.

Throws:

IOException - if an error occurs while writing entries to the archive.

managedPartialImports

Collection<String> managedPartialImports(Collection<String> partialImports)

Returns the partial imports, among the given ones, that this Archiver is able to manage.

Parameters:

partialImports - The partial imports to filter

Returns:

The managed partial imports

partialImport

ImportReport partialImport(Path zipPath,
 Collection<String> partialImports,
 Merger merger,
 boolean deleteBefore)
                    throws IOException

Import data (limited to the given partial imports) from the source archive

Parameters:

zipPath - the input zip path

partialImports - The partial imports to do. The passed collection must already be filtered out by managedPartialImports(java.util.Collection<java.lang.String>)

merger - The Merger

deleteBefore - true if objects need to be deleted before applying the partial imports

Returns:

The ImportReport

Throws:

IOException - if an error occurs while reading archive entries.

additionalSuccessImportMail

default List<I18nizableText> additionalSuccessImportMail()

Potential additional information to append to the success mail of the import process

Returns:

the mail additional information