Package org.ametys.plugins.contentio.synchronize

Class AbstractSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, Configurable, Serviceable

Direct Known Subclasses:

AbstractCDMFrSynchronizableContentsCollection, AbstractSimpleSynchronizableContentsCollection

public abstract class AbstractSynchronizableContentsCollection
extends AbstractStaticSynchronizableContentsCollection

Abstract implementation of SynchronizableContentsCollection.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentWorkflowHelper	_contentWorkflowHelper	The content workflow helper
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected boolean	_hasGlobalError	True if there is a global error during synchronization
protected I18nUtils	_i18nUtils	The i18n utils
protected int	_nbCreatedContents	Number of created contents
protected int	_nbDeletedContents	Number of deleted contents
protected int	_nbError	Number of errors encountered
protected int	_nbNotChangedContents	Number of unchanged contents
protected int	_nbSynchronizedContents	Number of synchronized contents
protected ObservationManager	_observationManager	The observation manager
protected static final String	SCC_UNIQUE_ID	SCC unique ID field

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

Method Summary

Modifier and Type	Method	Description
protected int	_deleteContents(List<Content> contentsToRemove, Logger logger)	Delete contents.
protected Map<String,Object>	_getAdditionalInputsForContentCreation()	Retrieves additional inputs for content creation
protected String	_getContentPathQuery(String lang, String idValue, String contentType)	Construct the query to retrieve the content.
protected abstract List<Content>	_getContentsToRemove(AmetysObjectIterable<ModifiableContent> contents)	Filter the contents to remove.
protected List<Expression>	_getExpressionsList(String lang, String idValue, String contentType)	Construct the query to retrieve the content.
protected boolean	_hasSomethingChanged()	Checks if some content have changed during the synchronization
protected List<ModifiableContent>	_internalPopulate(Logger logger)	Internal implementation of populate(Logger, ContainerProgressionTracker)
protected abstract List<ModifiableContent>	_internalPopulate(Logger logger, ContainerProgressionTracker progressionTracker)	Internal implementation of populate(Logger, ContainerProgressionTracker)
protected boolean	_isParamNotEmpty(Object parameterValue)	Check if the parameter value is empty
protected void	_logSynchronizationResult(Logger logger)	Logs the result of the synchronization, containing The number of created contents The number of synchronized contents The number of unchanged contents The number of deleted contents
protected Map<String,Object>	_removeEmptyParameters(Map<String,Object> searchParameters)	Remove empty parameters to the map
protected ModifiableContent	createContentAction(String contentType, String workflowName, int initialActionId, String lang, String contentTitle, Logger logger)	Creates content action with result from request
protected void	deleteUnexistingContents(Logger logger)	Delete contents created by a previous synchronization which does not exist anymore in remote source
void	empty(Logger logger)	Empty the collection of its synchronized contents
Map<String,Integer>	getSynchronizationResult()	Retrieves the result of the synchronization as a map of key / content count containing The number of created contents The number of synchronized contents The number of unchanged contents The number of deleted contents
List<ModifiableContent>	populate(Logger logger, ContainerProgressionTracker progressionTracker)	Populates contents
protected void	sendErrorMail(int nbError)	Sends the report mails
void	service(ServiceManager manager)
protected void	validateContent(WorkflowAwareContent content, int validationActionId, Logger logger)	Validates a content after import

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

_parseLanguages, _parseParameters, _transformRemoteValuesCardinality, configure, 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, getContent, getIdField, getLocalAndExternalFields, getTotalCount, handleRightAssignmentContext, importContent, search, synchronizeContent, updateSyncInformations

Field Details

SCC_UNIQUE_ID

protected static final String SCC_UNIQUE_ID

SCC unique ID field

See Also:

• Constant Field Values

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_observationManager

protected ObservationManager _observationManager

The observation manager

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The content workflow helper

_nbError

protected int _nbError

Number of errors encountered

_hasGlobalError

protected boolean _hasGlobalError

True if there is a global error during synchronization

_nbCreatedContents

protected int _nbCreatedContents

Number of created contents

_nbSynchronizedContents

protected int _nbSynchronizedContents

Number of synchronized contents

_nbNotChangedContents

protected int _nbNotChangedContents

Number of unchanged contents

_nbDeletedContents

protected int _nbDeletedContents

Number of deleted contents

Constructor Details

AbstractSynchronizableContentsCollection

public AbstractSynchronizableContentsCollection()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractStaticSynchronizableContentsCollection

Throws:

ServiceException

populate

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

Description copied from interface: SynchronizableContentsCollection

Populates contents

Parameters:

logger - The logger

progressionTracker - A progression tracker

Returns:

Return the populated contents (imported or synchronized)

_internalPopulate

protected List<ModifiableContent> _internalPopulate(Logger logger)

Internal implementation of populate(Logger, ContainerProgressionTracker)

Parameters:

logger - The logger

Returns:

The list of created/synchronized contents

_internalPopulate

protected abstract List<ModifiableContent> _internalPopulate(Logger logger,
 ContainerProgressionTracker progressionTracker)

Internal implementation of populate(Logger, ContainerProgressionTracker)

Parameters:

logger - The logger

progressionTracker - The progression tracker

Returns:

The list of created/synchronized contents

empty

public void empty(Logger logger)

Description copied from interface: SynchronizableContentsCollection

Empty the collection of its synchronized contents

Parameters:

logger - The logger

deleteUnexistingContents

protected void deleteUnexistingContents(Logger logger)

Delete contents created by a previous synchronization which does not exist anymore in remote source

Parameters:

logger - The logger

_getContentsToRemove

protected abstract List<Content> _getContentsToRemove(AmetysObjectIterable<ModifiableContent> contents)

Filter the contents to remove.

Parameters:

contents - The list of all the available contents

Returns:

The List of Content to remove.

_deleteContents

protected int _deleteContents(List<Content> contentsToRemove,
 Logger logger)

Delete contents.

Parameters:

contentsToRemove - List of contents to remove

logger - The logger

Returns:

the number of deleted contents

_logSynchronizationResult

protected void _logSynchronizationResult(Logger logger)

Logs the result of the synchronization, containing

• The number of created contents
• The number of synchronized contents
• The number of unchanged contents
• The number of deleted contents

Parameters:

logger - the logger

_hasSomethingChanged

protected boolean _hasSomethingChanged()

Checks if some content have changed during the synchronization

Returns:

true if some contents have changed, false otherwise

sendErrorMail

protected void sendErrorMail(int nbError)
                      throws jakarta.mail.MessagingException,
IOException

Sends the report mails

Parameters:

nbError - The number of error

Throws:

jakarta.mail.MessagingException - if a messaging error occurred

IOException - if an error occurred building the message

validateContent

protected void validateContent(WorkflowAwareContent content,
 int validationActionId,
 Logger logger)

Validates a content after import

Parameters:

content - The content to validate

validationActionId - Validation action ID to use for this content

logger - The logger

createContentAction

protected ModifiableContent createContentAction(String contentType,
 String workflowName,
 int initialActionId,
 String lang,
 String contentTitle,
 Logger logger)

Creates content action with result from request

Parameters:

contentType - Type of the content to create

workflowName - Workflow to use for this content

initialActionId - Action ID for initialization

lang - The language

contentTitle - The content title

logger - The logger

Returns:

The content id, or null of a workflow error occured

_getAdditionalInputsForContentCreation

protected Map<String,Object> _getAdditionalInputsForContentCreation()

Retrieves additional inputs for content creation

Returns:

the additional inputs for content creation

_getExpressionsList

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

Construct the query to retrieve the content.

Parameters:

lang - Lang

idValue - Synchronization value

contentType - Content type

Returns:

The List of Expression

_getContentPathQuery

protected String _getContentPathQuery(String lang,
 String idValue,
 String contentType)

Construct the query to retrieve the content.

Parameters:

lang - Lang

idValue - Synchronization value

contentType - Content type

Returns:

The XPATH query

_removeEmptyParameters

protected Map<String,Object> _removeEmptyParameters(Map<String,Object> searchParameters)

Remove empty parameters to the map

Parameters:

searchParameters - the parameters

Returns:

the map of none empty parameters

_isParamNotEmpty

protected boolean _isParamNotEmpty(Object parameterValue)

Check if the parameter value is empty

Parameters:

parameterValue - the parameter value

Returns:

true if the parameter value is empty

getSynchronizationResult

public Map<String,Integer> getSynchronizationResult()

Description copied from interface: SynchronizableContentsCollection

Retrieves the result of the synchronization as a map of key / content count containing

• The number of created contents
• The number of synchronized contents
• The number of unchanged contents
• The number of deleted contents

Returns:

the result of the synchronization