Package org.ametys.plugins.odfsync.cdmfr.components

Class AbstractImportCDMFrComponent

java.lang.Object

org.ametys.plugins.odfsync.cdmfr.components.AbstractImportCDMFrComponent

All Implemented Interfaces:

ImportCDMFrComponent, Initializable, Component, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

RemoteImportCDMFrComponent, SCCImportCDMFrComponent

public abstract class AbstractImportCDMFrComponent
extends Object
implements ImportCDMFrComponent, Serviceable, Initializable, Contextualizable, Configurable, Component

Abstract class of a component to import a CDM-fr input stream.

Field Summary

Fields

Modifier and Type	Field	Description
protected CatalogsManager	_catalogsManager	The catalog manager
protected CDMFrSyncExtensionPoint	_cdmFrSyncExtensionPoint	Extension point to transform CDM-fr
protected Context	_cocoonContext	The Cocoon context
protected String	_contentPrefix	The prefix of the contents
protected ContentTypeExtensionPoint	_contentTypeEP	The content type extension point
protected ContentWorkflowHelper	_contentWorkflowHelper	The content workflow helper
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected DOMParser	_domParser	The DOM parser
protected Map<String,Integer>	_importedContents	List of imported contents
protected int	_nbError	Number of errors encountered
protected ObservationManager	_observationManager	The observation manager
protected ODFHelper	_odfHelper	The ODF Helper
protected String	_odfLang	Default language configured for ODF
protected OdfReferenceTableHelper	_odfRefTableHelper	The ODF TableRef Helper
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected RootOrgUnitProvider	_rootOUProvider	The root orgunit provider
protected SynchronizableContentsCollectionHelper	_sccHelper	The SCC helper
protected ShareableCourseHelper	_shareableCourseHelper	The shareable course helper
protected Map<String,Set<String>>	_syncFieldsByContentType	Synchronized fields by content type
protected static int	_SYNCHRONIZE_WORKFLOW_ACTION_ID	The synchronize workflow action id
protected Set<String>	_synchronizedContents	List of synchronized contents
protected static String	_TAG_CONTAINER	Tag to identify a container
protected static String	_TAG_COURSELIST	Tag to identify a courseList
protected static String	_TAG_COURSEPART	Tag to identify a coursePart
protected static String	_TAG_PROGRAM	Tag to identify a program
protected static String	_TAG_SUBPROGRAM	Tag to identify a subprogram
protected ImportCDMFrValuesExtractorFactory	_valuesExtractorFactory	the ImportCDMFrValuesExtractor factory
protected XPathProcessor	_xPathProcessor	The XPath processor

Fields inherited from interface org.ametys.plugins.odfsync.cdmfr.components.ImportCDMFrComponent

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractImportCDMFrComponent()

Method Summary

Modifier and Type	Method	Description
protected ModifiableContent	_createContent(ContentWorkflowDescription wfDescription, String title, ImportCDMFrContext context)	Create the content from the workflow description and the import context.
protected void	_editContent(WorkflowAwareContent content, Optional<View> view, Map<String,Object> values, boolean create, Set<String> notSynchronizedContentIds, ImportCDMFrContext context)	Synchronize the content with given values.
protected Map<String,Object>	_getAdditionalValuesToSynchronize(ModifiableContent content, String syncCode, ImportCDMFrContext context)	Retrieves additional values to synchronize for the content
protected List<Expression>	_getExpressionsList(String contentTypeId, String syncCode, ImportCDMFrContext context)	Construct the query to retrieve the content.
protected Map<String,Object>	_getInputsForContentCreation(ContentWorkflowDescription wfDescription, ImportCDMFrContext context)	Retrieves the inputs to give for content creation
protected Set<String>	_getNotSynchronizedRelatedContentIds(ModifiableContent content, String syncCode, ImportCDMFrContext context)	Retrieves the ids of the contents related to the given content but that are not part of the synchronization
protected ModifiableContent	_getOrCreateContent(ContentWorkflowDescription wfDescription, String title, String syncCode, ImportCDMFrContext context)	Get or create the content from the workflow description, the synchronization code and the import context.
protected List<ModifiableContent>	_initializeShareableCoursesFields(ProgramItem programItem)	Initialize shareable fields for the courses under the given ProgramItem
protected void	_linkTranslationsIfExist(ModifiableContent importedContent, String contentType, ImportCDMFrContext context)	Search for translated contents
protected void	_setOrgUnitParent(WorkflowAwareContent orgUnit, ImportCDMFrContext context)	Set the orgUnit parent to rootOrgUnit.
protected void	_synchronizeContent(Element contentElement, ModifiableContent content, String contentTypeId, String syncCode, ImportCDMFrContext context)	Synchronize content
ContentSynchronizationResult	additionalOperations(ModifiableContent content, Map<String,Object> additionalParameters, org.slf4j.Logger logger)	Add specific fields to the content during import or synchronization.
protected abstract void	additionalParameters(Map<String,Object> parameters)	Additional parameters for specific treatments.
void	configure(Configuration configuration)
void	contextualize(Context context)
String	getCatalogName(Element contentElement)	Get the name of catalog to use for import
ModifiableContent	getContent(String contentType, String syncCode, ImportCDMFrContext context)	Get the content from the synchronization code, the content type and the context.
String	getIdField()	Return the attribute identifier for CDM-fr synchronization.
String	getIdFromCDMThenCode(String tableRefId, String cdmCode)	Get the content ID from the CDM code, if there is no match with the CDM code, then we search with the code.
Set<String>	getLocalAndExternalFields(Map<String,Object> additionalParameters)	Get the path of tri-state fields (with local and external values)
Map<String,Object>	handleInputStream(InputStream input, Map<String,Object> parameters, SynchronizableContentsCollection scc, org.slf4j.Logger logger)	Handle the CDM-fr input stream to import all the programs and its dependencies containing into it.
protected boolean	ignoreRights()	If true, bypass the rights check during the import process
ModifiableContent	importOrSynchronizeContent(Element contentElement, ContentWorkflowDescription wfDescription, String title, String syncCode, ImportCDMFrContext context)	Import or synchronize the content.
void	initialize()
protected abstract 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.
void	service(ServiceManager manager)
protected Document	transformDocument(Document document, Map<String,Object> parameters, org.slf4j.Logger logger)	Transform the document depending of it structure.
protected abstract boolean	validateAfterImport()	True to validate the contents after import
protected void	validateContent(WorkflowAwareContent content, int validationActionId, org.slf4j.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

Field Detail

_TAG_PROGRAM

protected static final String _TAG_PROGRAM

Tag to identify a program

See Also:

Constant Field Values

_TAG_SUBPROGRAM

protected static final String _TAG_SUBPROGRAM

Tag to identify a subprogram

See Also:

Constant Field Values

_TAG_CONTAINER

protected static final String _TAG_CONTAINER

Tag to identify a container

See Also:

Constant Field Values

_TAG_COURSELIST

protected static final String _TAG_COURSELIST

Tag to identify a courseList

See Also:

Constant Field Values

_TAG_COURSEPART

protected static final String _TAG_COURSEPART

Tag to identify a coursePart

See Also:

Constant Field Values

_SYNCHRONIZE_WORKFLOW_ACTION_ID

protected static final int _SYNCHRONIZE_WORKFLOW_ACTION_ID

The synchronize workflow action id

See Also:

Constant Field Values

_cocoonContext

protected Context _cocoonContext

The Cocoon context

_domParser

protected DOMParser _domParser

The DOM parser

_xPathProcessor

protected XPathProcessor _xPathProcessor

The XPath processor

_cdmFrSyncExtensionPoint

protected CDMFrSyncExtensionPoint _cdmFrSyncExtensionPoint

Extension point to transform CDM-fr

_odfLang

protected String _odfLang

Default language configured for ODF

_catalogsManager

protected CatalogsManager _catalogsManager

The catalog manager

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_odfRefTableHelper

protected OdfReferenceTableHelper _odfRefTableHelper

The ODF TableRef Helper

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

The content type extension point

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_observationManager

protected ObservationManager _observationManager

The observation manager

_rootOUProvider

protected RootOrgUnitProvider _rootOUProvider

The root orgunit provider

_odfHelper

protected ODFHelper _odfHelper

The ODF Helper

_sccHelper

protected SynchronizableContentsCollectionHelper _sccHelper

The SCC helper

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The content workflow helper

_shareableCourseHelper

protected ShareableCourseHelper _shareableCourseHelper

The shareable course helper

_valuesExtractorFactory

protected ImportCDMFrValuesExtractorFactory _valuesExtractorFactory

the ImportCDMFrValuesExtractor factory

_importedContents

protected Map<String,Integer> _importedContents

List of imported contents

_synchronizedContents

protected Set<String> _synchronizedContents

List of synchronized contents

_nbError

protected int _nbError

Number of errors encountered

_contentPrefix

protected String _contentPrefix

The prefix of the contents

_syncFieldsByContentType

protected Map<String,Set<String>> _syncFieldsByContentType

Synchronized fields by content type

Constructor Detail

AbstractImportCDMFrComponent

public AbstractImportCDMFrComponent()

Method Detail

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

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

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getIdField

public String getIdField()

Description copied from interface: ImportCDMFrComponent

Return the attribute identifier for CDM-fr synchronization.

Specified by:

getIdField in interface ImportCDMFrComponent

Returns:

The attribute name (cdmfrSyncCode)

handleInputStream

public Map<String,Object> handleInputStream(InputStream input,
                                                  Map<String,Object> parameters,
                                                  SynchronizableContentsCollection scc,
                                                  org.slf4j.Logger logger)
                                           throws ProcessingException

Description copied from interface: ImportCDMFrComponent

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

Specified by:

handleInputStream in interface ImportCDMFrComponent

Parameters:

input - The CDM-fr input stream

parameters - The parameters useful for the operation

scc - The SynchronizableContentsCollection calling this component

logger - The logger

Returns:

The list of imported/synchronized programs

Throws:

ProcessingException - If an error occurs

validateAfterImport

protected abstract boolean validateAfterImport()

True to validate the contents after import

Returns:

True to validate the contents after import

removalSync

protected abstract 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.

Returns:

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

additionalParameters

protected abstract void additionalParameters(Map<String,Object> parameters)

Additional parameters for specific treatments.

Parameters:

parameters - The parameters map to get

transformDocument

protected Document transformDocument(Document document,
                                     Map<String,Object> parameters,
                                     org.slf4j.Logger logger)
                              throws IOException,
                                     SAXException,
                                     ProcessingException

Transform the document depending of it structure.

Parameters:

document - Document to transform.

parameters - Optional parameters for transformation

logger - The logger

Returns:

The transformed document.

Throws:

IOException - if an error occurs.

SAXException - if an error occurs.

ProcessingException - if an error occurs.

getCatalogName

public String getCatalogName(Element contentElement)

Description copied from interface: ImportCDMFrComponent

Get the name of catalog to use for import

Specified by:

getCatalogName in interface ImportCDMFrComponent

Parameters:

contentElement - Element of the content

Returns:

The catalog to used

importOrSynchronizeContent

public ModifiableContent importOrSynchronizeContent(Element contentElement,
                                                    ContentWorkflowDescription wfDescription,
                                                    String title,
                                                    String syncCode,
                                                    ImportCDMFrContext context)

Description copied from interface: ImportCDMFrComponent

Import or synchronize the content.

Specified by:

importOrSynchronizeContent in interface ImportCDMFrComponent

Parameters:

contentElement - Element of the content

wfDescription - The workflow description

title - The title

syncCode - The synchronization code

context - the import context

Returns:

The imported or synchronized content

_getOrCreateContent

protected ModifiableContent _getOrCreateContent(ContentWorkflowDescription wfDescription,
                                                String title,
                                                String syncCode,
                                                ImportCDMFrContext context)

Get or create the content from the workflow description, the synchronization code and the import context.

Parameters:

wfDescription - The workflow description

title - The title

syncCode - The synchronization code

context - The import context

Returns:

the retrieved or created content

getContent

public ModifiableContent getContent(String contentType,
                                    String syncCode,
                                    ImportCDMFrContext context)

Description copied from interface: ImportCDMFrComponent

Get the content from the synchronization code, the content type and the context.

Specified by:

getContent in interface ImportCDMFrComponent

Parameters:

contentType - The content type

syncCode - The synchronization code

context - the import context

Returns:

the retrieved content

_createContent

protected ModifiableContent _createContent(ContentWorkflowDescription wfDescription,
                                           String title,
                                           ImportCDMFrContext context)
                                    throws com.opensymphony.workflow.WorkflowException

Create the content from the workflow description and the import context.

Parameters:

wfDescription - The workflow description

title - The title

context - The import context

Returns:

the created content

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs while creating the content

_getInputsForContentCreation

protected Map<String,Object> _getInputsForContentCreation(ContentWorkflowDescription wfDescription,
                                                                ImportCDMFrContext context)

Retrieves the inputs to give for content creation

Parameters:

wfDescription - The workflow description

context - The import context

Returns:

the inputs to give for content creation

_synchronizeContent

protected void _synchronizeContent(Element contentElement,
                                   ModifiableContent content,
                                   String contentTypeId,
                                   String syncCode,
                                   ImportCDMFrContext context)
                            throws Exception

Synchronize content

Parameters:

contentElement - the DOM content element

content - The content to synchronize

contentTypeId - The content type ID

syncCode - The synchronization code

context - the import context

Throws:

Exception - if an error occurs while synchronizing the content values

_getAdditionalValuesToSynchronize

protected Map<String,Object> _getAdditionalValuesToSynchronize(ModifiableContent content,
                                                                     String syncCode,
                                                                     ImportCDMFrContext context)

Retrieves additional values to synchronize for the content

Parameters:

content - the content

syncCode - the content synchronization code

context - the import context

Returns:

the additional values

_getNotSynchronizedRelatedContentIds

protected Set<String> _getNotSynchronizedRelatedContentIds(ModifiableContent content,
                                                           String syncCode,
                                                           ImportCDMFrContext context)

Retrieves the ids of the contents related to the given content but that are not part of the synchronization

Parameters:

content - the content

syncCode - the content synchronization code

context - the import context

Returns:

the not synchronized content ids

_editContent

protected void _editContent(WorkflowAwareContent content,
                            Optional<View> view,
                            Map<String,Object> values,
                            boolean create,
                            Set<String> notSynchronizedContentIds,
                            ImportCDMFrContext context)
                     throws com.opensymphony.workflow.WorkflowException

Synchronize the content with given values.

Parameters:

content - The content to synchronize

view - the view containing the item to edit

values - the values

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

notSynchronizedContentIds - the ids of the contents related to the given content but that are not part of the synchronization

context - the import context

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs

additionalOperations

public ContentSynchronizationResult additionalOperations(ModifiableContent content,
                                                         Map<String,Object> additionalParameters,
                                                         org.slf4j.Logger logger)

Description copied from interface: ImportCDMFrComponent

Add specific fields to the content during import or synchronization.

Specified by:

additionalOperations in interface ImportCDMFrComponent

Parameters:

content - Content to update

additionalParameters - Additional parameters

logger - The logger

Returns:

The synchronization result of the additional operations

_initializeShareableCoursesFields

protected List<ModifiableContent> _initializeShareableCoursesFields(ProgramItem programItem)

Initialize shareable fields for the courses under the given ProgramItem

Parameters:

programItem - the program item

Returns:

the list of contents that have been modified during the initialization

_linkTranslationsIfExist

protected void _linkTranslationsIfExist(ModifiableContent importedContent,
                                        String contentType,
                                        ImportCDMFrContext context)

Search for translated contents

Parameters:

importedContent - The imported content

contentType - The content type

context - the import context

_setOrgUnitParent

protected void _setOrgUnitParent(WorkflowAwareContent orgUnit,
                                 ImportCDMFrContext context)
                          throws Exception

Set the orgUnit parent to rootOrgUnit.

Parameters:

orgUnit - The orgunit to link

context - the import context

Throws:

Exception - if an error occurs while synchronizing the content values

validateContent

protected void validateContent(WorkflowAwareContent content,
                               int validationActionId,
                               org.slf4j.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

getIdFromCDMThenCode

public String getIdFromCDMThenCode(String tableRefId,
                                   String cdmCode)

Description copied from interface: ImportCDMFrComponent

Get the content ID from the CDM code, if there is no match with the CDM code, then we search with the code. If nothing is found we return null.

Specified by:

getIdFromCDMThenCode in interface ImportCDMFrComponent

Parameters:

tableRefId - The reference table ID

cdmCode - The CDM code

Returns:

A content ID or null

ignoreRights

protected boolean ignoreRights()

If true, bypass the rights check during the import process

Returns:

True if the rights check are bypassed during the import process

_getExpressionsList

protected List<Expression> _getExpressionsList(String contentTypeId,
                                               String syncCode,
                                               ImportCDMFrContext context)

Construct the query to retrieve the content.

Parameters:

contentTypeId - The content type

syncCode - The synchronization code

context - the import context

Returns:

The List of Expression

getLocalAndExternalFields

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

Description copied from interface: ImportCDMFrComponent

Get the path of tri-state fields (with local and external values)

Specified by:

getLocalAndExternalFields in interface ImportCDMFrComponent

Parameters:

additionalParameters - Additional parameters

Returns:

the synchronized fields