Package org.ametys.plugins.odfsync.pegase.scc

Class PegaseSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

org.ametys.plugins.odfsync.pegase.scc.PegaseSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, Configurable, Contextualizable, Serviceable

public class PegaseSynchronizableContentsCollection
extends AbstractSimpleSynchronizableContentsCollection
implements Contextualizable

SCC for Pegase (COF).

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	__PARAM_COLUMNS	Name of paramter holding columns
protected static final String	__PARAM_COLUMNS_COLUMN	Name of paramter into columns holding column
protected static final String	__PARAM_ID_COLUMN	Name of parameter holding the field ID column
protected static final String	__PARAM_MAPPING	Name of parameter holding the fields mapping
protected CatalogsManager	_catalogsManager	The catalogs manager
protected CDMFRHandler	_cdmfrHandler	The CDM-fr handler
protected Set<String>	_columns	Synchronized fields
protected Map<String,Set<String>>	_contentsChildren	Map to link contents to its children at the end of the process
protected Context	_context	Context
protected String	_idColumn	Name of the Pégase column which contains the ID
protected Map<String,Integer>	_importedContents	List of imported contents
protected JSONUtils	_jsonUtils	The JSON utils
protected Map<String,Map<String,SynchronizableContentsCollectionMappingHelper.MappingEntry>>	_mappingByContentType	Mapping between ametys attribute and Pégase mapping, by content type
protected String	_odfLang	Default language configured for ODF
protected PegaseApiManager	_pegaseApiManager	The Pégase API manager
protected PegaseSCCMappingHelper	_pegaseSccMappingHelper	The PégaseSCC helper
protected OdfReferenceTableHelper	_refTableHelper	The reference table helper
protected SynchronizableContentsCollectionMappingHelper	_sccMappingHelper	The SCC mapping helper
protected String	_structureCode	The structure code for Pégase
protected Map<String,Set<String>>	_syncFieldsByContentType	Synchronized fields by content type
protected Set<String>	_synchronizedContents	List of synchronized contents having differences
protected Set<String>	_updatedRelationContents	List of updated contents by relation

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

_contentHelper, _synchronizingContentOperatorEP

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

_contentWorkflowHelper, _currentUserProvider, _hasGlobalError, _i18nUtils, _nbCreatedContents, _nbDeletedContents, _nbError, _nbNotChangedContents, _nbSynchronizedContents, _observationManager, _userLanguagesManager, SCC_UNIQUE_ID

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

_checkCollection, _compatibleSCC, _contentDAO, _contentPrefix, _contentType, _contentTypeEP, _id, _ignoreRestrictions, _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_DATA_NAME, LAST_SYNCHRONIZATION_DATA_NAME, LAST_SYNCHRONIZATION_USER_DATA_NAME, RESULT_NB_CREATED_CONTENTS, RESULT_NB_DELETED_CONTENTS, RESULT_NB_NOT_CHANGED_CONTENTS, RESULT_NB_SYNCHRONIZED_CONTENTS

Constructor Summary

Constructors

Constructor	Description
PegaseSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method	Description
protected boolean	_fillContent(Map<String,List<Object>> remoteValues, ModifiableContent content, Map<String,Object> additionalParameters, boolean create, org.slf4j.Logger logger)	Fill the content with remote values.
protected Object	_findDataInFields(String dataPath, Map<String,Object> fields)	Find nested data in fields
protected ModifiableContent	_getContent(String lang, String syncCode, String contentType)	Get the content from the synchronization code, the lang, the catalog and the content type.
protected List<Expression>	_getExpressionsList(String lang, String idValue, String contentType, boolean forceStrictCheck)	Construct the query to retrieve the content.
protected ModifiableContent	_getOrCreateContent(String lang, String idValue, Map<String,List<Object>> remoteValues, boolean forceImport, org.slf4j.Logger logger)	Get or create the content defined by the given parameters.
protected Optional<ModifiableContent>	_importOrSynchronizeContent(String idValue, String lang, Map<String,List<Object>> remoteValues, boolean forceImport, org.slf4j.Logger logger)	Imports or synchronizes a content for a given language
protected List<ModifiableContent>	_importOrSynchronizeContents(Map<String,Object> searchParams, boolean forceImport, org.slf4j.Logger logger, ContainerProgressionTracker progressionTracker)	Import or synchronize several contents from search params.
protected ModifiableContent	_synchronizeContent(ModifiableContent content, Map<String,List<Object>> remoteValues, org.slf4j.Logger logger)	Synchronize a content with remove values.
protected Map<String,Object>	_transformRemoteValuesCardinality(Map<String,List<Object>> remoteValues, String obsoleteContentTypeId)	Transform the remote values to take each attribute cardinality into account
ContentSynchronizationResult	additionalCommonOperations(ModifiableContent content, Map<String,Object> additionalParameters, org.slf4j.Logger logger)	Add specific fields to the content during import or synchronization.
protected void	configureDataSource(Configuration configuration)	Configure the data source parameters.
protected void	configureSearchModel()	Configure the search model used by SCCSearchTool.
void	contextualize(Context context)
protected String	getCatalog()	Get the catalog for import.
protected String	getIdColumn()	Get the identifier JSON field.
String	getIdField()	Get the path of metadata holding the unique identifier
List<String>	getLanguages()	Get the languages handled by this collection
Set<String>	getLocalAndExternalFields(Map<String,Object> additionalParameters)	Get the path of tri-state fields (with local and external values)
protected Map<String,Map<String,List<Object>>>	getRemoteValues(Map<String,Object> parameters, org.slf4j.Logger logger)	Search values and return the result organized by attributes
int	getTotalCount(Map<String,Object> searchParameters, org.slf4j.Logger logger)	Return the total number of results for the search.
boolean	handleRightAssignmentContext()	Return true if a RightAssignmentContext should be automatically generated for the contents of this SCC
List<ModifiableContent>	importContent(String idValue, Map<String,Object> importParams, org.slf4j.Logger logger)	Import a content from remote values.
protected Map<String,Map<String,Object>>	internalSearch(Map<String,Object> parameters, int offset, int limit, List<Object> sort, org.slf4j.Logger logger)	Search values and return the result without any treatment.
protected Map<String,Object>	putIdParameter(String idValue)	Set search parameters for the ID value.
void	service(ServiceManager manager)
void	synchronizeContent(ModifiableContent content, org.slf4j.Logger logger)	Synchronize a content with remove values.

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

_addEditInputsForSCC, _editContent, _getContentsToRemove, _getEditInputs, _getEditInputsContextParameters, _handleContent, _importContent, _importOrSynchronizeContent, _importOrSynchronizeContents, _internalPopulate, _isHandled, _transformRemoteValues, configure, createContentAction, ensureTitleIsPresent, getAdditionalAttributeValues, getContent, getNotSynchronizedRelatedContentIds, getTransformedRemoteValues, populate, search, updateSyncInformations, validateContent

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

_deleteContents, _getAdditionalInputsForContentCreation, _getContentPathQuery, _hasSomethingChanged, _internalPopulate, _isParamNotEmpty, _logSynchronizationResult, _removeEmptyParameters, _removeSCCOrDeleteContents, createContentAction, deleteUnexistingContents, empty, getSynchronizationResult, sendErrorMail, validateContent

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

_parseMultipleValuesConf, _parseParameters, checkCollection, configureStaticParams, getCompatibleSCC, getContentPrefix, getContentType, getId, getInitialActionId, getLabel, getParameterValues, getReportMails, getRestrictedField, getSearchModelConfiguration, getSynchronizeActionId, getSynchronizeCollectionModelId, getSynchronizingContentOperator, getValidateActionId, getWorkflowName, ignoreRestrictions, 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

additionalImportOperations, additionalSynchronizeOperations

Field Details

__PARAM_MAPPING

protected static final String __PARAM_MAPPING

Name of parameter holding the fields mapping

See Also:

• Constant Field Values

__PARAM_ID_COLUMN

protected static final String __PARAM_ID_COLUMN

Name of parameter holding the field ID column

See Also:

• Constant Field Values

__PARAM_COLUMNS

protected static final String __PARAM_COLUMNS

Name of paramter holding columns

See Also:

• Constant Field Values

__PARAM_COLUMNS_COLUMN

protected static final String __PARAM_COLUMNS_COLUMN

Name of paramter into columns holding column

See Also:

• Constant Field Values

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils

_sccMappingHelper

protected SynchronizableContentsCollectionMappingHelper _sccMappingHelper

The SCC mapping helper

_catalogsManager

protected CatalogsManager _catalogsManager

The catalogs manager

_pegaseApiManager

protected PegaseApiManager _pegaseApiManager

The Pégase API manager

_cdmfrHandler

protected CDMFRHandler _cdmfrHandler

The CDM-fr handler

_pegaseSccMappingHelper

protected PegaseSCCMappingHelper _pegaseSccMappingHelper

The PégaseSCC helper

_refTableHelper

protected OdfReferenceTableHelper _refTableHelper

The reference table helper

_idColumn

protected String _idColumn

Name of the Pégase column which contains the ID

_mappingByContentType

protected Map<String,Map<String,SynchronizableContentsCollectionMappingHelper.MappingEntry>> _mappingByContentType

Mapping between ametys attribute and Pégase mapping, by content type

_syncFieldsByContentType

protected Map<String,Set<String>> _syncFieldsByContentType

Synchronized fields by content type

_columns

protected Set<String> _columns

Synchronized fields

_context

protected Context _context

Context

_importedContents

protected Map<String,Integer> _importedContents

List of imported contents

_synchronizedContents

protected Set<String> _synchronizedContents

List of synchronized contents having differences

_updatedRelationContents

protected Set<String> _updatedRelationContents

List of updated contents by relation

_contentsChildren

protected Map<String,Set<String>> _contentsChildren

Map to link contents to its children at the end of the process

_odfLang

protected String _odfLang

Default language configured for ODF

_structureCode

protected String _structureCode

The structure code for Pégase

Constructor Details

PegaseSynchronizableContentsCollection

public PegaseSynchronizableContentsCollection()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSimpleSynchronizableContentsCollection

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getIdField

public String getIdField()

Description copied from interface: SynchronizableContentsCollection

Get the path of metadata holding the unique identifier

Specified by:

getIdField in interface SynchronizableContentsCollection

Returns:

the path to the metadata. Can be null.

getIdColumn

protected String getIdColumn()

Get the identifier JSON field.

Returns:

the column id

getLocalAndExternalFields

public Set<String> getLocalAndExternalFields(Map<String,Object> additionalParameters)

Description copied from interface: SynchronizableContentsCollection

Get the path of tri-state fields (with local and external values)

Specified by:

getLocalAndExternalFields in interface SynchronizableContentsCollection

Parameters:

additionalParameters - Additional parameters

Returns:

the synchronized fields

putIdParameter

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

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Set search parameters for the ID value.

Specified by:

putIdParameter in class AbstractSimpleSynchronizableContentsCollection

Parameters:

idValue - Value to search

Returns:

Map with the search parameters

configureDataSource

protected void configureDataSource(Configuration configuration)
                            throws ConfigurationException

Description copied from class: AbstractStaticSynchronizableContentsCollection

Configure the data source parameters.

Specified by:

configureDataSource in class AbstractStaticSynchronizableContentsCollection

Parameters:

configuration - Configuration to read

Throws:

ConfigurationException - If an error occurs

configureSearchModel

protected void configureSearchModel()

Description copied from class: AbstractStaticSynchronizableContentsCollection

Configure the search model used by SCCSearchTool.

Specified by:

configureSearchModel in class AbstractStaticSynchronizableContentsCollection

getCatalog

protected String getCatalog()

Get the catalog for import.

Returns:

the catalog

internalSearch

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

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Search values and return the result without any treatment.

Specified by:

internalSearch in class AbstractSimpleSynchronizableContentsCollection

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.

getTotalCount

public int getTotalCount(Map<String,Object> searchParameters,
 org.slf4j.Logger logger)

Description copied from interface: SynchronizableContentsCollection

Return the total number of results for the search.

Specified by:

getTotalCount in interface SynchronizableContentsCollection

Overrides:

getTotalCount in class AbstractSimpleSynchronizableContentsCollection

Parameters:

searchParameters - Parameters for the search

logger - The logger

Returns:

The total count

getRemoteValues

protected Map<String,Map<String,List<Object>>> getRemoteValues(Map<String,Object> parameters,
 org.slf4j.Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Search values and return the result organized by attributes

Specified by:

getRemoteValues in class AbstractSimpleSynchronizableContentsCollection

Parameters:

parameters - Search parameters to restrict the search

logger - The logger

Returns:

Map of results organized by attributes.

_findDataInFields

protected Object _findDataInFields(String dataPath,
 Map<String,Object> fields)

Find nested data in fields

Parameters:

dataPath - The data path

fields - The fields

Returns:

The value or null if it was not found.

importContent

public List<ModifiableContent> importContent(String idValue,
 Map<String,Object> importParams,
 org.slf4j.Logger logger)
                                      throws Exception

Description copied from interface: SynchronizableContentsCollection

Import a content from remote values.

Specified by:

importContent in interface SynchronizableContentsCollection

Overrides:

importContent in class AbstractSimpleSynchronizableContentsCollection

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.

synchronizeContent

public void synchronizeContent(ModifiableContent content,
 org.slf4j.Logger logger)
                        throws Exception

Description copied from interface: SynchronizableContentsCollection

Synchronize a content with remove values.

Specified by:

synchronizeContent in interface SynchronizableContentsCollection

Overrides:

synchronizeContent in class AbstractSimpleSynchronizableContentsCollection

Parameters:

content - The content to synchronize

logger - The logger

Throws:

Exception - if an error occurs.

_importOrSynchronizeContents

protected List<ModifiableContent> _importOrSynchronizeContents(Map<String,Object> searchParams,
 boolean forceImport,
 org.slf4j.Logger logger,
 ContainerProgressionTracker progressionTracker)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Import or synchronize several contents from search params.

Overrides:

_importOrSynchronizeContents in class AbstractSimpleSynchronizableContentsCollection

Parameters:

searchParams - Search parameters

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

logger - The logger

progressionTracker - The progression tracker

Returns:

The List of imported or synchronized ModifiableContent

_getOrCreateContent

protected ModifiableContent _getOrCreateContent(String lang,
 String idValue,
 Map<String,List<Object>> remoteValues,
 boolean forceImport,
 org.slf4j.Logger logger)
                                         throws Exception

Get or create the content defined by the given parameters.

Parameters:

lang - The content language

idValue - The synchronization code

remoteValues - The remote values

forceImport - true to force import (only on single import or unlimited global synchronization)

logger - The logger

Returns:

the content

Throws:

Exception - if an error occurs

_getContent

protected ModifiableContent _getContent(String lang,
 String syncCode,
 String contentType)

Get the content from the synchronization code, the lang, the catalog and the content type.

Parameters:

lang - The lang

syncCode - The synchronization code

contentType - The content type

Returns:

the retrieved content

_importOrSynchronizeContent

protected Optional<ModifiableContent> _importOrSynchronizeContent(String idValue,
 String lang,
 Map<String,List<Object>> remoteValues,
 boolean forceImport,
 org.slf4j.Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Imports or synchronizes a content for a given language

Overrides:

_importOrSynchronizeContent in class AbstractSimpleSynchronizableContentsCollection

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 imported or synchronized content

_synchronizeContent

protected ModifiableContent _synchronizeContent(ModifiableContent content,
 Map<String,List<Object>> remoteValues,
 org.slf4j.Logger logger)
                                         throws Exception

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Synchronize a content with remove values.

Overrides:

_synchronizeContent in class AbstractSimpleSynchronizableContentsCollection

Parameters:

content - The content to synchronize

remoteValues - Values to synchronize

logger - The logger

Returns:

The synchronized content

Throws:

Exception - if an error occurs

_fillContent

protected boolean _fillContent(Map<String,List<Object>> remoteValues,
 ModifiableContent content,
 Map<String,Object> additionalParameters,
 boolean create,
 org.slf4j.Logger logger)
                        throws Exception

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Fill the content with remote values.

Overrides:

_fillContent in class AbstractSimpleSynchronizableContentsCollection

Parameters:

remoteValues - The remote values

content - The content to synchronize

additionalParameters - Additional parameters

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

logger - The logger

Returns:

true if the content has been modified, false otherwise

Throws:

Exception - if an error occurs

getLanguages

public List<String> getLanguages()

Description copied from interface: SynchronizableContentsCollection

Get the languages handled by this collection

Specified by:

getLanguages in interface SynchronizableContentsCollection

Overrides:

getLanguages in class AbstractStaticSynchronizableContentsCollection

Returns:

the list of language

_getExpressionsList

protected List<Expression> _getExpressionsList(String lang,
 String idValue,
 String contentType,
 boolean forceStrictCheck)

Description copied from class: AbstractSynchronizableContentsCollection

Construct the query to retrieve the content.

Overrides:

_getExpressionsList in class AbstractSynchronizableContentsCollection

Parameters:

lang - Lang

idValue - Synchronization value

contentType - Content type

forceStrictCheck - true to force strict mode to check the collection, otherwise it read the "checkCollection" option

Returns:

The List of Expression

_transformRemoteValuesCardinality

protected Map<String,Object> _transformRemoteValuesCardinality(Map<String,List<Object>> remoteValues,
 String obsoleteContentTypeId)

Description copied from class: AbstractStaticSynchronizableContentsCollection

Transform the remote values to take each attribute cardinality into account

Overrides:

_transformRemoteValuesCardinality in class AbstractStaticSynchronizableContentsCollection

Parameters:

remoteValues - the remote values

obsoleteContentTypeId - the content type ID from which attributes come from

Returns:

the transformed values

handleRightAssignmentContext

public boolean handleRightAssignmentContext()

Description copied from interface: SynchronizableContentsCollection

Return true if a RightAssignmentContext should be automatically generated for the contents of this SCC

Specified by:

handleRightAssignmentContext in interface SynchronizableContentsCollection

Returns:

true to automatically generate a RightAssignmentContext. Return false if the rights of contents of this SCC are handle by its own RightAssignmentContext

additionalCommonOperations

public ContentSynchronizationResult additionalCommonOperations(ModifiableContent content,
 Map<String,Object> additionalParameters,
 org.slf4j.Logger logger)

Description copied from interface: SynchronizableContentsCollection

Add specific fields to the content during import or synchronization.

Specified by:

additionalCommonOperations in interface SynchronizableContentsCollection

Parameters:

content - Content to update

additionalParameters - Additional parameters

logger - The logger

Returns:

The synchronization result of the additional operations