Package org.ametys.plugins.odfsync.apogee.scc

Class AbstractApogeeSynchronizableContentsCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

org.ametys.plugins.odfsync.apogee.scc.AbstractApogeeSynchronizableContentsCollection

All Implemented Interfaces:

SynchronizableContentsCollection, ApogeeSynchronizableContentsCollection, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

AbstractApogeeSynchronizableContentsWithCatalogCollection, OrgUnitSynchronizableContentsCollection

public abstract class AbstractApogeeSynchronizableContentsCollection
extends AbstractSimpleSynchronizableContentsCollection
implements Contextualizable, ApogeeSynchronizableContentsCollection

Abstract class for Apogee synchronization

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	__PARAM_COLUMNS	Name of paramter holding columns
protected static final String	__PARAM_COLUMNS_COLUMN	Name of paramter into columns holding column
protected static final String	__PARAM_CRITERIA	Name of parameter holding the criteria
protected static final String	__PARAM_CRITERIA_CRITERION	Name of parameter into criteria holding a criterion
protected static final String	__PARAM_CRITERIA_CRITERION_ID	Name of parameter into criterion holding the id
protected static final String	__PARAM_CRITERIA_CRITERION_LABEL	Name of parameter into criterion holding the label
protected static final String	__PARAM_CRITERIA_CRITERION_TYPE	Name of parameter into criterion holding the type
protected static final String	__PARAM_ID_COLUMN	Name of parameter holding the field ID column
protected static final String	__PARAM_MAPPING	Name of parameter holding the fields mapping
protected static final String	__PARAM_MAPPING_ATTRIBUTE	Name of parameter into mapping holding the remote attribute
protected static final String	__PARAM_MAPPING_METADATA_REF	Name of parameter into mapping holding the path of metadata
protected static final String	__PARAM_MAPPING_SYNCHRO	Name of parameter into mapping holding the synchronized property
protected Boolean	_addExistingChildren	Parameter value to add existing children in Ametys on the current element
protected Boolean	_addUnexistingChildren	Parameter value to add unexisting children from Ametys on the current element
protected ApogeeDAO	_apogeeDAO	The DAO for remote DB Apogee
protected ApogeeSynchronizableContentsCollectionHelper	_apogeeSCCHelper	The Apogee SCC helper
protected Set<String>	_columns	Synchronized fields
protected Context	_context	Context
protected Set<ApogeeCriterion>	_criteria	Synchronized fields
protected String	_idColumn	Name of the Apogée column which contains the ID
protected JSONUtils	_jsonUtils	The JSON utils
protected Map<String,List<String>>	_mapping	Mapping between metadata and columns
protected ODFHelper	_odfHelper	The ODF helper
protected SynchronizableContentsCollectionDAO	_sccDAO	SCC DAO
protected Set<String>	_syncFields	Synchronized fields
static final String	PARAM_ADD_EXISTING_CHILDREN	Name of parameter holding the link existing children parameter
static final String	PARAM_ADD_UNEXISTING_CHILDREN	Name of parameter holding the adding unexisting children parameter
static final String	PARAM_DATASOURCE_ID	Name of parameter holding the data source id
static final String	PARAM_YEAR	Name of parameter holding the administrative year

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

_contentHelper, _synchronizingContentOperatorEP

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

_contentWorkflowHelper, _currentUserProvider, _hasGlobalError, _i18nUtils, _nbCreatedContents, _nbDeletedContents, _nbError, _nbNotChangedContents, _nbSynchronizedContents, _observationManager, SCC_UNIQUE_ID

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
AbstractApogeeSynchronizableContentsCollection()

Method Summary

Modifier and Type	Method	Description
protected void	_addContentAttributes(Request request, ModifiableContent content)	Add attributes from content in the request.
protected Object	_convertBigDecimal(String contentTypeId, String attributeName, Object objectToConvert)	Convert the object in parameter to a long if it's a BigDecimal, otherwise return the object itself.
protected List<Map<String,Object>>	_convertBigDecimal(List<Map<String,Object>> searchResults)	Convert the BigDecimal values retrieved from database into long values
protected Set<String>	_getChildrenRemoteSyncCode(Content content, SynchronizableContentsCollection scc, Logger logger)	Get the remote sync codes
protected Map<String,Object>	_getChildrenSearchParametersWithParent(String parentSyncCode)	Get the children search parameters.
protected String	_getSort(List<Object> sortList)	Transform the given List of Object to a String representing the ordered fields for SQL.
protected List<ModifiableContent>	_importChildren(String idValue, SynchronizableContentsCollection scc, Logger logger)	Import children
protected ModifiableContent	_importContent(String idValue, Map<String,Object> additionalParameters, String lang, Map<String,List<Object>> remoteValues, Logger logger)	Import a content from remote values.
protected List<ModifiableContent>	_importUnexistingChildren(SynchronizableContentsCollection scc, String syncCode, Map<String,List<Object>> additionalParameters, Logger logger)	Import an unexisting child in Ametys
protected List<ModifiableContent>	_internalPopulate(Logger logger, ContainerProgressionTracker progressionTracker)	Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger, ContainerProgressionTracker)
protected boolean	_isChildWillBeRemoved(ModifiableContent content, SynchronizableContentsCollection scc, Set<String> childrenRemoteSyncCode, Logger logger)	True if the content will be removed from the structure
protected void	_removeContentAttributes(Request request)	Remove attributes of the content from the request.
protected abstract List<Map<String,Object>>	_search(Map<String,Object> searchParameters, Logger logger)	Search the contents with the search parameters.
protected List<ModifiableContent>	_synchronizeChildren(Content content, SynchronizableContentsCollection scc, String attributeName, Logger logger)	Synchronize children
protected ModifiableContent	_synchronizeContent(ModifiableContent content, Map<String,List<Object>> remoteValues, Logger logger)	Synchronize a content with remove values.
protected Object	_transformClobToString(Object value, String idValue, Logger logger)	Transform CLOB value to String value.
protected Map<String,List<Object>>	_transformListOfMap2MapOfList(List<Map<String,Object>> lines)	Transform a List of Map to a Map of List computed by keys (lines to columns).
protected boolean	addExistingChildren()	Check if existing contents in Ametys should be added from data source
protected boolean	addUnexistingChildren()	Check if unexisting contents in Ametys should be added from data source
protected void	configureDataSource(Configuration configuration)	Configure the data source parameters.
protected void	configureSearchModel()	Configure the search model used by SCCSearchTool.
void	contextualize(Context context)
protected Map<String,Object>	getAdditionalAttributeValues(String idValue, Content content, Map<String,Object> additionalParameters, boolean create, Logger logger)	Retrieves additional values to synchronize for a content
protected abstract String	getChildrenAttributeName()	Get the attribute name to get children
protected String	getChildrenSCCModelId()	Get the children SCC model id.
protected Set<String>	getClobColumns()	Get the list of CLOB column's names.
protected String	getDataSourceId()	Get the id of data source
protected String	getIdColumn()	Get the identifier column (can be a concatened column).
String	getIdField()	Get the path of metadata holding the unique identifier
List<String>	getLanguages()	Get the languages handled by this collection
Set<String>	getLocalAndExternalFields(Map<String,Object> additionalParameters)	Get the path of tri-state fields (with local and external values)
protected abstract String	getMappingName()	Get the name of the mapping.
protected Set<String>	getNotSynchronizedRelatedContentIds(Content content, Map<String,Object> contentValues, Map<String,Object> additionalParameters, String lang, Logger logger)	Retrieves the ids of the contents related to the given content but that are not part of the synchronization
protected Pair<String,Object>	getParentAttribute(ModifiableContent parent)	Retrieves the attribute to synchronize for the given parent (as a Pair of name and value)
protected Optional<ModifiableContent>	getParentFromAdditionalParameters(Map<String,Object> additionalParameters)	Retrieves the parent id, extracted from additional parameters
protected Optional<String>	getParentIdFromAdditionalParameters(Map<String,Object> additionalParameters)	Retrieves the parent id, extracted from additional parameters
protected Map<String,Map<String,List<Object>>>	getRemoteValues(Map<String,Object> searchParameters, Logger logger)	Search values and return the result organized by attributes
int	getTotalCount(Map<String,Object> searchParameters, Logger logger)	Return the total number of results for the search.
protected String	getYear()	Get the administrative year
protected List<ModifiableContent>	handleChildren(String idValue, Content content, boolean create, Logger logger)	Import and synchronize children of the given content In the usual case, if we are in import mode (create to true) or if we trust the source (removalSync to true) we just synchronize structure but we don't synchronize child contents
boolean	handleRightAssignmentContext()	Return true if a RightAssignmentContext should be automatically generated for the contents of this SCC
List<ModifiableContent>	importContent(String idValue, Map<String,Object> additionalParameters, Logger logger)	Import a content from remote values.
protected List<ModifiableContent>	importOrSynchronizeChildren(String idValue, Content content, String sccModelId, String attributeName, boolean create, Logger logger)	Import and synchronize children of the given content In the usual case, if we are in import mode (create to true) or if we trust the source (removalSync to true) we just synchronize structure but we don't synchronize child contents
List<ModifiableContent>	importOrSynchronizeContents(Map<String,Object> searchParams, Logger logger)	Method used to import the structure of an ODF content or its dependencies, import or synchronize each child recursively.
protected Map<String,Map<String,Object>>	internalSearch(Map<String,Object> searchParameters, int offset, int limit, List<Object> sort, Logger logger)	Search values and return the result without any treatment.
List<ModifiableContent>	populate(Logger logger, ContainerProgressionTracker progressionTracker)	Populates contents
protected Map<String,Object>	putIdParameter(String idValue)	Set search parameters for the ID value.
void	service(ServiceManager manager)
void	synchronizeContent(ModifiableContent content, Logger logger)	Synchronize a content with remove values.

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

_addEditInputsForSCC, _editContent, _fillContent, _getContentsToRemove, _getEditInputs, _getEditInputsContextParameters, _handleContent, _importOrSynchronizeContent, _importOrSynchronizeContent, _importOrSynchronizeContents, _importOrSynchronizeContents, _isHandled, _transformRemoteValues, configure, createContentAction, getContent, getTransformedRemoteValues, search, updateSyncInformations, validateContent

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

_deleteContents, _getAdditionalInputsForContentCreation, _getContentPathQuery, _getExpressionsList, _hasSomethingChanged, _internalPopulate, _isParamNotEmpty, _logSynchronizationResult, _removeEmptyParameters, createContentAction, deleteUnexistingContents, empty, getSynchronizationResult, sendErrorMail, validateContent

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

_parseLanguages, _parseParameters, _transformRemoteValuesCardinality, configureStaticParams, getContentPrefix, getContentType, getId, getInitialActionId, getLabel, 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

Field Details

PARAM_DATASOURCE_ID

public static final String PARAM_DATASOURCE_ID

Name of parameter holding the data source id

See Also:

• Constant Field Values

PARAM_YEAR

public static final String PARAM_YEAR

Name of parameter holding the administrative year

See Also:

• Constant Field Values

PARAM_ADD_UNEXISTING_CHILDREN

public static final String PARAM_ADD_UNEXISTING_CHILDREN

Name of parameter holding the adding unexisting children parameter

See Also:

• Constant Field Values

PARAM_ADD_EXISTING_CHILDREN

public static final String PARAM_ADD_EXISTING_CHILDREN

Name of parameter holding the link existing children parameter

See Also:

• Constant Field Values

__PARAM_ID_COLUMN

protected static final String __PARAM_ID_COLUMN

Name of parameter holding the field ID column

See Also:

• Constant Field Values

__PARAM_MAPPING

protected static final String __PARAM_MAPPING

Name of parameter holding the fields mapping

See Also:

• Constant Field Values

__PARAM_MAPPING_SYNCHRO

protected static final String __PARAM_MAPPING_SYNCHRO

Name of parameter into mapping holding the synchronized property

See Also:

• Constant Field Values

__PARAM_MAPPING_METADATA_REF

protected static final String __PARAM_MAPPING_METADATA_REF

Name of parameter into mapping holding the path of metadata

See Also:

• Constant Field Values

__PARAM_MAPPING_ATTRIBUTE

protected static final String __PARAM_MAPPING_ATTRIBUTE

Name of parameter into mapping holding the remote attribute

See Also:

• Constant Field Values

__PARAM_CRITERIA

protected static final String __PARAM_CRITERIA

Name of parameter holding the criteria

See Also:

• Constant Field Values

__PARAM_CRITERIA_CRITERION

protected static final String __PARAM_CRITERIA_CRITERION

Name of parameter into criteria holding a criterion

See Also:

• Constant Field Values

__PARAM_CRITERIA_CRITERION_ID

protected static final String __PARAM_CRITERIA_CRITERION_ID

Name of parameter into criterion holding the id

See Also:

• Constant Field Values

__PARAM_CRITERIA_CRITERION_LABEL

protected static final String __PARAM_CRITERIA_CRITERION_LABEL

Name of parameter into criterion holding the label

See Also:

• Constant Field Values

__PARAM_CRITERIA_CRITERION_TYPE

protected static final String __PARAM_CRITERIA_CRITERION_TYPE

Name of parameter into criterion holding the type

See Also:

• Constant Field Values

__PARAM_COLUMNS

protected static final String __PARAM_COLUMNS

Name of paramter holding columns

See Also:

• Constant Field Values

__PARAM_COLUMNS_COLUMN

protected static final String __PARAM_COLUMNS_COLUMN

Name of paramter into columns holding column

See Also:

• Constant Field Values

_addUnexistingChildren

protected Boolean _addUnexistingChildren

Parameter value to add unexisting children from Ametys on the current element

_addExistingChildren

protected Boolean _addExistingChildren

Parameter value to add existing children in Ametys on the current element

_idColumn

protected String _idColumn

Name of the Apogée column which contains the ID

_mapping

protected Map<String,List<String>> _mapping

Mapping between metadata and columns

_syncFields

protected Set<String> _syncFields

Synchronized fields

_columns

protected Set<String> _columns

Synchronized fields

_criteria

protected Set<ApogeeCriterion> _criteria

Synchronized fields

_context

protected Context _context

Context

_apogeeDAO

protected ApogeeDAO _apogeeDAO

The DAO for remote DB Apogee

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils

_sccDAO

protected SynchronizableContentsCollectionDAO _sccDAO

SCC DAO

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_apogeeSCCHelper

protected ApogeeSynchronizableContentsCollectionHelper _apogeeSCCHelper

The Apogee SCC helper

Constructor Details

AbstractApogeeSynchronizableContentsCollection

public AbstractApogeeSynchronizableContentsCollection()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSimpleSynchronizableContentsCollection

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

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

populate

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

Description copied from interface: SynchronizableContentsCollection

Populates contents

Specified by:

populate in interface SynchronizableContentsCollection

Overrides:

populate in class AbstractSimpleSynchronizableContentsCollection

Parameters:

logger - The logger

progressionTracker - A progression tracker

Returns:

Return the populated contents (imported or synchronized)

_internalPopulate

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

Description copied from class: AbstractSynchronizableContentsCollection

Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger, ContainerProgressionTracker)

Overrides:

_internalPopulate in class AbstractSimpleSynchronizableContentsCollection

Parameters:

logger - The logger

progressionTracker - The progression tracker

Returns:

The list of created/synchronized contents

internalSearch

protected Map<String,Map<String,Object>> internalSearch(Map<String,Object> searchParameters,
 int offset,
 int limit,
 List<Object> sort,
 Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Search values and return the result without any treatment.

Specified by:

internalSearch in class AbstractSimpleSynchronizableContentsCollection

Parameters:

searchParameters - Search parameters to restrict the search

offset - Begin of the search

limit - Number of results

sort - Sort of results (ignored for LDAP results)

logger - The logger

Returns:

Map of results without any treatment.

getRemoteValues

protected Map<String,Map<String,List<Object>>> getRemoteValues(Map<String,Object> searchParameters,
 Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Search values and return the result organized by attributes

Specified by:

getRemoteValues in class AbstractSimpleSynchronizableContentsCollection

Parameters:

searchParameters - Search parameters to restrict the search

logger - The logger

Returns:

Map of results organized by attributes.

getLanguages

public List<String> getLanguages()

Description copied from interface: SynchronizableContentsCollection

Get the languages handled by this collection

Specified by:

getLanguages in interface SynchronizableContentsCollection

Overrides:

getLanguages in class AbstractStaticSynchronizableContentsCollection

Returns:

the list of language

importContent

public List<ModifiableContent> 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

Overrides:

importContent in class AbstractSimpleSynchronizableContentsCollection

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.

synchronizeContent

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

Description copied from interface: SynchronizableContentsCollection

Synchronize a content with remove values.

Specified by:

synchronizeContent in interface SynchronizableContentsCollection

Overrides:

synchronizeContent in class AbstractSimpleSynchronizableContentsCollection

Parameters:

content - The content to synchronize

logger - The logger

Throws:

Exception - if an error occurs.

_addContentAttributes

protected void _addContentAttributes(Request request,
 ModifiableContent content)

Add attributes from content in the request.

Parameters:

request - The request

content - The content

_removeContentAttributes

protected void _removeContentAttributes(Request request)

Remove attributes of the content from the request.

Parameters:

request - The request

putIdParameter

protected Map<String,Object> putIdParameter(String idValue)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Set search parameters for the ID value.

Specified by:

putIdParameter in class AbstractSimpleSynchronizableContentsCollection

Parameters:

idValue - Value to search

Returns:

Map with the search parameters

_search

protected abstract List<Map<String,Object>> _search(Map<String,Object> searchParameters,
 Logger logger)

Search the contents with the search parameters. Use id parameter to search an unique content.

Parameters:

searchParameters - Search parameters

logger - The logger

Returns:

A Map of mapped metadatas extract from Apogée database ordered by content unique Apogée ID

_convertBigDecimal

protected List<Map<String,Object>> _convertBigDecimal(List<Map<String,Object>> searchResults)

Convert the BigDecimal values retrieved from database into long values

Parameters:

searchResults - The initial search results from database

Returns:

The converted search results

_convertBigDecimal

protected Object _convertBigDecimal(String contentTypeId,
 String attributeName,
 Object objectToConvert)

Convert the object in parameter to a long if it's a BigDecimal, otherwise return the object itself.

Parameters:

contentTypeId - The content type of the parent content

attributeName - The metadata name

objectToConvert - The object to convert if necessary

Returns:

The converted object

_transformClobToString

protected Object _transformClobToString(Object value,
 String idValue,
 Logger logger)

Transform CLOB value to String value.

Parameters:

value - The input value

idValue - The identifier of the program

logger - The logger

Returns:

the same value, with CLOB transformed to String.

getClobColumns

protected Set<String> getClobColumns()

Get the list of CLOB column's names.

Returns:

The list of the CLOB column's names to transform to String

_transformListOfMap2MapOfList

protected Map<String,List<Object>> _transformListOfMap2MapOfList(List<Map<String,Object>> lines)

Transform a List of Map to a Map of List computed by keys (lines to columns).

Parameters:

lines - List to reorganize

Returns:

Map of List

getMappingName

protected abstract String getMappingName()

Get the name of the mapping.

Returns:

the mapping name

getDataSourceId

protected String getDataSourceId()

Get the id of data source

Returns:

The id of data source

getYear

protected String getYear()

Get the administrative year

Returns:

The administrative year

addUnexistingChildren

protected boolean addUnexistingChildren()

Check if unexisting contents in Ametys should be added from data source

Returns:

true if unexisting contents in Ametys should be added from data source, default value is true

addExistingChildren

protected boolean addExistingChildren()

Check if existing contents in Ametys should be added from data source

Returns:

true if existing contents in Ametys should be added from data source, default value is false

getIdColumn

protected String getIdColumn()

Get the identifier column (can be a concatened column).

Returns:

the column id

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.

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

configureSearchModel

protected void configureSearchModel()

Description copied from class: AbstractStaticSynchronizableContentsCollection

Configure the search model used by SCCSearchTool.

Specified by:

configureSearchModel in class AbstractStaticSynchronizableContentsCollection

getAdditionalAttributeValues

protected Map<String,Object> getAdditionalAttributeValues(String idValue,
 Content content,
 Map<String,Object> additionalParameters,
 boolean create,
 Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Retrieves additional values to synchronize for a content

Overrides:

getAdditionalAttributeValues in class AbstractSimpleSynchronizableContentsCollection

Parameters:

idValue - id value of the content

content - The content

additionalParameters - Additional parameters

create - true if the content has been newly created, false otherwise

logger - The logger

Returns:

the values to add

getParentAttribute

protected Pair<String,Object> getParentAttribute(ModifiableContent parent)

Retrieves the attribute to synchronize for the given parent (as a Pair of name and value)

Parameters:

parent - the parent content

Returns:

the parent attribute

handleChildren

protected List<ModifiableContent> handleChildren(String idValue,
 Content content,
 boolean create,
 Logger logger)

Import and synchronize children of the given content In the usual case, if we are in import mode (create to true) or if we trust the source (removalSync to true) we just synchronize structure but we don't synchronize child contents

Parameters:

idValue - The current content synchronization code

content - The current content

create - true if the content has been newly created

logger - The logger

Returns:

The handled children

getNotSynchronizedRelatedContentIds

protected Set<String> getNotSynchronizedRelatedContentIds(Content content,
 Map<String,Object> contentValues,
 Map<String,Object> additionalParameters,
 String lang,
 Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

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

Overrides:

getNotSynchronizedRelatedContentIds in class AbstractSimpleSynchronizableContentsCollection

Parameters:

content - content

contentValues - the content values that will be set

additionalParameters - Additional parameters

lang - Language of the content

logger - The logger

Returns:

the ids of the contents that are not part of the synchronization

getParentFromAdditionalParameters

protected Optional<ModifiableContent> getParentFromAdditionalParameters(Map<String,Object> additionalParameters)

Retrieves the parent id, extracted from additional parameters

Parameters:

additionalParameters - the additional parameters

Returns:

the parent id

getParentIdFromAdditionalParameters

protected Optional<String> getParentIdFromAdditionalParameters(Map<String,Object> additionalParameters)

Retrieves the parent id, extracted from additional parameters

Parameters:

additionalParameters - the additional parameters

Returns:

the parent id

getChildrenSCCModelId

protected String getChildrenSCCModelId()

Get the children SCC model id. Can be null if no implementation is defined.

Returns:

the children SCC model id

getChildrenAttributeName

protected abstract String getChildrenAttributeName()

Get the attribute name to get children

Returns:

the attribute name to get children

_getSort

protected String _getSort(List<Object> sortList)

Transform the given List of Object to a String representing the ordered fields for SQL.

Parameters:

sortList - The sort list object to transform to the list of ordered fields compatible with SQL.

Returns:

A string representing the list of ordered fields

getTotalCount

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

Description copied from interface: SynchronizableContentsCollection

Return the total number of results for the search.

Specified by:

getTotalCount in interface SynchronizableContentsCollection

Overrides:

getTotalCount in class AbstractSimpleSynchronizableContentsCollection

Parameters:

searchParameters - Parameters for the search

logger - The logger

Returns:

The total count

_importContent

protected ModifiableContent _importContent(String idValue,
 Map<String,Object> additionalParameters,
 String lang,
 Map<String,List<Object>> remoteValues,
 Logger logger)
                                    throws Exception

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Import a content from remote values.

Overrides:

_importContent in class AbstractSimpleSynchronizableContentsCollection

Parameters:

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

additionalParameters - Specific parameters for import

lang - Lang of the content

remoteValues - Values of the content

logger - The logger

Returns:

The content created by import, or null

Throws:

Exception - if an error occurs.

_synchronizeContent

protected ModifiableContent _synchronizeContent(ModifiableContent content,
 Map<String,List<Object>> remoteValues,
 Logger logger)
                                         throws Exception

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Synchronize a content with remove values.

Overrides:

_synchronizeContent in class AbstractSimpleSynchronizableContentsCollection

Parameters:

content - The content to synchronize

remoteValues - Values to synchronize

logger - The logger

Returns:

The synchronized content

Throws:

Exception - if an error occurs

importOrSynchronizeChildren

protected List<ModifiableContent> importOrSynchronizeChildren(String idValue,
 Content content,
 String sccModelId,
 String attributeName,
 boolean create,
 Logger logger)

Import and synchronize children of the given content In the usual case, if we are in import mode (create to true) or if we trust the source (removalSync to true) we just synchronize structure but we don't synchronize child contents

Parameters:

idValue - The parent content synchronization code

content - The parent content

sccModelId - SCC model ID

attributeName - The name of the attribute containing children

create - true if the content has been newly created

logger - The logger

Returns:

The imported or synchronized children

_importChildren

protected List<ModifiableContent> _importChildren(String idValue,
 SynchronizableContentsCollection scc,
 Logger logger)

Import children

Parameters:

idValue - The parent content synchronization code

scc - The SCC

logger - The logger

Returns:

The imported children

_synchronizeChildren

protected List<ModifiableContent> _synchronizeChildren(Content content,
 SynchronizableContentsCollection scc,
 String attributeName,
 Logger logger)

Synchronize children

Parameters:

content - Parent content

scc - The SCC

attributeName - The name of the attribute containing children

logger - The logger

Returns:

true if there are changes

_getChildrenRemoteSyncCode

protected Set<String> _getChildrenRemoteSyncCode(Content content,
 SynchronizableContentsCollection scc,
 Logger logger)

Get the remote sync codes

Parameters:

content - Parent content

scc - the scc

logger - The logger

Returns:

the remote sync codes or null if the scc is not from Apogee

_getChildrenSearchParametersWithParent

protected Map<String,Object> _getChildrenSearchParametersWithParent(String parentSyncCode)

Get the children search parameters.

Parameters:

parentSyncCode - The parent synchronization code

Returns:

a Map of search parameters

_importUnexistingChildren

protected List<ModifiableContent> _importUnexistingChildren(SynchronizableContentsCollection scc,
 String syncCode,
 Map<String,List<Object>> additionalParameters,
 Logger logger)

Import an unexisting child in Ametys

Parameters:

scc - the scc to import the content

syncCode - the sync code of the content

additionalParameters - the additional params

logger - the logger

Returns:

the list of created children

_isChildWillBeRemoved

protected boolean _isChildWillBeRemoved(ModifiableContent content,
 SynchronizableContentsCollection scc,
 Set<String> childrenRemoteSyncCode,
 Logger logger)

True if the content will be removed from the structure

Parameters:

content - the content

scc - the scc

childrenRemoteSyncCode - the remote sync codes

logger - the logger

Returns:

true if the content will be removed from the structure

importOrSynchronizeContents

public List<ModifiableContent> importOrSynchronizeContents(Map<String,Object> searchParams,
 Logger logger)

Description copied from interface: ApogeeSynchronizableContentsCollection

Method used to import the structure of an ODF content or its dependencies, import or synchronize each child recursively.

Specified by:

importOrSynchronizeContents in interface ApogeeSynchronizableContentsCollection

Parameters:

searchParams - Search parameters

logger - The logger

Returns:

The List of ModifiableContent of children (imported or synchronized)

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