Package org.ametys.plugins.workspaces.archive

Class ProjectArchiverHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.archive.ProjectArchiverHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ProjectArchiverHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for operations related to exporting or import project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ProjectArchiverHelper.ProjectImporter	Inner class to leverage the logic from UnitaryImporter

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_resolver	the ametys object resolver
protected ResourcesArchiverHelper	_resourcesArchiverHelper	the resource archiver helper
static final String	ROLE	the Avalon role

Constructor Summary

Constructors

Constructor	Description
ProjectArchiverHelper()

Method Summary

Modifier and Type	Method	Description
void	exportProject(Project project, ZipOutputStream zos, String prefix)	Export the project to the zip archive
ImportReport	importProjects(javax.jcr.Node pluginNode, Path zipPath, String baseImportProjectsPath, Merger merger)	Import archived projects data.
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

ROLE

public static final String ROLE

the Avalon role

_resolver

protected AmetysObjectResolver _resolver

the ametys object resolver

_resourcesArchiverHelper

protected ResourcesArchiverHelper _resourcesArchiverHelper

the resource archiver helper

Constructor Details

ProjectArchiverHelper

public ProjectArchiverHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

exportProject

public void exportProject(Project project,
 ZipOutputStream zos,
 String prefix)
                   throws IOException

Export the project to the zip archive

Parameters:

project - the project to export

zos - the zip output stream

prefix - the prefix use for the path of all zip entry of the project

Throws:

IOException - if an error occurred

importProjects

public ImportReport importProjects(javax.jcr.Node pluginNode,
 Path zipPath,
 String baseImportProjectsPath,
 Merger merger)
                            throws IOException

Import archived projects data.

Parameters:

pluginNode - the plugin node where the new projects node will be added

zipPath - the path to the ZIP containing the data

baseImportProjectsPath - the path in the ZIP where the projects data are located

merger - the merger

Returns:

the import report

Throws:

IOException - if an error occurs