Package org.ametys.plugins.contentio.archive

Class ContentArchiver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentio.archive.ContentArchiver

All Implemented Interfaces:

Archiver, LogEnabled, Serviceable

public class ContentArchiver
extends AbstractLogEnabled
implements Archiver, Serviceable

Archives contents in /ametys:root/ametys:contents

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	ContentArchiver.ContentArchiverManifestReaderWriter

Field Summary

Fields

Modifier and Type	Field	Description
private ContentsArchiverHelper	_contentsArchiverHelper
private ManifestReaderWriter	_manifestReaderWriter
private AmetysObjectResolver	_resolver
static String	ID	Archiver id.

Constructor Summary

Constructors

Constructor	Description
ContentArchiver()

Method Summary

Modifier and Type	Method	Description
private void	_deleteBeforePartialImport(AmetysObjectCollection rootContents)
private AmetysObjectCollection	_rootContents()
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
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.plugins.contentio.archive.Archiver

additionalSuccessImportMail

Field Detail

ID

public static final String ID

Archiver id.

See Also:

Constant Field Values

_resolver

private AmetysObjectResolver _resolver

_contentsArchiverHelper

private ContentsArchiverHelper _contentsArchiverHelper

_manifestReaderWriter

private ManifestReaderWriter _manifestReaderWriter

Constructor Detail

ContentArchiver

public ContentArchiver()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getManifestReaderWriter

public ManifestReaderWriter getManifestReaderWriter()

Description copied from interface: Archiver

Get the ManifestReaderWriter

Specified by:

getManifestReaderWriter in interface Archiver

Returns:

the ManifestReaderWriter

export

public void export(ZipOutputStream zos)
            throws IOException

Description copied from interface: Archiver

Export data into the destination archive

Specified by:

export in interface Archiver

Parameters:

zos - the output data stream.

Throws:

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

_rootContents

private AmetysObjectCollection _rootContents()

_deleteBeforePartialImport

private void _deleteBeforePartialImport(AmetysObjectCollection rootContents)
                                 throws IOException

Throws:

IOException

managedPartialImports

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

Description copied from interface: Archiver

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

Specified by:

managedPartialImports in interface Archiver

Parameters:

partialImports - The partial imports to filter

Returns:

The managed partial imports

partialImport

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

Description copied from interface: Archiver

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

Specified by:

partialImport in interface Archiver

Parameters:

zipPath - the input zip path

partialImports - The partial imports to do. The passed collection must already be filtered out by Archiver.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.