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

Class AbstractPreviousYearsSynchronizableContentsCollection

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

All Implemented Interfaces:

SynchronizableContentsCollection, Configurable, Serviceable

Direct Known Subclasses:

ContainerNbStudentsSynchronizableContentsCollection, CoursePartGroupsSynchronizableContentsCollection

public abstract class AbstractPreviousYearsSynchronizableContentsCollection
extends AbstractDefaultSynchronizableContentsCollection

SCC for previous years fields.

Field Summary

Fields

Modifier and Type	Field	Description
protected ApogeePreviousYearsFieldsDAO	_apogeePreviousYearsFieldsDAO	The DAO for remote DB Apogee
protected ApogeeSynchronizableContentsCollectionHelper	_apogeeSCCHelper	The Apogée SCC helper
protected CDMFRHandler	_cdmfrHandler	The CDM-fr handler
static final String	PARAM_CURRENT_YEAR	Name of parameter holding the administrative year
static final String	PARAM_DATASOURCE_ID	Name of parameter holding the data source id
static final String	PARAM_PRECEDING_YEAR	Name of parameter holding the last administrative year (N-1)

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, 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
AbstractPreviousYearsSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method	Description
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 title is present.
protected abstract List<Map<String,Object>>	executeApogeeRequest(Map<String,Object> parameters)	Execute the corresponding apogee request to retrieve the values from Apogee
protected Stream<Content>	getContents()	Retrieve the contents for which to retrieve the values
protected String	getCurrentYear()	Get the current administrative year
protected abstract String	getCurrentYearAttributeName()	Get the attribute name for current year data.
protected String	getDataSourceId()	Get the id of data source
protected String	getIdColumn()	Get the identifier column (can be a concatened column).
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 String	getPrecedingYear()	Get the previous administrative year (N-1)
protected abstract String	getPrecedingYearAttributeName()	Get the attribute name for preceding year data.
protected String	getSyncCode(Content content)	Get the sync code for a content
protected abstract String	getSyncCodeItemName()	Get the item name that contains the synchronization code, it can be an attribute or a property.
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
protected List<Map<String,Object>>	searchByYear(String year, String yearAttributeName, Map<String,Object> searchParameters)	Search the values for a year
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, getRemoteValues, putIdParameter, search

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

_addEditInputsForSCC, _editContent, _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, 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, 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

PARAM_CURRENT_YEAR

public static final String PARAM_CURRENT_YEAR

Name of parameter holding the administrative year

See Also:

• Constant Field Values

PARAM_PRECEDING_YEAR

public static final String PARAM_PRECEDING_YEAR

Name of parameter holding the last administrative year (N-1)

See Also:

• Constant Field Values

_apogeePreviousYearsFieldsDAO

protected ApogeePreviousYearsFieldsDAO _apogeePreviousYearsFieldsDAO

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

AbstractPreviousYearsSynchronizableContentsCollection

public AbstractPreviousYearsSynchronizableContentsCollection()

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

getCurrentYear

protected String getCurrentYear()

Get the current administrative year

Returns:

The current administrative year

getPrecedingYear

protected String getPrecedingYear()

Get the previous administrative year (N-1)

Returns:

The previous administrative year (N-1)

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

getIdColumn

protected String getIdColumn()

Get the identifier column (can be a concatened column).

Returns:

the column id

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

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

Overrides:

getLocalAndExternalFields in class AbstractDefaultSynchronizableContentsCollection

Parameters:

additionalParameters - Additional parameters

Returns:

the synchronized fields

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.

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

getCurrentYearAttributeName

protected abstract String getCurrentYearAttributeName()

Get the attribute name for current year data.

Returns:

the attribute name

getPrecedingYearAttributeName

protected abstract String getPrecedingYearAttributeName()

Get the attribute name for preceding year data.

Returns:

the attribute name

getContents

protected Stream<Content> getContents()

Retrieve the contents for which to retrieve the values

Returns:

The contents

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.

searchByYear

protected List<Map<String,Object>> searchByYear(String year,
 String yearAttributeName,
 Map<String,Object> searchParameters)

Search the values for a year

Parameters:

year - The year value

yearAttributeName - The year attribute name

searchParameters - The common search parameters

Returns:

The results

getSyncCode

protected String getSyncCode(Content content)

Get the sync code for a content

Parameters:

content - The content

Returns:

The sync code

getSyncCodeItemName

protected abstract String getSyncCodeItemName()

Get the item name that contains the synchronization code, it can be an attribute or a property.

Returns:

the synchronization code item name

executeApogeeRequest

protected abstract List<Map<String,Object>> executeApogeeRequest(Map<String,Object> parameters)

Execute the corresponding apogee request to retrieve the values from Apogee

Parameters:

parameters - The parameters of the request

Returns:

The results of the request

_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

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

ensureTitleIsPresent

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

Ensure title is 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