Package org.ametys.plugins.contentio.archive

Class ResourcesArchiverHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentio.archive.ResourcesArchiverHelper

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class ResourcesArchiverHelper
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Export a resources collection as individual files.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	Avalon role.

Constructor Summary

Constructors

Constructor	Description
ResourcesArchiverHelper()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
void	exportCollection(ResourceCollection collection, ZipOutputStream zos, String prefix)	Exports a ResourceCollection as folders and files inside the ZIP archive.
void	exportResource(Resource resource, ZipOutputStream zos, String prefix)	Exports a Resource as file inside the ZIP archive.
ImportReport	importCollection(String commonPrefix, Node parentOfRootResources, Path zipPath, Merger merger)	Imports folders and files from the given ZIP archive and path, under the given ResourceCollection
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 Detail

ROLE

public static final String ROLE

Avalon role.

Constructor Detail

ResourcesArchiverHelper

public ResourcesArchiverHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

exportCollection

public void exportCollection(ResourceCollection collection,
                             ZipOutputStream zos,
                             String prefix)
                      throws IOException

Exports a ResourceCollection as folders and files inside the ZIP archive.

Parameters:

collection - the root ResourceCollection

zos - the ZIP OutputStream.

prefix - the prefix for the ZIP archive.

Throws:

IOException - if an error occurs while archiving

exportResource

public void exportResource(Resource resource,
                           ZipOutputStream zos,
                           String prefix)
                    throws IOException

Exports a Resource as file inside the ZIP archive.

Parameters:

resource - the Resource.

zos - the ZIP OutputStream.

prefix - the prefix for the ZIP archive.

Throws:

IOException - if an error occurs while archiving

importCollection

public ImportReport importCollection(String commonPrefix,
                                     Node parentOfRootResources,
                                     Path zipPath,
                                     Merger merger)
                              throws IOException

Imports folders and files from the given ZIP archive and path, under the given ResourceCollection

Parameters:

commonPrefix - The common prefix in the ZIP archive

parentOfRootResources - the parent of the root ResourceCollection (the root will also be created)

zipPath - the input zip path

merger - The Merger

Returns:

The ImportReport

Throws:

IOException - if an error occurs while importing archive