Package org.ametys.plugins.contentio.archive

Class ArchiveHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentio.archive.ArchiveHandler

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class ArchiveHandler
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Archive data on disk.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The context
static String	METADATA_PREFIX	The prefix path for exporting metadata content
static String	ROLE	Avalon role.

Constructor Summary

Constructors

Constructor	Description
ArchiveHandler()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
void	export(File output)	Exports with ArchiverExtensionPoint mechanism into the given File
File	getArchiveFile(String name)	Gets the archive file
Stream<String>	getArchiveFiles()	Gets the archive files
Path	getArchiveFolder()	Gets the folder containing all the managed archives
Stream<PartialImport>	getPartialImports(String archiveName)	Gets the partial imports of the given archive
ImportReport	importAll(File input, Merger merger)	Imports all data from the given ZIP archive
ImportReport	partialImport(File input, Collection<String> partialImports, Merger merger)	Imports partial data from the given ZIP 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 Detail

ROLE

public static final String ROLE

Avalon role.

METADATA_PREFIX

public static final String METADATA_PREFIX

The prefix path for exporting metadata content

See Also:

Constant Field Values

_context

protected Context _context

The context

Constructor Detail

ArchiveHandler

public ArchiveHandler()

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

getArchiveFolder

public Path getArchiveFolder()

Gets the folder containing all the managed archives

Returns:

the folder containing all the managed archives

getArchiveFiles

public Stream<String> getArchiveFiles()

Gets the archive files

Returns:

the archive files

getArchiveFile

public File getArchiveFile(String name)

Gets the archive file

Parameters:

name - The archive name

Returns:

the archive file

getPartialImports

public Stream<PartialImport> getPartialImports(String archiveName)
                                        throws IOException

Gets the partial imports of the given archive

Parameters:

archiveName - The archive name

Returns:

the partial imports

Throws:

IOException - if an I/O error occured

export

public void export(File output)
            throws IOException

Exports with ArchiverExtensionPoint mechanism into the given File

Parameters:

output - The output ZIP file

Throws:

IOException - if an IO exception occured

importAll

public ImportReport importAll(File input,
                              Merger merger)
                       throws IOException

Imports all data from the given ZIP archive

Parameters:

input - the ZIP archive

merger - the Merger

Returns:

The ImportReport

Throws:

IOException - if an I/O error occurs

partialImport

public ImportReport partialImport(File input,
                                  Collection<String> partialImports,
                                  Merger merger)
                           throws IOException

Imports partial data from the given ZIP archive

Parameters:

input - the ZIP archive

partialImports - the partial imports

merger - the Merger

Returns:

The ImportReport

Throws:

IOException - if an I/O error occurs