Package org.ametys.plugins.contentio.synchronize

Class SynchronizableContentsCollectionHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollectionHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class SynchronizableContentsCollectionHelper
extends AbstractLogEnabled
implements Serviceable, Component

Helper for Synchronizable Contents Collections.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeEP	The content type extension point
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected AmetysObjectResolver	_resolver	The Ametys resolver
protected SynchronizableContentsCollectionDAO	_sccDAO	SCC DAO
static final String	ROLE	The Avalon Role

Constructor Summary

Constructors

Constructor	Description
SynchronizableContentsCollectionHelper()

Method Summary

Modifier and Type	Method	Description
Expression	getCollectionExpression(String collectionId)	Retrieves a query expression testing the collection
SynchronizableContentsCollection	getSCCFromModelId(String modelId)	Get the first SynchronizableContentsCollection found for the given SCC model id.
String	getSyncCode(String contentId, String collectionId)	Get the value of the synchronization field.
Set<String>	getSynchronizableCollectionIds(Content content)	Retrieves the synchronizable collection identifiers
Map<String,Object>	importContent(String collectionId, String id, Map<String,Object> additionalParameters)	Import the content specified by the id in the specified collection.
Map<String,Map<String,List<Object>>>	organizeRemoteValuesByAttribute(Map<String,Map<String,Object>> searchResult, Map<String,List<String>> mapping)	Transform results to be organized by content attribute, and remove the null values.
void	removeSCCProperty(Content content, String collectionId)	Remove the synchronizable collection id from the SCC property
void	service(ServiceManager smanager)
boolean	synchronizeContent(String collectionId, String contentId, String syncCode)	Synchronize the content on the given collection with the given synchronization code.
void	updateLastSynchronizationProperties(Content content)	Update the given content's synchronization properties
void	updateSCCProperty(Content content, String collectionId)	Add the given synchronizable collection id to the existing ones

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 Details

ROLE

public static final String ROLE

The Avalon Role

_sccDAO

protected SynchronizableContentsCollectionDAO _sccDAO

SCC DAO

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

The content type extension point

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_resolver

protected AmetysObjectResolver _resolver

The Ametys resolver

Constructor Details

SynchronizableContentsCollectionHelper

public SynchronizableContentsCollectionHelper()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getSCCFromModelId

public SynchronizableContentsCollection getSCCFromModelId(String modelId)

Get the first SynchronizableContentsCollection found for the given SCC model id.

Parameters:

modelId - Id of the SCC model

Returns:

The first SCC found or null

organizeRemoteValuesByAttribute

public Map<String,Map<String,List<Object>>> organizeRemoteValuesByAttribute(Map<String,Map<String,Object>> searchResult,
 Map<String,List<String>> mapping)

Transform results to be organized by content attribute, and remove the null values.

Parameters:

searchResult - Remote values from a search by content and column or attribute

mapping - Mapping between content attribute and columns/attributes

Returns:

A Map of possible attribute values organized by content synchronization key and attribute name

updateSCCProperty

public void updateSCCProperty(Content content,
 String collectionId)

Add the given synchronizable collection id to the existing ones

Parameters:

content - The synchronized content

collectionId - The ID of the collection to add

removeSCCProperty

public void removeSCCProperty(Content content,
 String collectionId)

Remove the synchronizable collection id from the SCC property

Parameters:

content - The synchronized content

collectionId - The ID of the collection to remove

updateLastSynchronizationProperties

public void updateLastSynchronizationProperties(Content content)

Update the given content's synchronization properties

Parameters:

content - the synchronized content

getSynchronizableCollectionIds

public Set<String> getSynchronizableCollectionIds(Content content)
                                           throws AmetysRepositoryException

Retrieves the synchronizable collection identifiers

Parameters:

content - the content

Returns:

the synchronizable collection identifiers

Throws:

AmetysRepositoryException - if an error occurs while reading SCC info on the given content

getCollectionExpression

public Expression getCollectionExpression(String collectionId)

Retrieves a query expression testing the collection

Parameters:

collectionId - the identifier of the collection to test

Returns:

the query expression

importContent

public Map<String,Object> importContent(String collectionId,
 String id,
 Map<String,Object> additionalParameters)

Import the content specified by the id in the specified collection.

Parameters:

collectionId - Collection ID

id - Synchronization ID of the content

additionalParameters - Additional parameters

Returns:

Imported contents

synchronizeContent

public boolean synchronizeContent(String collectionId,
 String contentId,
 String syncCode)

Synchronize the content on the given collection with the given synchronization code.

Parameters:

collectionId - Collection ID

contentId - Content ID

syncCode - Synchronization code

Returns:

true if an error occurred

getSyncCode

public String getSyncCode(String contentId,
 String collectionId)

Get the value of the synchronization field.

Parameters:

contentId - Content ID

collectionId - Collection ID

Returns:

The value of the synchronization field