org.ametys.plugins.odfsync.cdmfr.components.impl

Class RemoteImportCDMFrComponent

java.lang.Object

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

org.ametys.plugins.odfsync.cdmfr.components.impl.RemoteImportCDMFrComponent

All Implemented Interfaces:

ImportCDMFrComponent, Initializable, Component, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

CoAccreditedRemoteImportCDMFrComponent

public class RemoteImportCDMFrComponent
extends AbstractImportCDMFrComponent

Component to import a CDM-fr input stream from a remote server.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.odfsync.cdmfr.components.AbstractImportCDMFrComponent

AbstractImportCDMFrComponent.ContentWorkflowDescription

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_forcedCatalog Forced catalog
protected boolean	_validateAfterImport Validate after import

Fields inherited from class org.ametys.plugins.odfsync.cdmfr.components.AbstractImportCDMFrComponent

_catalogsManager, _cdmFrSyncExtensionPoint, _cocoonContext, _contentPrefix, _contentTypeEP, _currentUserProvider, _domParser, _importedContents, _nbCreatedContents, _nbError, _nbNotChangedContents, _nbSynchronizedContents, _observationManager, _odfLang, _odfRefTableHelper, _resolver, _rootOUProvider, _syncFieldsByContentType, _synchroComponent, _synchronizedContents, _TAG_CONTAINER, _TAG_COURSELIST, _TAG_PROGRAM, _TAG_SUBPROGRAM, _updatedContents, _xPathProcessor

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

ROLE

Constructor Summary

Constructors

Constructor and Description
RemoteImportCDMFrComponent()

Method Summary

Modifier and Type	Method and Description
protected void	additionalOperationsBeforeSave(ModifiableDefaultContent content, Logger logger) Additional operation to do on the content before saving it.
protected void	additionalParameters(Map<String,Object> parameters) Additional parameters for specific treatments.
protected String	getCatalogName(Node contentNode) Get the name of catalog to use for import
void	initialize()
protected 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 Document	transformDocument(Document document, Map<String,Object> parameters, Logger logger) Transform the document depending of it structure.
protected boolean	validateAfterImport() True to validate the contents after import

Methods inherited from class org.ametys.plugins.odfsync.cdmfr.components.AbstractImportCDMFrComponent

_getIdFromCDMThenCode, _getOrCreateContent, _importOrSynchronizeContent, _linkTranslationsIfExist, _saveContentChanges, _setChildren, _setOrgUnitParent, _setRelations, _synchronizeContent, _synchronizeCourseList, _synchronizeMetadata, configure, contextualize, getContainerWfDescription, getCourseListWfDescription, getCourseWfDescription, getExpressionsList, getIdField, getLocalAndExternalFields, getOrgUnitWfDescription, getPersonWfDescription, getProgramWfDescription, getSubProgramWfDescription, handleInputStream, service

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_forcedCatalog

protected String _forcedCatalog

Forced catalog

_validateAfterImport

protected boolean _validateAfterImport

Validate after import

Constructor Detail

RemoteImportCDMFrComponent

public RemoteImportCDMFrComponent()

Method Detail

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractImportCDMFrComponent

Throws:

Exception

additionalParameters

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

Description copied from class: AbstractImportCDMFrComponent

Additional parameters for specific treatments.

Specified by:

additionalParameters in class AbstractImportCDMFrComponent

Parameters:

parameters - The parameters map to get

additionalOperationsBeforeSave

protected void additionalOperationsBeforeSave(ModifiableDefaultContent content,
                                              Logger logger)
                                       throws RepositoryException

Description copied from class: AbstractImportCDMFrComponent

Additional operation to do on the content before saving it.

Specified by:

additionalOperationsBeforeSave in class AbstractImportCDMFrComponent

Parameters:

content - The content

logger - The logger

Throws:

RepositoryException - if an error occurs

getCatalogName

protected String getCatalogName(Node contentNode)

Description copied from class: AbstractImportCDMFrComponent

Get the name of catalog to use for import

Overrides:

getCatalogName in class AbstractImportCDMFrComponent

Parameters:

contentNode - The node of program

Returns:

The catalog to used

transformDocument

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

Description copied from class: AbstractImportCDMFrComponent

Transform the document depending of it structure.

Overrides:

transformDocument in class AbstractImportCDMFrComponent

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.

validateAfterImport

protected boolean validateAfterImport()

Description copied from class: AbstractImportCDMFrComponent

True to validate the contents after import

Specified by:

validateAfterImport in class AbstractImportCDMFrComponent

Returns:

True to validate the contents after import

removalSync

protected boolean removalSync()

Description copied from class: AbstractImportCDMFrComponent

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 class AbstractImportCDMFrComponent

Returns:

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