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, PegaseSynchronizableContentsCollection, 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

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

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

_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, RESULT_NB_CREATED_CONTENTS, RESULT_NB_DELETED_CONTENTS, RESULT_NB_NOT_CHANGED_CONTENTS, RESULT_NB_SYNCHRONIZED_CONTENTS

Constructor Summary

Constructors

Constructor	Description
AbstractSimpleSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method	Description
protected void	_addEditInputsForSCC(Map<String,Object> inputs, WorkflowAwareContent content, Logger logger)	Add the inputs specific for the SCC to the inputs for edit content function.
protected boolean	_editContent(WorkflowAwareContent content, Optional<View> view, Map<String,Object> values, Map<String,Object> additionalParameters, boolean create, Set<String> notSynchronizedContentIds, Logger logger)	Synchronize the content with given values.
protected boolean	_fillContent(Map<String,List<Object>> remoteValues, ModifiableContent content, Map<String,Object> additionalParameters, boolean create, Logger logger)	Fill the content with remote values.
protected List<Content>	_getContentsToRemove(AmetysObjectIterable<ModifiableContent> contents)	Filter the contents to remove.
protected Map<String,Object>	_getEditInputs(WorkflowAwareContent content, Optional<View> view, Map<String,Object> values, Map<String,Object> additionalParameters, boolean create, Set<String> notSynchronizedContentIds, Logger logger)	Get the inputs for edit content function.
protected Map<String,Object>	_getEditInputsContextParameters(Optional<View> view, Map<String,Object> values, boolean create)	Get the context parameters to add to inputs for edit content function
protected void	_handleContent(String id)	Adds the given content as handled (i.e.
protected ModifiableContent	_importContent(String idValue, Map<String,Object> additionalParameters, String lang, Map<String,List<Object>> remoteValues, Logger logger)	Import a content from remote values.
protected Optional<ModifiableContent>	_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<ModifiableContent>	_importOrSynchronizeContent(String idValue, Map<String,List<Object>> remoteValues, boolean forceImport, Logger logger)	Imports or synchronizes a content for each available language
protected List<ModifiableContent>	_importOrSynchronizeContents(Map<String,Object> searchParameters, boolean forceImport, Logger logger)	Import or synchronize several contents from search params.
protected List<ModifiableContent>	_internalPopulate(Logger logger)	Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger)
protected boolean	_isHandled(String id)	Returns true if the given content is handled
protected ModifiableContent	_synchronizeContent(ModifiableContent content, Map<String,List<Object>> remoteValues, Logger logger)	Synchronize a content with remove values.
protected Map<String,Map<String,List<Object>>>	_transformRemoteValues(Map<String,Map<String,List<Object>>> remoteValues, Logger logger)	Transform the given remote values by the SynchronizingContentOperator if exists.
void	configure(Configuration configuration)
protected ModifiableContent	createContentAction(String lang, String contentTitle, Logger logger)	Creates content action with result from request
protected Map<String,Object>	getAdditionalAttributeValues(String idValue, Content content, Map<String,Object> additionalParameters, boolean create, Logger logger)	Retrieves additional values to synchronize for a content
ModifiableContent	getContent(String lang, String idValue)	Gets the content in the repository
protected Set<String>	getNotSynchronizedRelatedContentIds(Content content, Map<String,Object> contentValues, Map<String,Object> additionalParameters, String lang, Logger logger)	Retrieves the ids of the contents related to the given content but that are not part of the synchronization
protected abstract Map<String,Map<String,List<Object>>>	getRemoteValues(Map<String,Object> searchParameters, Logger logger)	Search values and return the result organized by attributes
int	getTotalCount(Map<String,Object> searchParameters, Logger logger)	Return the total number of results for the search.
protected Map<String,Map<String,List<Object>>>	getTransformedRemoteValues(Map<String,Object> searchParameters, Logger logger)	Search values and return the result organized by attributes and transformed by the SynchronizingContentOperator if exists.
List<ModifiableContent>	importContent(String idValue, Map<String,Object> additionalParameters, Logger logger)	Import a content from remote values.
protected abstract Map<String,Map<String,Object>>	internalSearch(Map<String,Object> searchParameters, int offset, int limit, List<Object> sort, Logger logger)	Search values and return the result without any treatment.
List<ModifiableContent>	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> searchParameters, int offset, int limit, List<Object> sort, Logger logger)	Search the data to import from parameters.
void	service(ServiceManager manager)
void	synchronizeContent(ModifiableContent content, Logger logger)	Synchronize a content with remove values.
void	updateSyncInformations(ModifiableContent 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, _getAdditionalInputsForContentCreation, _getContentPathQuery, _getExpressionsList, _hasSomethingChanged, _isParamNotEmpty, _logSynchronizationResult, _removeEmptyParameters, createContentAction, deleteUnexistingContents, empty, getSynchronizationResult, sendErrorMail, validateContent

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

_parseLanguages, _parseParameters, _transformRemoteValuesCardinality, configureDataSource, configureSearchModel, configureStaticParams, getContentPrefix, getContentType, getId, getInitialActionId, getLabel, getLanguages, 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

additionalCommonOperations, additionalImportOperations, additionalSynchronizeOperations, 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<ModifiableContent> 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<ModifiableContent> _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<ModifiableContent> _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 Optional<ModifiableContent> _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 imported or synchronized content

synchronizeContent

public void synchronizeContent(ModifiableContent 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 ModifiableContent _synchronizeContent(ModifiableContent 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<ModifiableContent> importContent(String idValue,
 Map<String,Object> additionalParameters,
 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

additionalParameters - 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 ModifiableContent _importContent(String idValue,
 Map<String,Object> additionalParameters,
 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

additionalParameters - 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.

getContent

public ModifiableContent 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 ModifiableContent 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 occurs

_fillContent

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

Fill the content with remote values.

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

_editContent

protected boolean _editContent(WorkflowAwareContent content,
 Optional<View> view,
 Map<String,Object> values,
 Map<String,Object> additionalParameters,
 boolean create,
 Set<String> notSynchronizedContentIds,
 Logger logger)
                        throws com.opensymphony.workflow.WorkflowException

Synchronize the content with given values.

Parameters:

content - The content to synchronize

view - the view containing the item to edit

values - the values

additionalParameters - Additional parameters

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

notSynchronizedContentIds - the ids of the contents related to the given content but that are not part of the synchronization

logger - The logger

Returns:

true if the content has been modified, false otherwise

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs

_getEditInputs

protected Map<String,Object> _getEditInputs(WorkflowAwareContent content,
 Optional<View> view,
 Map<String,Object> values,
 Map<String,Object> additionalParameters,
 boolean create,
 Set<String> notSynchronizedContentIds,
 Logger logger)

Get the inputs for edit content function.

Parameters:

content - The content to synchronize

view - the view containing the item to edit

values - the values

additionalParameters - Additional parameters

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

notSynchronizedContentIds - the ids of the contents related to the given content but that are not part of the synchronization

logger - The logger

Returns:

the input parameters

_addEditInputsForSCC

protected void _addEditInputsForSCC(Map<String,Object> inputs,
 WorkflowAwareContent content,
 Logger logger)

Add the inputs specific for the SCC to the inputs for edit content function.

Parameters:

inputs - The inputs to complete

content - The content to synchronize

logger - The logger

_getEditInputsContextParameters

protected Map<String,Object> _getEditInputsContextParameters(Optional<View> view,
 Map<String,Object> values,
 boolean create)

Get the context parameters to add to inputs for edit content function

Parameters:

view - the view containing the item to edit

values - the values

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

Returns:

the context parameters

validateContent

protected void validateContent(WorkflowAwareContent content,
 Logger logger)

Validates a content after import

Parameters:

content - The content to validate

logger - The logger

search

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

Description copied from interface: SynchronizableContentsCollection

Search the data to import from parameters.

Parameters:

searchParameters - 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> searchParameters,
 int offset,
 int limit,
 List<Object> sort,
 Logger logger)

Search values and return the result without any treatment.

Parameters:

searchParameters - 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> searchParameters,
 Logger logger)

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

Parameters:

searchParameters - Search parameters to restrict the search

logger - The logger

Returns:

Map of results organized by attributes.

getRemoteValues

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

Search values and return the result organized by attributes

Parameters:

searchParameters - Search parameters to restrict the search

logger - The logger

Returns:

Map of results organized by attributes.

_transformRemoteValues

protected Map<String,Map<String,List<Object>>> _transformRemoteValues(Map<String,Map<String,List<Object>>> remoteValues,
 Logger logger)

Transform the given remote values by the SynchronizingContentOperator if exists.

Parameters:

remoteValues - The remote values

logger - The logger

Returns:

the transformed values

getAdditionalAttributeValues

protected Map<String,Object> getAdditionalAttributeValues(String idValue,
 Content content,
 Map<String,Object> additionalParameters,
 boolean create,
 Logger logger)

Retrieves additional values to synchronize for a content

Parameters:

idValue - id value of the content

content - The content

additionalParameters - Additional parameters

create - true if the content has been newly created, false otherwise

logger - The logger

Returns:

the values to add

getNotSynchronizedRelatedContentIds

protected Set<String> getNotSynchronizedRelatedContentIds(Content content,
 Map<String,Object> contentValues,
 Map<String,Object> additionalParameters,
 String lang,
 Logger logger)

Retrieves the ids of the contents related to the given content but that are not part of the synchronization

Parameters:

content - content

contentValues - the content values that will be set

additionalParameters - Additional parameters

lang - Language of the content

logger - The logger

Returns:

the ids of the contents that are not part of the synchronization

updateSyncInformations

public void updateSyncInformations(ModifiableContent 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> searchParameters,
 Logger logger)

Description copied from interface: SynchronizableContentsCollection

Return the total number of results for the search.

Parameters:

searchParameters - Parameters for the search

logger - The logger

Returns:

The total count

_importOrSynchronizeContents

protected List<ModifiableContent> _importOrSynchronizeContents(Map<String,Object> searchParameters,
 boolean forceImport,
 Logger logger)

Import or synchronize several contents from search params.

Parameters:

searchParameters - Search parameters

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

logger - The logger

Returns:

The List of imported or synchronized ModifiableContent

_getContentsToRemove

protected List<Content> _getContentsToRemove(AmetysObjectIterable<ModifiableContent> 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.