Package org.ametys.plugins.contentio.archive

Class Archivers

java.lang.Object

org.ametys.plugins.contentio.archive.Archivers

public final class Archivers
extends Object

Convenient methods for Archiver API implementations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Archivers.AmetysObjectNotImportedException	Exception indicating an Ametys Object cannot be imported

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static String	__BINARY_ATTRIBUTES_FOLDER_NAME
(package private) static String	__FILE_ATTRIBUTES_FOLDER_NAME
private static Properties	__OUTPUT_FORMAT_PROPERTIES
(package private) static String	__RICH_TEXT_ATTACHMENTS_FOLDER_NAME
private static SAXTransformerFactory	__transformerFactory
static String	WARN_MESSAGE_ROOT_HAS_PENDING_CHANGES	The warning message for a root of Archiver which stil has pending change while we do a unitary save on every imported object.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Archivers()

Method Summary

Modifier and Type	Method	Description
private static void	_exportResource(String dataPath, NamedResource resource, ZipOutputStream zos, String prefix)
private static void	_exportRichText(String richTextDataPath, RichText richText, ZipOutputStream zos, String prefix)
static void	exportAcl(Node node, ZipOutputStream zos, String path)	Export ACL sub-node
static void	exportBinaries(ModelAwareDataHolder dataHolder, ZipOutputStream zos, String path)	Export the given data holder's binaries
static void	exportFiles(ModelAwareDataHolder dataHolder, ZipOutputStream zos, String path)	Export the given data holder's files
static void	exportRichTexts(ModelAwareDataHolder dataHolder, ZipOutputStream zos, String path)	Export the attachments of the given data holder's rich texts
static String	getFolderPathFromDataPath(String dataPath)	Retrieves a folder path from a data path.
static String	getHashedPath(String name)	Computes a hashed path from an object name.
static SAXTransformerFactory	getSaxTransformerFactory()	Gets a SAXTransformerFactory
static void	importAcl(Node node, Path zipPath, Merger merger, String zipEntryPath, org.slf4j.Logger logger)	Import ACL sub-node
static TransformerHandler	newTransformerHandler()	Get a TransformerHandler object that can process SAXContentHandler events into a Result
static Node	replaceNodeWithDesiredUuid(Node srcNode, String uuid)	Replace the given JCR Node by a copy of it with the given UUID.
static void	setStandardOutputProperties(TransformerHandler transformerHandler)	Sets standard output properties to the transformer of the given handler, such as encoding and indentation.
static void	unitarySave(Node ametysObjectNode, org.slf4j.Logger logger)	Save the pending changes brought to this node associated to an AmetysObject If the save failed, it is logged in ERROR level and the changes are discarded.
static String	xpathEvalNonEmpty(String xPath, Node domNode)	Evaluates a non-empty XPath query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WARN_MESSAGE_ROOT_HAS_PENDING_CHANGES

public static final String WARN_MESSAGE_ROOT_HAS_PENDING_CHANGES

The warning message for a root of Archiver which stil has pending change while we do a unitary save on every imported object.

See Also:

Constant Field Values

__BINARY_ATTRIBUTES_FOLDER_NAME

static final String __BINARY_ATTRIBUTES_FOLDER_NAME

See Also:

Constant Field Values

__FILE_ATTRIBUTES_FOLDER_NAME

static final String __FILE_ATTRIBUTES_FOLDER_NAME

See Also:

Constant Field Values

__RICH_TEXT_ATTACHMENTS_FOLDER_NAME

static final String __RICH_TEXT_ATTACHMENTS_FOLDER_NAME

See Also:

Constant Field Values

__OUTPUT_FORMAT_PROPERTIES

private static final Properties __OUTPUT_FORMAT_PROPERTIES

__transformerFactory

private static SAXTransformerFactory __transformerFactory

Constructor Detail

Archivers

private Archivers()

Method Detail

getSaxTransformerFactory

public static SAXTransformerFactory getSaxTransformerFactory()

Gets a SAXTransformerFactory

Returns:

a SAXTransformerFactory

newTransformerHandler

public static TransformerHandler newTransformerHandler()
                                                throws TransformerConfigurationException

Get a TransformerHandler object that can process SAXContentHandler events into a Result

Returns:

A non-null reference to a TransformerHandler, that maybe used as a ContentHandler for SAX parse events.

Throws:

TransformerConfigurationException - If for some reason theTransformerHandler cannot be created.

setStandardOutputProperties

public static void setStandardOutputProperties(TransformerHandler transformerHandler)

Sets standard output properties to the transformer of the given handler, such as encoding and indentation.

Parameters:

transformerHandler - The transformer handler

getHashedPath

public static String getHashedPath(String name)

Computes a hashed path from an object name.

Parameters:

name - the object name.

Returns:

a hashed path.

exportAcl

public static void exportAcl(Node node,
                             ZipOutputStream zos,
                             String path)
                      throws RepositoryException,
                             IOException

Export ACL sub-node

Parameters:

node - The JCR node

zos - the ZIP OutputStream.

path - the zip entry path

Throws:

RepositoryException - if an error occurs

IOException - if an I/O error occurs

importAcl

public static void importAcl(Node node,
                             Path zipPath,
                             Merger merger,
                             String zipEntryPath,
                             org.slf4j.Logger logger)
                      throws RepositoryException,
                             IOException

Import ACL sub-node

Parameters:

node - The JCR node

zipPath - the input zip path

merger - The Merger

zipEntryPath - the zip entry path

logger - The logger

Throws:

RepositoryException - if an error occurs

IOException - if an I/O error occurs

xpathEvalNonEmpty

public static String xpathEvalNonEmpty(String xPath,
                                       Node domNode)
                                throws Archivers.AmetysObjectNotImportedException,
                                       TransformerException

Evaluates a non-empty XPath query. If the result is empty, an Archivers.AmetysObjectNotImportedException is thrown.

Parameters:

xPath - The XPath query

domNode - The DOM node

Returns:

The evaluation as String

Throws:

Archivers.AmetysObjectNotImportedException - If the result is empty

TransformerException - if an evaluation error occured

replaceNodeWithDesiredUuid

public static Node replaceNodeWithDesiredUuid(Node srcNode,
                                              String uuid)
                                       throws RepositoryException

Replace the given JCR Node by a copy of it with the given UUID. The source JCR Node is removed.

Parameters:

srcNode - The source JCR Node

uuid - The desired UUID

Returns:

The JCR Node with the desired UUID

Throws:

RepositoryException - if an error occurs

unitarySave

public static void unitarySave(Node ametysObjectNode,
                               org.slf4j.Logger logger)
                        throws Archivers.AmetysObjectNotImportedException,
                               ImportGlobalFailException

Save the pending changes brought to this node associated to an AmetysObject
If the save failed, it is logged in ERROR level and the changes are discarded.

Parameters:

ametysObjectNode - The node

logger - The logger

Throws:

Archivers.AmetysObjectNotImportedException - If the save failed

ImportGlobalFailException - If a severe error occured and the global import process must be stopped

exportRichTexts

public static void exportRichTexts(ModelAwareDataHolder dataHolder,
                                   ZipOutputStream zos,
                                   String path)
                            throws IOException

Export the attachments of the given data holder's rich texts

Parameters:

dataHolder - The data holder

zos - The ZipOutputStream where to export the attachments

path - The path of the folder used to export the attachments

Throws:

IOException - if an error occurs while exporting the attachments

_exportRichText

private static void _exportRichText(String richTextDataPath,
                                    RichText richText,
                                    ZipOutputStream zos,
                                    String prefix)
                             throws IOException

Throws:

IOException

exportBinaries

public static void exportBinaries(ModelAwareDataHolder dataHolder,
                                  ZipOutputStream zos,
                                  String path)
                           throws IOException

Export the given data holder's binaries

Parameters:

dataHolder - The data holder

zos - The ZipOutputStream where to export the binaries

path - The path of the folder used to export the binaries

Throws:

IOException - if an error occurs while exporting the binaries

exportFiles

public static void exportFiles(ModelAwareDataHolder dataHolder,
                               ZipOutputStream zos,
                               String path)
                        throws IOException

Export the given data holder's files

Parameters:

dataHolder - The data holder

zos - The ZipOutputStream where to export the files

path - The path of the folder used to export the files

Throws:

IOException - if an error occurs while exporting the files

_exportResource

private static void _exportResource(String dataPath,
                                    NamedResource resource,
                                    ZipOutputStream zos,
                                    String prefix)
                             throws IOException

Throws:

IOException

getFolderPathFromDataPath

public static String getFolderPathFromDataPath(String dataPath)

Retrieves a folder path from a data path. Replaces all repeater entries like '[x]', to a folder with the position ('/x')

Parameters:

dataPath - the data path

Returns:

the folder path