org.ametys.plugins.odfsync.cdmfr

Class CDMFrSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

org.ametys.plugins.odfsync.cdmfr.CDMFrSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, Configurable, Contextualizable, Serviceable

public class CDMFrSynchronizableContentsCollection
extends AbstractSynchronizableContentsCollection
implements Contextualizable

Class for CDMFr import and synchronization

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	__PARAM_FOLDER Data source parameter : folder
protected File	_cdmfrFolder CDM-fr folder
protected Context	_cocoonContext The Cocoon context
private static String	_COLUMN_FILENAME
private static String	_COLUMN_LAST_MODIFIED
private static String	_COLUMN_LENGTH
private static String	_CRITERIA_FILENAME
private static String	_CRITERIA_LAST_MODIFIED_AFTER
private static String	_CRITERIA_LAST_MODIFIED_BEFORE
protected Set<String>	_extFields External fields
protected ImportCDMFrComponent	_importCDMFrComponent The CDM-fr SCC component
private static Map<String,Comparator<File>>	_NAME_TO_COMPARATOR
protected String	_odfLang Default language configured for ODF
protected Set<String>	_updatedContents List of synchronized contents (to avoid a treatment twice or more)

Fields inherited from class org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

_contentDAO, _contentTypeEP, _currentUserProvider, _hasGlobalError, _i18nUtils, _nbCreatedContents, _nbDeletedContents, _nbError, _nbNotChangedContents, _nbSynchronizedContents, _observationManager, _resolver, _synchroComponent, SCC_UNIQUE_ID

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

_contentPrefix, _contentType, _id, _initialActionId, _label, _modelId, _modelParamValues, _removalSync, _reportMails, _restrictedField, _searchModelConfiguration, _synchronizeExistingContentsOnly, _synchronizingContentOperator, _validateActionId, _validateAfterImport, _workflowName

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

COLLECTION_ID_PROPERTY

Constructor Summary

Constructors

Constructor and Description
CDMFrSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method and Description
protected List<Content>	_getContentsToRemove(AmetysObjectIterable<ModifiableDefaultContent> contents) Filter the contents to remove.
protected Map<String,Object>	_handleFile(File cdmfrFile, Map<String,Object> parameters, Logger logger) Handle the CDM-fr file to import all the programs and its dependencies containing into it.
protected List<ModifiableDefaultContent>	_internalPopulate(Logger logger) Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger)
private File[]	_sortFiles(File[] files, List<Object> sortList)
void	configure(Configuration configuration)
protected void	configureDataSource(Configuration configuration) Configure the data source parameters.
protected void	configureSearchModel() Configure the search model used by SCCSearchTool.
protected void	configureSpecificParameters() Configure the specific parameters of this implementation of CDM-fr import.
void	contextualize(Context context)
ModifiableDefaultContent	getContent(String lang, String idValue) Gets the content in the repository
Set<String>	getExternalOnlyFields(Map<String,Object> additionalParameters) Get the path of field that are valued externally only.
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> parameters, Logger logger) Return the total number of results for the search.
boolean	handleRightAssignmentContext() Return true if a RightAssignmentContext should be automatically generated for the contents of this SCC
List<ModifiableDefaultContent>	importContent(String idValue, Map<String,Object> additionalParameters, Logger logger) Import a content from remote values.
protected File[]	internalSearch(Map<String,Object> parameters, Logger logger) Search values and return the result without any treatment.
Map<String,Map<String,Object>>	search(Map<String,Object> parameters, int offset, int limit, List<Object> sort, Logger logger) Search the data to import from parameters.
void	service(ServiceManager manager)
void	synchronizeContent(ModifiableDefaultContent content, Logger logger) Synchronize a content with remove values.
void	updateSyncInformations(ModifiableDefaultContent content, String syncCode, 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

_getContentPathQuery, _getExpressionsList, _getMetadataHolder, _isParamNotEmpty, _removeEmptyParameters, _removeMetadataIfExists, _synchronizeMetadata, _updateRelation, _updateRelation, applyChanges, applyChanges, createContentAction, deleteUnexistingContents, populate, sendErrorMail, updateSCCProperty, validateContent

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

_parseParameters, configureStaticParams, getContentPrefix, getContentType, getId, getInitialActionId, getLabel, getParameterValues, getReportMails, getRestrictedField, getSearchModelConfiguration, 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

Field Detail

__PARAM_FOLDER

protected static final String __PARAM_FOLDER

Data source parameter : folder

See Also:

Constant Field Values

_CRITERIA_FILENAME

private static final String _CRITERIA_FILENAME

See Also:

Constant Field Values

_CRITERIA_LAST_MODIFIED_AFTER

private static final String _CRITERIA_LAST_MODIFIED_AFTER

See Also:

Constant Field Values

_CRITERIA_LAST_MODIFIED_BEFORE

private static final String _CRITERIA_LAST_MODIFIED_BEFORE

See Also:

Constant Field Values

_COLUMN_FILENAME

private static final String _COLUMN_FILENAME

See Also:

Constant Field Values

_COLUMN_LAST_MODIFIED

private static final String _COLUMN_LAST_MODIFIED

See Also:

Constant Field Values

_COLUMN_LENGTH

private static final String _COLUMN_LENGTH

See Also:

Constant Field Values

_NAME_TO_COMPARATOR

private static final Map<String,Comparator<File>> _NAME_TO_COMPARATOR

_cocoonContext

protected Context _cocoonContext

The Cocoon context

_cdmfrFolder

protected File _cdmfrFolder

CDM-fr folder

_odfLang

protected String _odfLang

Default language configured for ODF

_extFields

protected Set<String> _extFields

External fields

_updatedContents

protected Set<String> _updatedContents

List of synchronized contents (to avoid a treatment twice or more)

_importCDMFrComponent

protected ImportCDMFrComponent _importCDMFrComponent

The CDM-fr SCC component

Constructor Detail

CDMFrSynchronizableContentsCollection

public CDMFrSynchronizableContentsCollection()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractStaticSynchronizableContentsCollection

Throws:

ConfigurationException

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

Specified by:

getIdField in interface SynchronizableContentsCollection

Returns:

the path to the metadata. Can be null.

_internalPopulate

protected List<ModifiableDefaultContent> _internalPopulate(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

importContent

public List<ModifiableDefaultContent> importContent(String idValue,
                                                    Map<String,Object> additionalParameters,
                                                    Logger logger)
                                             throws Exception

Description copied from interface: SynchronizableContentsCollection

Import a content from remote values.

Specified by:

importContent in interface SynchronizableContentsCollection

Parameters:

idValue - Id (for import/synchronization) of the content to import

additionalParameters - Additional parameters

logger - The logger

Returns:

A list of created contents

Throws:

Exception - if an error occurs.

_handleFile

protected Map<String,Object> _handleFile(File cdmfrFile,
                                         Map<String,Object> parameters,
                                         Logger logger)

Handle the CDM-fr file to import all the programs and its dependencies containing into it.

Parameters:

cdmfrFile - The CDM-fr file

parameters - Parameters used to import the file

logger - The logger

Returns:

The list of imported/synchronized programs

search

public Map<String,Map<String,Object>> search(Map<String,Object> parameters,
                                             int offset,
                                             int limit,
                                             List<Object> sort,
                                             Logger logger)

Description copied from interface: SynchronizableContentsCollection

Search the data to import from parameters.

Specified by:

search in interface SynchronizableContentsCollection

Parameters:

parameters - 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

getTotalCount

public int getTotalCount(Map<String,Object> parameters,
                         Logger logger)

Description copied from interface: SynchronizableContentsCollection

Return the total number of results for the search.

Specified by:

getTotalCount in interface SynchronizableContentsCollection

Parameters:

parameters - Parameters for the search

logger - The logger

Returns:

The total count

_sortFiles

private File[] _sortFiles(File[] files,
                          List<Object> sortList)

internalSearch

protected File[] internalSearch(Map<String,Object> parameters,
                                Logger logger)

Search values and return the result without any treatment.

Parameters:

parameters - Search parameters to restrict the search

logger - The logger

Returns:

File tab listing the available CDM-fr files corresponding to the filter.

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

configureSpecificParameters

protected void configureSpecificParameters()

Configure the specific parameters of this implementation of CDM-fr import.

configureSearchModel

protected void configureSearchModel()

Description copied from class: AbstractStaticSynchronizableContentsCollection

Configure the search model used by SCCSearchTool.

Specified by:

configureSearchModel in class AbstractStaticSynchronizableContentsCollection

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

Parameters:

additionalParameters - Additional parameters

Returns:

the synchronized fields

getExternalOnlyFields

public Set<String> getExternalOnlyFields(Map<String,Object> additionalParameters)

Description copied from interface: SynchronizableContentsCollection

Get the path of field that are valued externally only.

Specified by:

getExternalOnlyFields in interface SynchronizableContentsCollection

Parameters:

additionalParameters - Additional parameters

Returns:

the external fields

updateSyncInformations

public void updateSyncInformations(ModifiableDefaultContent content,
                                   String syncCode,
                                   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

Parameters:

content - Content to update

syncCode - New synchronization code

logger - The logger

Throws:

Exception - if an error occurs.

synchronizeContent

public void synchronizeContent(ModifiableDefaultContent content,
                               Logger logger)
                        throws Exception

Description copied from interface: SynchronizableContentsCollection

Synchronize a content with remove values.

Specified by:

synchronizeContent in interface SynchronizableContentsCollection

Parameters:

content - The content to synchronize

logger - The logger

Throws:

Exception - if an error occurs.

getContent

public ModifiableDefaultContent getContent(String lang,
                                           String idValue)

Description copied from interface: SynchronizableContentsCollection

Gets the content in the repository

Specified by:

getContent in interface SynchronizableContentsCollection

Parameters:

lang - the language

idValue - the content name

Returns:

the content in the repository, or null if does not exist

handleRightAssignmentContext

public boolean handleRightAssignmentContext()

Description copied from interface: SynchronizableContentsCollection

Return true if a RightAssignmentContext should be automatically generated for the contents of this SCC

Specified by:

handleRightAssignmentContext in interface SynchronizableContentsCollection

Returns:

true to automatically generate a RightAssignmentContext. Return false if the rights of contents of this SCC are handle by its own RightAssignmentContext

_getContentsToRemove

protected List<Content> _getContentsToRemove(AmetysObjectIterable<ModifiableDefaultContent> 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.