Package org.ametys.plugins.webcontentio.archive

Class SitesArchiver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.webcontentio.archive.SitesArchiver

All Implemented Interfaces:

Archiver, LogEnabled, Serviceable

public class SitesArchiver
extends AbstractLogEnabled
implements Archiver, Serviceable

Archiver for all sites.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentsArchiverHelper	_contentsArchiverHelper	The helper for archiving contents
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected DefaultPageFactory	_defaultPageFactory	The default page factory
protected ObservationManager	_observationManager	The observation manager
protected ModelItemTypeExtensionPoint	_pageDataTypeExtensionPoint	The page data type extension point
protected SitePluginArchiverExtensionPoint	_pluginArchiverExtensionPoint	The extension point for SitePluginArchivers
protected AmetysObjectResolver	_resolver	The Ametys Object Resolver
protected ResourcesArchiverHelper	_resourcesArchiverHelper	The helper for archiving resources
protected ServiceExtensionPoint	_serviceExtensionPoint	The extension point for Services
protected SiteManager	_siteManager	The site manager
protected SitemapFactory	_sitemapFactory	The sitemap factory
protected SiteTypesExtensionPoint	_siteTypeEP	The extension point for SiteTypes
protected TagProviderExtensionPoint	_tagProviderEP	The extension point for TagProviders
static final String	ID	Archiver id.

Constructor Summary

Constructors

Constructor	Description
SitesArchiver()

Method Summary

Modifier and Type	Method	Description
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
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

Field Details

ID

public static final String ID

Archiver id.

See Also:

• Constant Field Values

_siteManager

protected SiteManager _siteManager

The site manager

_contentsArchiverHelper

protected ContentsArchiverHelper _contentsArchiverHelper

The helper for archiving contents

_resourcesArchiverHelper

protected ResourcesArchiverHelper _resourcesArchiverHelper

The helper for archiving resources

_pluginArchiverExtensionPoint

protected SitePluginArchiverExtensionPoint _pluginArchiverExtensionPoint

The extension point for SitePluginArchivers

_tagProviderEP

protected TagProviderExtensionPoint _tagProviderEP

The extension point for TagProviders

_resolver

protected AmetysObjectResolver _resolver

The Ametys Object Resolver

_defaultPageFactory

protected DefaultPageFactory _defaultPageFactory

The default page factory

_sitemapFactory

protected SitemapFactory _sitemapFactory

The sitemap factory

_serviceExtensionPoint

protected ServiceExtensionPoint _serviceExtensionPoint

The extension point for Services

_siteTypeEP

protected SiteTypesExtensionPoint _siteTypeEP

The extension point for SiteTypes

_pageDataTypeExtensionPoint

protected ModelItemTypeExtensionPoint _pageDataTypeExtensionPoint

The page data type extension point

_observationManager

protected ObservationManager _observationManager

The observation manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Details

SitesArchiver

public SitesArchiver()

Method Details

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.

additionalSuccessImportMail

public List<I18nizableText> additionalSuccessImportMail()

Description copied from interface: Archiver

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

Specified by:

additionalSuccessImportMail in interface Archiver

Returns:

the mail additional information

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.