Package org.ametys.plugins.contentio.synchronize

Class AbstractSimpleSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, Configurable, Serviceable

Direct Known Subclasses:

AbstractApogeeSynchronizableContentsCollection, AbstractDataSourceSynchronizableContentsCollection, UserPopulationSynchronizableContentsCollection

public abstract class AbstractSimpleSynchronizableContentsCollection
extends AbstractSynchronizableContentsCollection

Abstract implementation of SynchronizableContentsCollection.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentHelper	_contentHelper	The content helper
protected SynchronizingContentOperatorExtensionPoint	_synchronizingContentOperatorEP	The extension point for Synchronizing Content Operators

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

_contentTypeEP, _currentUserProvider, _hasGlobalError, _i18nUtils, _nbCreatedContents, _nbDeletedContents, _nbError, _nbNotChangedContents, _nbSynchronizedContents, _observationManager, _synchroComponent, SCC_UNIQUE_ID

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

_contentDAO, _contentPrefix, _contentType, _id, _initialActionId, _label, _languages, _modelId, _modelParamValues, _removalSync, _reportMails, _resolver, _restrictedField, _sccHelper, _searchModelConfiguration, _synchronizeActionId, _synchronizeExistingContentsOnly, _synchronizingContentOperator, _validateActionId, _validateAfterImport, _workflowName

Fields inherited from interface org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollection

COLLECTION_ID_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractSimpleSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method	Description
protected boolean	_fillContent(Map<String,List<Object>> remoteValues, ModifiableDefaultContent content, boolean create, Logger logger)	Fill the content with remote values.
protected List<Content>	_getContentsToRemove(AmetysObjectIterable<ModifiableDefaultContent> contents)	Filter the contents to remove.
protected String	_getIdFieldValue(DefaultContent content)	Get the value of metadata holding the unique identifier of the synchronized content
protected void	_handleContent(String id)	Adds the given content as handled (i.e.
protected ModifiableDefaultContent	_importContent(String idValue, Map<String,Object> importParams, String lang, Map<String,List<Object>> remoteValues, Logger logger)	Import a content from remote values.
protected List<ModifiableDefaultContent>	_importOrSynchronizeContent(String idValue, String lang, Map<String,List<Object>> remoteValues, boolean forceImport, Logger logger)	Imports or synchronizes a content for a given language
protected List<ModifiableDefaultContent>	_importOrSynchronizeContent(String idValue, Map<String,List<Object>> remoteValues, boolean forceImport, Logger logger)	Imports or synchronizes a content for each available language
protected List<ModifiableDefaultContent>	_importOrSynchronizeContents(Map<String,Object> searchParams, boolean forceImport, Logger logger)	Import or synchronize several contents from search params.
protected List<ModifiableDefaultContent>	_internalPopulate(Logger logger)	Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger)
protected boolean	_isHandled(String id)	Returns true if the given content is handled
protected ModifiableDefaultContent	_synchronizeContent(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, Logger logger)	Synchronize a content with remove values.
protected boolean	additionalCommonOperations(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, Map<String,Object> importParams, boolean create, Logger logger)	Add specific fields to the content during import or synchronization.
protected boolean	additionalImportOperations(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, Map<String,Object> importParams, Logger logger)	Add specific fields to the content.
protected boolean	additionalSynchronizeOperations(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, Logger logger)	Add specific fields to the content.
void	configure(Configuration configuration)
protected ModifiableDefaultContent	createContentAction(String lang, String contentTitle, Logger logger)	Creates content action with result from request
ModifiableDefaultContent	getContent(String lang, String idValue)	Gets the content in the repository
protected abstract Map<String,Map<String,List<Object>>>	getRemoteValues(Map<String,Object> parameters, Logger logger)	Search values and return the result organized by metadata
int	getTotalCount(Map<String,Object> parameters, Logger logger)	Return the total number of results for the search.
protected Map<String,Map<String,List<Object>>>	getTransformedRemoteValues(Map<String,Object> parameters, Logger logger)	Search values and return the result organized by metadata and transformed by the SynchronizingContentOperator if exists.
List<ModifiableDefaultContent>	importContent(String idValue, Map<String,Object> importParams, Logger logger)	Import a content from remote values.
protected abstract Map<String,Map<String,Object>>	internalSearch(Map<String,Object> parameters, int offset, int limit, List<Object> sort, Logger logger)	Search values and return the result without any treatment.
List<ModifiableDefaultContent>	populate(Logger logger)	Populates contents
protected abstract Map<String,Object>	putIdParameter(String idValue)	Set search parameters for the ID value.
Map<String,Map<String,Object>>	search(Map<String,Object> parameters, int offset, int limit, List<Object> sort, Logger logger)	Search the data to import from parameters.
void	service(ServiceManager manager)
void	synchronizeContent(ModifiableDefaultContent content, Logger logger)	Synchronize a content with remove values.
void	updateSyncInformations(ModifiableDefaultContent content, String syncCode, Logger logger)	Method to update the synchronisation informations (collection and value of the ID field).
protected void	validateContent(WorkflowAwareContent content, Logger logger)	Validates a content after import

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

_deleteContents, _getContentPathQuery, _getExpressionsList, _getMetadataHolder, _isParamNotEmpty, _removeEmptyParameters, _removeMetadataIfExists, _synchronizeMetadata, _updateRelation, _updateRelation, applyChanges, applyChanges, createContentAction, deleteUnexistingContents, empty, sendErrorMail, updateSCCProperty, validateContent

Methods inherited from class org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

_parseLanguages, _parseParameters, configureDataSource, configureSearchModel, configureStaticParams, getContentPrefix, getContentType, getId, getInitialActionId, getLabel, getLanguages, getParameterValues, getReportMails, getRestrictedField, getSearchModelConfiguration, getSynchronizeActionId, getSynchronizeCollectionModelId, getSynchronizingContentOperator, getValidateActionId, getWorkflowName, removalSync, synchronizeExistingContentsOnly, validateAfterImport

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.synchronize.SynchronizableContentsCollection

getExternalOnlyFields, getIdField, getLocalAndExternalFields, handleRightAssignmentContext

Field Details

_synchronizingContentOperatorEP

protected SynchronizingContentOperatorExtensionPoint _synchronizingContentOperatorEP

The extension point for Synchronizing Content Operators

_contentHelper

protected ContentHelper _contentHelper

The content helper

Constructor Details

AbstractSimpleSynchronizableContentsCollection

public AbstractSimpleSynchronizableContentsCollection()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSynchronizableContentsCollection

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractStaticSynchronizableContentsCollection

Throws:

ConfigurationException

populate

public List<ModifiableDefaultContent> populate(Logger logger)

Description copied from interface: SynchronizableContentsCollection

Populates contents

Specified by:

populate in interface SynchronizableContentsCollection

Overrides:

populate in class AbstractSynchronizableContentsCollection

Parameters:

logger - The logger

Returns:

Return the populated contents (imported or synchronized)

_internalPopulate

protected List<ModifiableDefaultContent> _internalPopulate(Logger logger)

Description copied from class: AbstractSynchronizableContentsCollection

Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger)

Specified by:

_internalPopulate in class AbstractSynchronizableContentsCollection

Parameters:

logger - The logger

Returns:

The list of created/synchronized contents

_handleContent

protected void _handleContent(String id)

Adds the given content as handled (i.e. will not be removed if _removalSync is true)

Parameters:

id - The id of the content

_isHandled

protected boolean _isHandled(String id)

Returns true if the given content is handled

Parameters:

id - The content to test

Returns:

true if the given content is handled

_importOrSynchronizeContent

protected List<ModifiableDefaultContent> _importOrSynchronizeContent(String idValue,
 Map<String,List<Object>> remoteValues,
 boolean forceImport,
 Logger logger)

Imports or synchronizes a content for each available language

Parameters:

idValue - The unique identifier of the content

remoteValues - The remote values

forceImport - To force import and ignoring the synchronize existing contents only option

logger - The logger

Returns:

The list of synchronized or imported contents

_importOrSynchronizeContent

protected List<ModifiableDefaultContent> _importOrSynchronizeContent(String idValue,
 String lang,
 Map<String,List<Object>> remoteValues,
 boolean forceImport,
 Logger logger)

Imports or synchronizes a content for a given language

Parameters:

idValue - The unique identifier of the content

lang - The language of content to import or synchronize

remoteValues - The remote values

forceImport - To force import and ignoring the synchronize existing contents only option

logger - The logger

Returns:

The list of imported and synchronized contents

synchronizeContent

public void synchronizeContent(ModifiableDefaultContent content,
 Logger logger)
                        throws Exception

Description copied from interface: SynchronizableContentsCollection

Synchronize a content with remove values.

Parameters:

content - The content to synchronize

logger - The logger

Throws:

Exception - if an error occurs.

_synchronizeContent

protected ModifiableDefaultContent _synchronizeContent(ModifiableDefaultContent content,
 Map<String,List<Object>> remoteValues,
 Logger logger)
                                                throws Exception

Synchronize a content with remove values.

Parameters:

content - The content to synchronize

remoteValues - Values to synchronize

logger - The logger

Returns:

The synchronized content

Throws:

Exception - if an error occurs.

importContent

public List<ModifiableDefaultContent> importContent(String idValue,
 Map<String,Object> importParams,
 Logger logger)
                                             throws Exception

Description copied from interface: SynchronizableContentsCollection

Import a content from remote values.

Parameters:

idValue - Id (for import/synchronization) of the content to import

importParams - Additional parameters

logger - The logger

Returns:

A list of created contents

Throws:

Exception - if an error occurs.

putIdParameter

protected abstract Map<String,Object> putIdParameter(String idValue)

Set search parameters for the ID value.

Parameters:

idValue - Value to search

Returns:

Map with the search parameters

_importContent

protected ModifiableDefaultContent _importContent(String idValue,
 Map<String,Object> importParams,
 String lang,
 Map<String,List<Object>> remoteValues,
 Logger logger)
                                           throws Exception

Import a content from remote values.

Parameters:

idValue - Id (for import/synchronization) of the content to import

importParams - Specific parameters for import

lang - Lang of the content

remoteValues - Values of the content

logger - The logger

Returns:

The content created by import, or null

Throws:

Exception - if an error occurs.

additionalImportOperations

protected boolean additionalImportOperations(ModifiableDefaultContent content,
 Map<String,List<Object>> remoteValues,
 Map<String,Object> importParams,
 Logger logger)

Add specific fields to the content.

Parameters:

content - Content to update

remoteValues - Values of the content

importParams - Import parameters

logger - The logger

Returns:

true if there are changes

additionalSynchronizeOperations

protected boolean additionalSynchronizeOperations(ModifiableDefaultContent content,
 Map<String,List<Object>> remoteValues,
 Logger logger)

Add specific fields to the content.

Parameters:

content - Content to update

remoteValues - Values of the content

logger - The logger

Returns:

true if there are changes

additionalCommonOperations

protected boolean additionalCommonOperations(ModifiableDefaultContent content,
 Map<String,List<Object>> remoteValues,
 Map<String,Object> importParams,
 boolean create,
 Logger logger)

Add specific fields to the content during import or synchronization.

Parameters:

content - Content to update

remoteValues - Values of the content

importParams - the import params

create - true if the content has been newly created

logger - The logger

Returns:

true if there are changes

getContent

public ModifiableDefaultContent getContent(String lang,
 String idValue)

Description copied from interface: SynchronizableContentsCollection

Gets the content in the repository

Parameters:

lang - the language

idValue - the content name

Returns:

the content in the repository, or null if does not exist

createContentAction

protected ModifiableDefaultContent createContentAction(String lang,
 String contentTitle,
 Logger logger)

Creates content action with result from request

Parameters:

lang - The language

contentTitle - The content title

logger - The logger

Returns:

The content id, or null of a workflow error occured

_fillContent

protected boolean _fillContent(Map<String,List<Object>> remoteValues,
 ModifiableDefaultContent content,
 boolean create,
 Logger logger)

Fill the content with remote values.

Parameters:

remoteValues - The remote values

content - The content to synchronize

create - true if content is creating, false if it is updated

logger - The logger

Returns:

true if changes were made

validateContent

protected void validateContent(WorkflowAwareContent content,
 Logger logger)

Validates a content after import

Parameters:

content - The content to validate

logger - The logger

_getIdFieldValue

protected String _getIdFieldValue(DefaultContent content)

Get the value of metadata holding the unique identifier of the synchronized content

Parameters:

content - The content

Returns:

The value

search

public Map<String,Map<String,Object>> search(Map<String,Object> parameters,
 int offset,
 int limit,
 List<Object> sort,
 Logger logger)

Description copied from interface: SynchronizableContentsCollection

Search the data to import from parameters.

Parameters:

parameters - Parameters for the search

offset - Begin of the search

limit - Number of results

sort - Sort of results (ignored for LDAP results)

logger - The logger

Returns:

A map of remote values by content

internalSearch

protected abstract Map<String,Map<String,Object>> internalSearch(Map<String,Object> parameters,
 int offset,
 int limit,
 List<Object> sort,
 Logger logger)

Search values and return the result without any treatment.

Parameters:

parameters - Search parameters to restrict the search

offset - Begin of the search

limit - Number of results

sort - Sort of results (ignored for LDAP results)

logger - The logger

Returns:

Map of results without any treatment.

getTransformedRemoteValues

protected Map<String,Map<String,List<Object>>> getTransformedRemoteValues(Map<String,Object> parameters,
 Logger logger)

Search values and return the result organized by metadata and transformed by the SynchronizingContentOperator if exists.

Parameters:

parameters - Search parameters to restrict the search

logger - The logger

Returns:

Map of results organized by metadata.

getRemoteValues

protected abstract Map<String,Map<String,List<Object>>> getRemoteValues(Map<String,Object> parameters,
 Logger logger)

Search values and return the result organized by metadata

Parameters:

parameters - Search parameters to restrict the search

logger - The logger

Returns:

Map of results organized by metadata.

updateSyncInformations

public void updateSyncInformations(ModifiableDefaultContent content,
 String syncCode,
 Logger logger)
                            throws Exception

Description copied from interface: SynchronizableContentsCollection

Method to update the synchronisation informations (collection and value of the ID field).

Parameters:

content - Content to update

syncCode - New synchronization code

logger - The logger

Throws:

Exception - if an error occurs.

getTotalCount

public int getTotalCount(Map<String,Object> parameters,
 Logger logger)

Description copied from interface: SynchronizableContentsCollection

Return the total number of results for the search.

Parameters:

parameters - Parameters for the search

logger - The logger

Returns:

The total count

_importOrSynchronizeContents

protected List<ModifiableDefaultContent> _importOrSynchronizeContents(Map<String,Object> searchParams,
 boolean forceImport,
 Logger logger)

Import or synchronize several contents from search params.

Parameters:

searchParams - Search parameters

forceImport - To force import and ignoring the synchronize existing contents only option

logger - The logger

Returns:

The List of imported or synchronized ModifiableDefaultContent

_getContentsToRemove

protected List<Content> _getContentsToRemove(AmetysObjectIterable<ModifiableDefaultContent> contents)

Description copied from class: AbstractSynchronizableContentsCollection

Filter the contents to remove.

Specified by:

_getContentsToRemove in class AbstractSynchronizableContentsCollection

Parameters:

contents - The list of all the available contents

Returns:

The List of Content to remove.