Package org.ametys.plugins.contentio.archive

Class ContentsArchiverHelper.Importer.UnitaryContentImporter

java.lang.Object

org.ametys.plugins.contentio.archive.ContentsArchiverHelper.Importer.UnitaryContentImporter

All Implemented Interfaces:

UnitaryImporter<DefaultContent>

Enclosing class:

ContentsArchiverHelper.Importer

private class ContentsArchiverHelper.Importer.UnitaryContentImporter
extends Object
implements UnitaryImporter<DefaultContent>

Constructor Summary

Constructors

Modifier	Constructor	Description
private	UnitaryContentImporter()

Method Summary

Modifier and Type	Method	Description
DefaultContent	create(Path zipEntryPath, String id, Document propertiesXml)	Creates the object with the given id and XML properties file.
Document	getPropertiesXml(Path zipEntryPath)	Gets the properties XML file from its ZIP path
ImportReport	getReport()	The ImportReport
String	objectNameForLogs()	The name for the object to import in error logs
String	retrieveId(Document propertiesXml)	Retrieves the id of the object to import from the XML file

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

unitaryImport, unitaryImportFinalize

Constructor Detail

UnitaryContentImporter

private UnitaryContentImporter()

Method Detail

objectNameForLogs

public String objectNameForLogs()

Description copied from interface: UnitaryImporter

The name for the object to import in error logs

Specified by:

objectNameForLogs in interface UnitaryImporter<DefaultContent>

Returns:

The name for the object to import in error logs

getPropertiesXml

public Document getPropertiesXml(Path zipEntryPath)
                          throws Exception

Description copied from interface: UnitaryImporter

Gets the properties XML file from its ZIP path

Specified by:

getPropertiesXml in interface UnitaryImporter<DefaultContent>

Parameters:

zipEntryPath - The ZIP entry path of the XML file

Returns:

The properties XML file

Throws:

Exception - if an error occurs

retrieveId

public String retrieveId(Document propertiesXml)
                  throws Exception

Description copied from interface: UnitaryImporter

Retrieves the id of the object to import from the XML file

Specified by:

retrieveId in interface UnitaryImporter<DefaultContent>

Parameters:

propertiesXml - The properties XML file

Returns:

The id of the object to import

Throws:

Exception - if an error occurs

create

public DefaultContent create(Path zipEntryPath,
                             String id,
                             Document propertiesXml)
                      throws Archivers.AmetysObjectNotImportedException,
                             Exception

Description copied from interface: UnitaryImporter

Creates the object with the given id and XML properties file.
Note that the implementation must create the object with the given id, but it can also create sub-objects for this unitary object (for instance a Resource as an attachment for a Content, etc.).

Specified by:

create in interface UnitaryImporter<DefaultContent>

Parameters:

zipEntryPath - The ZIP entry path of the XML file

id - The id of the object to import

propertiesXml - The properties XML file

Returns:

The created object

Throws:

Archivers.AmetysObjectNotImportedException - If the object was not imported due to an exception (for instance an attribute is missing in the XML file). Then the object is ignored and the import will continue to the next object.

ImportGlobalFailException - If the global import process must stop due to any fatal exception.

Exception - if another unexpected error occurs

getReport

public ImportReport getReport()

Description copied from interface: UnitaryImporter

The ImportReport

Specified by:

getReport in interface UnitaryImporter<DefaultContent>

Returns:

The ImportReport