org.ametys.cms.content.autosave

Class ContentBackupClientInteraction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.content.autosave.ContentBackupClientInteraction

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class ContentBackupClientInteraction
extends AbstractLogEnabled
implements Serviceable, Component

Component for manipulating auto-backup on contents

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__AUTOSAVE_COMMENTS
private static String	__AUTOSAVE_CREATOR
private static String	__AUTOSAVE_INVALID_VALUES
private static String	__AUTOSAVE_NODETYPE
private static String	__AUTOSAVE_REPEATERS
private static String	__AUTOSAVE_TEMP_DATE
private static String	__AUTOSAVE_VALUES
private static String	__METADATA_NAME
private static String	__METADATA_VALUE
private static String	__REPEATER_COUNT
private static String	__REPEATER_NAME
private static String	__REPEATER_PREFIX
private CurrentUserProvider	_currentUserProvider
private JSONUtils	_jsonUtils
private AmetysObjectResolver	_resolver

Constructor Summary

Constructors

Constructor and Description
ContentBackupClientInteraction()

Method Summary

Modifier and Type	Method and Description
private Object	_decodeValue(String value)
private String	_encodeValue(Object value)
private Map<String,Object>	_getBackupData(CompositeMetadata metadataHolder)
Map<String,Object>	deleteContentBackup(String contentId) Delete an automatic backup for a content.
Map<String,Object>	getContentBackup(String contentId) Get the content backup information
protected DefaultTraversableAmetysObject	getContentNode(String contentId, boolean createNew) Get the storage node for a content in the automatic backup space, or create it if it doesn't exist.
protected DefaultTraversableAmetysObject	getOrCreateTempRoot() Get the temporary backup root, or create it if it doesn't exist.
protected void	removeAllComposites(ModifiableCompositeMetadata meta) Remove all the composite metadatas of a given composite.
void	service(ServiceManager manager)
Map<String,Object>	setContentBackup(String contentId, Map<String,Object> values, Map<String,Object> invalidValues, String comments, Collection<Map<String,String>> repeaters) Store an automatic backup for a content.
protected void	storeRepeaters(Collection<Map<String,String>> repeaters, ModifiableCompositeMetadata repeatersMeta) Store the repeater item counts to be able to re-initialize them.
protected void	storeValues(Map<String,Object> values, ModifiableCompositeMetadata valuesMeta) Store the metadata values (in composites named 1, 2, 3...)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

__AUTOSAVE_NODETYPE

private static final String __AUTOSAVE_NODETYPE

See Also:

Constant Field Values

__AUTOSAVE_CREATOR

private static final String __AUTOSAVE_CREATOR

See Also:

Constant Field Values

__AUTOSAVE_TEMP_DATE

private static final String __AUTOSAVE_TEMP_DATE

See Also:

Constant Field Values

__AUTOSAVE_COMMENTS

private static final String __AUTOSAVE_COMMENTS

See Also:

Constant Field Values

__AUTOSAVE_VALUES

private static final String __AUTOSAVE_VALUES

See Also:

Constant Field Values

__AUTOSAVE_INVALID_VALUES

private static final String __AUTOSAVE_INVALID_VALUES

See Also:

Constant Field Values

__AUTOSAVE_REPEATERS

private static final String __AUTOSAVE_REPEATERS

See Also:

Constant Field Values

__METADATA_NAME

private static final String __METADATA_NAME

See Also:

Constant Field Values

__METADATA_VALUE

private static final String __METADATA_VALUE

See Also:

Constant Field Values

__REPEATER_NAME

private static final String __REPEATER_NAME

See Also:

Constant Field Values

__REPEATER_COUNT

private static final String __REPEATER_COUNT

See Also:

Constant Field Values

__REPEATER_PREFIX

private static final String __REPEATER_PREFIX

See Also:

Constant Field Values

_resolver

private AmetysObjectResolver _resolver

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_jsonUtils

private JSONUtils _jsonUtils

Constructor Detail

ContentBackupClientInteraction

public ContentBackupClientInteraction()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getContentBackup

public Map<String,Object> getContentBackup(String contentId)

Get the content backup information

Parameters:

contentId - The content id

Returns:

The saved data

_getBackupData

private Map<String,Object> _getBackupData(CompositeMetadata metadataHolder)

deleteContentBackup

public Map<String,Object> deleteContentBackup(String contentId)

Delete an automatic backup for a content.

Parameters:

contentId - The content id

Returns:

A empty map

setContentBackup

public Map<String,Object> setContentBackup(String contentId,
                                           Map<String,Object> values,
                                           Map<String,Object> invalidValues,
                                           String comments,
                                           Collection<Map<String,String>> repeaters)

Store an automatic backup for a content.

Parameters:

contentId - The content id

values - The valid values to store

invalidValues - The invalid values to store

comments - The comments as JSON string

repeaters - The repeaters to store

Returns:

A empty Map

storeValues

protected void storeValues(Map<String,Object> values,
                           ModifiableCompositeMetadata valuesMeta)

Store the metadata values (in composites named 1, 2, 3...)

Parameters:

values - the meta values to store, as a Map of values, indexed by name.

valuesMeta - the composite metadata to store the values in.

_encodeValue

private String _encodeValue(Object value)

_decodeValue

private Object _decodeValue(String value)

storeRepeaters

protected void storeRepeaters(Collection<Map<String,String>> repeaters,
                              ModifiableCompositeMetadata repeatersMeta)

Store the repeater item counts to be able to re-initialize them.

Parameters:

repeaters - the repeaters data.

repeatersMeta - the composite metadata to store the repeaters in.

removeAllComposites

protected void removeAllComposites(ModifiableCompositeMetadata meta)

Remove all the composite metadatas of a given composite.

Parameters:

meta - the metadata to clear.

getContentNode

protected DefaultTraversableAmetysObject getContentNode(String contentId,
                                                        boolean createNew)

Get the storage node for a content in the automatic backup space, or create it if it doesn't exist.

Parameters:

contentId - the content ID.

createNew - true to create automatically the node when missing.

Returns:

the content backup storage node.

getOrCreateTempRoot

protected DefaultTraversableAmetysObject getOrCreateTempRoot()

Get the temporary backup root, or create it if it doesn't exist.

Returns:

the temporary backup root.