org.ametys.plugins.contentio.synchronize

Class AbstractSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, Configurable, Serviceable

Direct Known Subclasses:

AbstractDataSourceSynchronizableContentsCollection, UserPopulationSynchronizableContentsCollection

public abstract class AbstractSynchronizableContentsCollection
extends Object
implements SynchronizableContentsCollection, Configurable, Serviceable

Abstract implementation of SynchronizableContentsCollection.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentDAO	_contentDAO The content DAO
protected String	_contentPrefix The prefix of the contents
protected String	_contentType The handled content type
protected ContentTypeExtensionPoint	_contentTypeEP The content type extension point
protected ContentTypesHelper	_contentTypesHelper The helper for content types
protected CurrentUserProvider	_currentUserProvider The current user provider
private List<String>	_handledContents
protected boolean	_hasGlobalError True if there is a global error during synchronization
protected I18nUtils	_i18nUtils The i18n utils
protected String	_id The id
protected int	_initialActionId The id of the initial action of the workflow
protected I18nizableText	_label The label
protected LanguagesManager	_languagesManager The languges manager
protected String	_modelId The id of controller
protected Map<String,Object>	_modelParamValues The untyped values of controller's parameters
private int	_nbCreatedContents
private int	_nbDeletedContents
protected int	_nbError Number of errors encountered
private int	_nbNotChangedContents
private int	_nbSynchronizedContents
protected ObservationManager	_observationManager The observation manager
protected boolean	_removalSync True if removal sync
protected String	_reportMails The report mails
protected AmetysObjectResolver	_resolver The ametys object resolver
protected String	_restrictedField The path to the metadata holding the 'restricted' property
protected String	_synchronizingContentOperator The id of the content operator to use
protected SynchronizingContentOperatorExtensionPoint	_synchronizingContentOperatorEP The extension point for Synchronizing Content Operators
protected int	_validateActionId The id of the validate action of the workflow
protected boolean	_validateAfterImport True to validate contents after import
protected String	_workflowName The name of the workflow
protected WorkflowProvider	_workflowProvider The workflow provider

Fields inherited from interface org.ametys.plugins.contentio.synchronize.SynchronizableContentsCollection

COLLECTION_ID_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AbstractSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method and Description
private void	_ensureTitleIsPresent(Content content, Map<String,List<Object>> remoteValues, Logger logger)
protected ModifiableDefaultContent	_getContent(String lang, String idValue) Gets the content in the repository
protected String	_getContentName(String title, String lang) Gets the content name
private String	_getContentPathQuery(String lang, String idValue, String contentType)
protected String	_getIdFieldValue(DefaultContent content) Get the value of metadata holding the unique identifier of the synchronized content
private ModifiableCompositeMetadata	_getMetadataHolder(ModifiableCompositeMetadata parentMetadata, String metadataPath)
protected void	_handleContent(String id) Adds the given content as handled (i.e.
protected abstract void	_internalPopulate(Logger logger) Internal implementation of populate(Logger)
protected boolean	_isHandled(String id) Returns true if the given content is handled
protected Map<String,Object>	_parseParameters(Configuration configuration) Parse parameters' values
private boolean	_removeMetadataIfExists(ModifiableCompositeMetadata metadataHolder, String metadataName, boolean synchronize)
private boolean	_setMetadata(ModifiableCompositeMetadata metadataHolder, String metadataName, Object valueToSet, boolean synchronize, boolean forceExternalStatus)
protected boolean	applyChanges(ModifiableDefaultContent content, Logger logger) Does workflow action
void	configure(Configuration configuration)
protected String	createContentAction(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
String	getContentPrefix() Get the prefix to use for the creation of contents
String	getContentType() Get the type of content handled by this collection
String	getId() Get the id of synchronizable collection.
int	getInitialActionId() Get the id of the initial action of the workflow
I18nizableText	getLabel() Get the label of synchronizable collection
Map<String,Object>	getParameterValues() Get the untyped values of parameters for controller
String	getReportMails() If an exception occurs during synchronization, an error report mail will be sent to those email addresses (separated by new lines)
String	getRestrictedField() Get the path of boolean metadata for restricted content.
String	getSynchronizeCollectionModelId() Get the id of controller responsible of synchronization of this collection
String	getSynchronizingContentOperator() Gets the id of the SynchronizingContentOperator extension to use during synchronization
int	getValidateActionId() Get the id of the validate action of the workflow
String	getWorkflowName() Get the name of the workflow to use for the synchronized contents
protected void	importContent(String idValue, Map<String,List<Object>> remoteValues, Logger logger) Imports or synchronizes a content for each available language
protected void	importContent(String lang, String idValue, Map<String,List<Object>> remoteValues, Logger logger) Imports or synchronizes a content for given language
void	populate(Logger logger) 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.
protected void	sendErrorMail(int nbError) Sends the report mails
void	service(ServiceManager manager)
protected boolean	synchronizeContent(Map<String,List<Object>> remoteValues, ContentType contentType, ModifiableDefaultContent content, boolean create, Logger logger) Synchronizes content
protected void	updateSCCProperty(DefaultContent content) Add the current synchronizable collection as property
boolean	validateAfterImport() True to validate the contents after import
protected void	validateContent(WorkflowAwareContent content, Logger logger) Validates a content after import

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

getExternalOnlyFields, getIdField, getLocalAndExternalFields

Field Detail

_id

protected String _id

The id

_label

protected I18nizableText _label

The label

_restrictedField

protected String _restrictedField

The path to the metadata holding the 'restricted' property

_contentType

protected String _contentType

The handled content type

_modelId

protected String _modelId

The id of controller

_modelParamValues

protected Map<String,Object> _modelParamValues

The untyped values of controller's parameters

_removalSync

protected boolean _removalSync

True if removal sync

_workflowName

protected String _workflowName

The name of the workflow

_initialActionId

protected int _initialActionId

The id of the initial action of the workflow

_validateActionId

protected int _validateActionId

The id of the validate action of the workflow

_contentPrefix

protected String _contentPrefix

The prefix of the contents

_validateAfterImport

protected boolean _validateAfterImport

True to validate contents after import

_reportMails

protected String _reportMails

The report mails

_synchronizingContentOperator

protected String _synchronizingContentOperator

The id of the content operator to use

_languagesManager

protected LanguagesManager _languagesManager

The languges manager

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

The content type extension point

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The helper for content types

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_observationManager

protected ObservationManager _observationManager

The observation manager

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_synchronizingContentOperatorEP

protected SynchronizingContentOperatorExtensionPoint _synchronizingContentOperatorEP

The extension point for Synchronizing Content Operators

_contentDAO

protected ContentDAO _contentDAO

The content DAO

_nbError

protected int _nbError

Number of errors encountered

_hasGlobalError

protected boolean _hasGlobalError

True if there is a global error during synchronization

_handledContents

private List<String> _handledContents

_nbCreatedContents

private int _nbCreatedContents

_nbSynchronizedContents

private int _nbSynchronizedContents

_nbNotChangedContents

private int _nbNotChangedContents

_nbDeletedContents

private int _nbDeletedContents

Constructor Detail

AbstractSynchronizableContentsCollection

public AbstractSynchronizableContentsCollection()

Method Detail

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

_parseParameters

protected Map<String,Object> _parseParameters(Configuration configuration)
                                       throws ConfigurationException

Parse parameters' values

Parameters:

configuration - The root configuration

Returns:

The parameters

Throws:

ConfigurationException - if an error occurred

getId

public String getId()

Description copied from interface: SynchronizableContentsCollection

Get the id of synchronizable collection.

Specified by:

getId in interface SynchronizableContentsCollection

Returns:

the id

getLabel

public I18nizableText getLabel()

Description copied from interface: SynchronizableContentsCollection

Get the label of synchronizable collection

Specified by:

getLabel in interface SynchronizableContentsCollection

Returns:

the label

getContentType

public String getContentType()

Description copied from interface: SynchronizableContentsCollection

Get the type of content handled by this collection

Specified by:

getContentType in interface SynchronizableContentsCollection

Returns:

the type of content

getRestrictedField

public String getRestrictedField()

Description copied from interface: SynchronizableContentsCollection

Get the path of boolean metadata for restricted content. If true, the content will be visible only for connected users.

Specified by:

getRestrictedField in interface SynchronizableContentsCollection

Returns:

the path to the metadata. Can be null.

getSynchronizeCollectionModelId

public String getSynchronizeCollectionModelId()

Description copied from interface: SynchronizableContentsCollection

Get the id of controller responsible of synchronization of this collection

Specified by:

getSynchronizeCollectionModelId in interface SynchronizableContentsCollection

Returns:

The id of controller

getParameterValues

public Map<String,Object> getParameterValues()

Description copied from interface: SynchronizableContentsCollection

Get the untyped values of parameters for controller

Specified by:

getParameterValues in interface SynchronizableContentsCollection

Returns:

the untyped values

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

Returns:

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

getWorkflowName

public String getWorkflowName()

Description copied from interface: SynchronizableContentsCollection

Get the name of the workflow to use for the synchronized contents

Specified by:

getWorkflowName in interface SynchronizableContentsCollection

Returns:

the name of the workflow to use for the synchronized contents

getInitialActionId

public int getInitialActionId()

Description copied from interface: SynchronizableContentsCollection

Get the id of the initial action of the workflow

Specified by:

getInitialActionId in interface SynchronizableContentsCollection

Returns:

The id of the initial action of the workflow

getValidateActionId

public int getValidateActionId()

Description copied from interface: SynchronizableContentsCollection

Get the id of the validate action of the workflow

Specified by:

getValidateActionId in interface SynchronizableContentsCollection

Returns:

The id of the validate action of the workflow

getContentPrefix

public String getContentPrefix()

Description copied from interface: SynchronizableContentsCollection

Get the prefix to use for the creation of contents

Specified by:

getContentPrefix in interface SynchronizableContentsCollection

Returns:

The prefix to use for the creation of contents

validateAfterImport

public boolean validateAfterImport()

Description copied from interface: SynchronizableContentsCollection

True to validate the contents after import

Specified by:

validateAfterImport in interface SynchronizableContentsCollection

Returns:

True to validate the contents after import

getReportMails

public String getReportMails()

Description copied from interface: SynchronizableContentsCollection

If an exception occurs during synchronization, an error report mail will be sent to those email addresses (separated by new lines)

Specified by:

getReportMails in interface SynchronizableContentsCollection

Returns:

The email addresses to send an error report if an exception occurs during synchronization (separated by new lines)

getSynchronizingContentOperator

public String getSynchronizingContentOperator()

Description copied from interface: SynchronizableContentsCollection

Gets the id of the SynchronizingContentOperator extension to use during synchronization

Specified by:

getSynchronizingContentOperator in interface SynchronizableContentsCollection

Returns:

the id of the SynchronizingContentOperator extension to use during synchronization

populate

public void populate(Logger logger)

Description copied from interface: SynchronizableContentsCollection

Populates contents

Specified by:

populate in interface SynchronizableContentsCollection

Parameters:

logger - The logger

sendErrorMail

protected void sendErrorMail(int nbError)
                      throws javax.mail.MessagingException

Sends the report mails

Parameters:

nbError - The number of error

Throws:

javax.mail.MessagingException - if a messaging error occurred

_internalPopulate

protected abstract void _internalPopulate(Logger logger)

Internal implementation of populate(Logger)

Parameters:

logger - The logger

_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

importContent

protected void importContent(String idValue,
                             Map<String,List<Object>> remoteValues,
                             Logger logger)

Imports or synchronizes a content for each available language

Parameters:

idValue - The unique identifier of the content

remoteValues - The remote values

logger - The logger

importContent

protected void importContent(String lang,
                             String idValue,
                             Map<String,List<Object>> remoteValues,
                             Logger logger)

Imports or synchronizes a content for given language

Parameters:

lang - The language

idValue - The title of the content

remoteValues - The remote values

logger - The logger

_ensureTitleIsPresent

private void _ensureTitleIsPresent(Content content,
                                   Map<String,List<Object>> remoteValues,
                                   Logger logger)

updateSCCProperty

protected void updateSCCProperty(DefaultContent content)
                          throws RepositoryException

Add the current synchronizable collection as property

Parameters:

content - The synchronized content

Throws:

RepositoryException - if an error occurred

_getContent

protected ModifiableDefaultContent _getContent(String lang,
                                               String idValue)

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

_getContentPathQuery

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

createContentAction

protected String 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 occured

_getContentName

protected String _getContentName(String title,
                                 String lang)

Gets the content name

Parameters:

title - The name

lang - The lang of the content

Returns:

The content name

synchronizeContent

protected boolean synchronizeContent(Map<String,List<Object>> remoteValues,
                                     ContentType contentType,
                                     ModifiableDefaultContent content,
                                     boolean create,
                                     Logger logger)

Synchronizes content

Parameters:

remoteValues - The remote values

contentType - The content type

content - The content to synchronize

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

logger - The logger

Returns:

true if changes were made

_removeMetadataIfExists

private boolean _removeMetadataIfExists(ModifiableCompositeMetadata metadataHolder,
                                        String metadataName,
                                        boolean synchronize)

_getMetadataHolder

private ModifiableCompositeMetadata _getMetadataHolder(ModifiableCompositeMetadata parentMetadata,
                                                       String metadataPath)

_setMetadata

private boolean _setMetadata(ModifiableCompositeMetadata metadataHolder,
                             String metadataName,
                             Object valueToSet,
                             boolean synchronize,
                             boolean forceExternalStatus)

validateContent

protected void validateContent(WorkflowAwareContent content,
                               Logger logger)

Validates a content after import

Parameters:

content - The content to validate

logger - The logger

applyChanges

protected boolean applyChanges(ModifiableDefaultContent content,
                               Logger logger)
                        throws RepositoryException

Does workflow action

Parameters:

content - The synchronized content

logger - The logger

Returns:

true if the content is considered as synchronized (the apply succeeded), false otherwise.

Throws:

RepositoryException - if an error occurs when trying to rollback pending changes in the repository.

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

_getIdFieldValue

protected String _getIdFieldValue(DefaultContent content)

Get the value of metadata holding the unique identifier of the synchronized content

Parameters:

content - The content

Returns:

The value