Package org.ametys.plugins.workspaces.archive

Class WorkspacePluginArchiver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentio.archive.DefaultPluginArchiver

org.ametys.plugins.workspaces.archive.WorkspacePluginArchiver

All Implemented Interfaces:

PluginArchiver, LogEnabled, Serviceable

public class WorkspacePluginArchiver
extends DefaultPluginArchiver

Archiver handling the data stored by the workspaces plugin. Mainly this archiver will separate each projects in its own directory. Each project folder consisting of different directory for each module. And the data in the document module will be stored as file tree allowing easy access to each document

Field Summary

Fields

Modifier and Type	Field	Description
protected ProjectArchiverHelper	_projectArchiverHelper	the project archiver helper
protected AmetysObjectResolver	_resolver	the ametys object resolver

Fields inherited from class org.ametys.plugins.contentio.archive.DefaultPluginArchiver

EXTENSION_ID

Constructor Summary

Constructors

Constructor	Description
WorkspacePluginArchiver()

Method Summary

Modifier and Type	Method	Description
void	export(String pluginName, javax.jcr.Node pluginNode, ZipOutputStream zos, String prefix)	Export plugin data into the destination archive
protected ContentHandler	getSystemViewHandler(ContentHandler initialHandler)	Returns the actual handler receiving the JCR system view.
ImportReport	partialImport(String pluginName, javax.jcr.Node allPluginsNode, Path zipPath, String zipPluginEntryPath, Merger merger)	Import plugin data from the source archive
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.contentio.archive.DefaultPluginArchiver

importContentsIfAny

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.PluginArchiver

deleteBeforePartialImport

Field Details

_resolver

protected AmetysObjectResolver _resolver

the ametys object resolver

_projectArchiverHelper

protected ProjectArchiverHelper _projectArchiverHelper

the project archiver helper

Constructor Details

WorkspacePluginArchiver

public WorkspacePluginArchiver()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class DefaultPluginArchiver

Throws:

ServiceException

getSystemViewHandler

protected ContentHandler getSystemViewHandler(ContentHandler initialHandler)

Description copied from class: DefaultPluginArchiver

Returns the actual handler receiving the JCR system view. May be used to filter out some parts of the JCR export.

Overrides:

getSystemViewHandler in class DefaultPluginArchiver

Parameters:

initialHandler - the target ContentHandler.

Returns:

a ContentHandler.

export

public void export(String pluginName,
 javax.jcr.Node pluginNode,
 ZipOutputStream zos,
 String prefix)
            throws IOException

Description copied from interface: PluginArchiver

Export plugin data into the destination archive

Specified by:

export in interface PluginArchiver

Overrides:

export in class DefaultPluginArchiver

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.

partialImport

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

Description copied from interface: PluginArchiver

Import plugin data from the source archive

Specified by:

partialImport in interface PluginArchiver

Overrides:

partialImport in class DefaultPluginArchiver

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.