Package org.ametys.plugins.odfsync.apogee.scc.impl

Class StatistiquesBacGeneralSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.impl.AbstractDefaultSynchronizableContentsCollection

org.ametys.plugins.odfsync.apogee.scc.impl.StatistiquesBacGeneralSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, Configurable, Serviceable

public class StatistiquesBacGeneralSynchronizableContentsCollection
extends AbstractDefaultSynchronizableContentsCollection

SCC used to fill statistics on "Bac général" from Apogée data, it is a complementary SCC.

Field Summary

Fields

Modifier and Type	Field	Description
protected ApogeeSynchronizableContentsCollectionHelper	_apogeeSCCHelper	The Apogée SCC helper
protected ApogeeStatistiquesDAO	_apogeeStatistiquesDAO	The DAO for remote DB Apogee
protected CDMFRHandler	_cdmfrHandler	The CDM-fr handler
static final String	PARAM_DATASOURCE_ID	Name of parameter holding the data source id

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
StatistiquesBacGeneralSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method	Description
protected boolean	_editContent(WorkflowAwareContent content, Optional<View> view, Map<String,Object> values, Map<String,Object> additionalParameters, boolean create, Set<String> notSynchronizedContentIds, org.slf4j.Logger logger)	Synchronize the content with given values.
protected void	_endHandleCDMFR(Set<String> contentIds)	End handle CDM-fr treatments
protected List<Expression>	_getExpressionsList(String lang, String idValue, String contentType, boolean forceStrictCheck)	Construct the query to retrieve the content.
protected ModifiableContent	_importContent(String idValue, Map<String,Object> additionalParameters, String lang, Map<String,List<Object>> remoteValues, org.slf4j.Logger logger)	Import a content from remote values.
protected void	_startHandleCDMFR()	Start handle CDM-fr treatments
boolean	checkCollection()	When returns true, the process check the collection of contents to synchronize, can be a list of collections and not only the current one.
protected void	ensureTitleIsPresent(Content content, Map<String,List<Object>> remoteValues, org.slf4j.Logger logger)	Ensure that the title is present and set it to the current title if it is not present.
protected String	getDataSourceId()	Get the id of data source
String	getIdField()	Get the path of metadata holding the unique identifier
List<String>	getLanguages()	Get the languages handled by this collection
protected Map<String,Map<String,Object>>	internalSearch(Map<String,Object> initialSearchParameters, int offset, int limit, List<Object> sort, org.slf4j.Logger logger)	Search values and return the result without any treatment.
List<ModifiableContent>	populate(org.slf4j.Logger logger, ContainerProgressionTracker progressionTracker)	Populates contents
boolean	removalSync()	When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.
void	service(ServiceManager manager)
void	updateSyncInformations(ModifiableContent content, String syncCode, org.slf4j.Logger logger)	Method to update the synchronisation informations (collection and value of the ID field).

Methods inherited from class org.ametys.plugins.contentio.synchronize.impl.AbstractDefaultSynchronizableContentsCollection

_getMapping, configureDataSource, configureSearchModel, getLocalAndExternalFields, getRemoteValues, putIdParameter, search

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

_addEditInputsForSCC, _fillContent, _getContentsToRemove, _getEditInputs, _getEditInputsContextParameters, _handleContent, _importOrSynchronizeContent, _importOrSynchronizeContent, _importOrSynchronizeContents, _importOrSynchronizeContents, _internalPopulate, _isHandled, _synchronizeContent, _transformRemoteValues, configure, createContentAction, getAdditionalAttributeValues, getContent, getNotSynchronizedRelatedContentIds, getTotalCount, getTransformedRemoteValues, importContent, synchronizeContent, 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, _transformRemoteValuesCardinality, configureStaticParams, getCompatibleSCC, getContentPrefix, getContentType, getId, getInitialActionId, getLabel, getParameterValues, getReportMails, getRestrictedField, getSearchModelConfiguration, getSynchronizeActionId, getSynchronizeCollectionModelId, getSynchronizingContentOperator, getValidateActionId, getWorkflowName, ignoreRestrictions, 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, handleRightAssignmentContext

Field Details

PARAM_DATASOURCE_ID

public static final String PARAM_DATASOURCE_ID

Name of parameter holding the data source id

See Also:

• Constant Field Values

_apogeeStatistiquesDAO

protected ApogeeStatistiquesDAO _apogeeStatistiquesDAO

The DAO for remote DB Apogee

_apogeeSCCHelper

protected ApogeeSynchronizableContentsCollectionHelper _apogeeSCCHelper

The Apogée SCC helper

_cdmfrHandler

protected CDMFRHandler _cdmfrHandler

The CDM-fr handler

Constructor Details

StatistiquesBacGeneralSynchronizableContentsCollection

public StatistiquesBacGeneralSynchronizableContentsCollection()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSimpleSynchronizableContentsCollection

Throws:

ServiceException

getDataSourceId

protected String getDataSourceId()

Get the id of data source

Returns:

The id of data source

getIdField

public String getIdField()

Description copied from interface: SynchronizableContentsCollection

Get the path of metadata holding the unique identifier

Returns:

the path to the metadata. Can be null.

checkCollection

public boolean checkCollection()

Description copied from interface: SynchronizableContentsCollection

When returns true, the process check the collection of contents to synchronize, can be a list of collections and not only the current one.

Specified by:

checkCollection in interface SynchronizableContentsCollection

Overrides:

checkCollection in class AbstractStaticSynchronizableContentsCollection

Returns:

true to check the collection on synchronization

removalSync

public boolean removalSync()

Description copied from interface: SynchronizableContentsCollection

When returns true, a content created by a previous synchro will be removed if it does not exist anymore during the current synchro.

Specified by:

removalSync in interface SynchronizableContentsCollection

Overrides:

removalSync in class AbstractStaticSynchronizableContentsCollection

Returns:

true if a content created by a previous synchro has to be removed if it does not exist anymore during the current synchro.

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

updateSyncInformations

public void updateSyncInformations(ModifiableContent content,
 String syncCode,
 org.slf4j.Logger logger)
                            throws Exception

Description copied from interface: SynchronizableContentsCollection

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

Specified by:

updateSyncInformations in interface SynchronizableContentsCollection

Overrides:

updateSyncInformations in class AbstractSimpleSynchronizableContentsCollection

Parameters:

content - Content to update

syncCode - New synchronization code

logger - The logger

Throws:

Exception - if an error occurs.

_importContent

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

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Import a content from remote values.

Overrides:

_importContent in class AbstractSimpleSynchronizableContentsCollection

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.

populate

public List<ModifiableContent> populate(org.slf4j.Logger logger,
 ContainerProgressionTracker progressionTracker)

Description copied from interface: SynchronizableContentsCollection

Populates contents

Specified by:

populate in interface SynchronizableContentsCollection

Overrides:

populate in class AbstractSimpleSynchronizableContentsCollection

Parameters:

logger - The logger

progressionTracker - A progression tracker

Returns:

Return the populated contents (imported or synchronized)

_startHandleCDMFR

protected void _startHandleCDMFR()

Start handle CDM-fr treatments

_endHandleCDMFR

protected void _endHandleCDMFR(Set<String> contentIds)

End handle CDM-fr treatments

Parameters:

contentIds - the updated contents ids

internalSearch

protected Map<String,Map<String,Object>> internalSearch(Map<String,Object> initialSearchParameters,
 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:

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

_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

_editContent

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

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Synchronize the content with given values.

Overrides:

_editContent in class AbstractSimpleSynchronizableContentsCollection

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

ensureTitleIsPresent

protected void ensureTitleIsPresent(Content content,
 Map<String,List<Object>> remoteValues,
 org.slf4j.Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Ensure that the title is present and set it to the current title if it is not present.

Overrides:

ensureTitleIsPresent in class AbstractSimpleSynchronizableContentsCollection

Parameters:

content - The content to synchronize

remoteValues - The remote values that would contain the title (to check)

logger - The logger to warn if the title is not present