Package org.ametys.plugins.odfsync.cdmfr

Class AbstractCDMFrSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

org.ametys.plugins.odfsync.cdmfr.AbstractCDMFrSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, Configurable, Serviceable

Direct Known Subclasses:

CDMFrSynchronizableContentsCollection, RemoteCDMFrSynchronizableContentsCollection

public abstract class AbstractCDMFrSynchronizableContentsCollection
extends AbstractSynchronizableContentsCollection

Abstract class to import CDMFr contents

Field Summary

Fields

Modifier and Type	Field	Description
protected ImportCDMFrComponent	_importCDMFrComponent	The import CDMFr component

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, _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
AbstractCDMFrSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method	Description
protected List<Content>	_getContentsToRemove(AmetysObjectIterable<ModifiableContent> contents)	Filter the contents to remove.
protected List<ModifiableContent>	_internalPopulate(org.slf4j.Logger logger)	Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger)
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.
ModifiableContent	getContent(String lang, String idValue)	Gets the content in the repository
String	getIdField()	Get the path of metadata holding the unique identifier
Set<String>	getLocalAndExternalFields(Map<String,Object> additionalParameters)	Get the path of tri-state fields (with local and external values)
int	getTotalCount(Map<String,Object> searchParameters, org.slf4j.Logger logger)	Return the total number of results for the search.
Map<String,Map<String,Object>>	search(Map<String,Object> searchParameters, int offset, int limit, List<Object> sort, org.slf4j.Logger logger)	Search the data to import from parameters.
void	service(ServiceManager manager)
void	synchronizeContent(ModifiableContent content, org.slf4j.Logger logger)	Synchronize a content with remove values.
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.AbstractSynchronizableContentsCollection

_deleteContents, _getAdditionalInputsForContentCreation, _getContentPathQuery, _getExpressionsList, _hasSomethingChanged, _isParamNotEmpty, _logSynchronizationResult, _removeEmptyParameters, createContentAction, deleteUnexistingContents, empty, getSynchronizationResult, populate, sendErrorMail, validateContent

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

_parseLanguages, _parseParameters, _transformRemoteValuesCardinality, configure, 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

additionalImportOperations, additionalSynchronizeOperations, handleRightAssignmentContext, importContent

Field Detail

_importCDMFrComponent

protected ImportCDMFrComponent _importCDMFrComponent

The import CDMFr component

Constructor Detail

AbstractCDMFrSynchronizableContentsCollection

public AbstractCDMFrSynchronizableContentsCollection()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSynchronizableContentsCollection

Throws:

ServiceException

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.

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)

Parameters:

additionalParameters - Additional parameters

Returns:

the synchronized fields

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.

Parameters:

content - Content to update

additionalParameters - Additional parameters

logger - The logger

Returns:

The synchronization result of the additional operations

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

synchronizeContent

public void synchronizeContent(ModifiableContent content,
                               org.slf4j.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.

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

search

public Map<String,Map<String,Object>> search(Map<String,Object> searchParameters,
                                                         int offset,
                                                         int limit,
                                                         List<Object> sort,
                                                         org.slf4j.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

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

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,
                         org.slf4j.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

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

_internalPopulate

protected List<ModifiableContent> _internalPopulate(org.slf4j.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