org.ametys.plugins.userdirectory.synchronize

Class SQLSynchronizableUDOrgunitCollection

java.lang.Object

org.ametys.plugins.contentio.synchronize.AbstractStaticSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.AbstractSimpleSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.impl.AbstractDataSourceSynchronizableContentsCollection

org.ametys.plugins.contentio.synchronize.impl.SQLSynchronizableContentsCollection

org.ametys.plugins.userdirectory.synchronize.SQLSynchronizableUDOrgunitCollection

All Implemented Interfaces:

SynchronizableContentsCollection, Component, Configurable, Serviceable

public class SQLSynchronizableUDOrgunitCollection
extends SQLSynchronizableContentsCollection

Synchronizable collection for UD Orgunits

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__PARAM_LOGIN_USER_METADATA_NAME
private static String	__PARAM_SQL_LOGIN_USER_COLUMN_NAME
private static String	__PARAM_SQL_ORGUNIT_JOIN_COLUMN_NAME
private static String	__PARAM_SQL_ORGUNIT_REMOTE_ID_COLUMN_NAME
private static String	__PARAM_SQL_ROLE_USER_COLUMN_NAME
private static String	__PARAM_SQL_TABLE_USER
protected ContentWorkflowHelper	_contentWorkflowHelper The content workflow helper
protected DeleteOrgUnitComponent	_deleteOrgUnitComponent The delete orgUnit component
protected OrganisationChartPageHandler	_orgChartPageHandler The organisation chart page handler
protected Map<String,String>	_orgUnitParents The map which link orgunit with this parent
protected Map<String,String>	_orgUnitRemoteIds The map which link orgunit with sql remote ids
protected Set<WorkflowAwareContent>	_orgUnitsToApplyChanges The set of orgunits to apply changes
protected Map<String,Map<String,String>>	_orgUnitUsers The map which link orgunit with users (userId and role)
protected OutgoingReferencesExtractor	_outgoingReferencesExtractor The OutgoingReferences extractor
protected SQLUserSearchDAO	_sqlUserDAO The sql user search DAO
protected CurrentUserProvider	_userProvider The current user provider
static String	ORGUNIT_REMOTE_ID_INTERNAL_METADATA The internal metadata name for orgUnit remote sql id

Fields inherited from class org.ametys.plugins.contentio.synchronize.impl.SQLSynchronizableContentsCollection

_sqlCollectionDAO

Fields inherited from class org.ametys.plugins.contentio.synchronize.impl.AbstractDataSourceSynchronizableContentsCollection

__PARAM_DATASOURCE_ID, __PARAM_FIELD_ID, __PARAM_MAPPING, __PARAM_MAPPING_ATTRIBUTE, __PARAM_MAPPING_METADATA_REF, __PARAM_MAPPING_SYNCHRO, _columnsAndCriteria, _extFields, _jsonUtils, _mapping, _syncFields

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

_contentHelper, _sccHelper, _synchronizingContentOperatorEP

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, _languages, _modelId, _modelParamValues, _removalSync, _reportMails, _restrictedField, _searchModelConfiguration, _synchronizeActionId, _synchronizeExistingContentsOnly, _synchronizingContentOperator, _validateActionId, _validateAfterImport, _workflowName

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

COLLECTION_ID_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SQLSynchronizableUDOrgunitCollection()

Method Summary

Modifier and Type	Method and Description
protected boolean	_additionalOperations(ModifiableDefaultContent orgUnit, Map<String,List<Object>> remoteValues, Logger logger) Do additional operations
private void	_applyChanges(WorkflowAwareContent content, int actionId, String comment)
protected void	_fillOrgUnitUserMap(Map<String,Map<String,String>> orgUnitUsers, String remoteOrgUnitKey, String loginColumnName, String roleColumnName, Map<String,Object> normalizedUserMap, Logger logger) Fill the orgUnitUsers map
protected Content	_getOrgUnitContentFromRemoteId(String remoteId, String lang, Logger logger) Get orgunit content from the remote Id
protected Map<String,Map<String,String>>	_getOrgUnitUser(Logger logger) Get orgUnit user map
protected Map<String,Object>	_getSearchParameters(Map<String,Object> parameters, int offset, int limit, List<Object> sort, List<String> columns) Get the parameters map for mybatis search
protected Map<String,Object>	_getSearchUserParameters(String orgUnitColumnKey, Logger logger) Get the parameters map for user mybatis search
protected Content	_getUserContent(String loginValue, String lang, Logger logger) Get user content from login value
protected String	_getUserIdValue(ModifiableDefaultContent userContent, Logger logger) Get the user id value
protected List<ModifiableDefaultContent>	_importOrSynchronizeContent(String idValue, String lang, Map<String,List<Object>> remoteValues, boolean forceImport, Logger logger) Imports or synchronizes a content for a given language
List<ModifiableDefaultContent>	_internalPopulate(Logger logger) Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger)
protected void	_setContentsRelationWithParentOrgunit(List<ModifiableDefaultContent> orgUnitContents, Logger logger) Set all orgunit parents relation for each synchronized content
protected void	_setInvertRelationForUser(ModifiableDefaultContent orgUnitContent, Content userContent) Set invert relation for user
protected void	_setRelationWithParentOrgunit(ModifiableDefaultContent parentContent, ModifiableDefaultContent childContent, Logger logger) Set the relation between the orgunit parent and its child
protected boolean	_synchronizeUserRepeater(ModifiableDefaultContent orgUnitContent, Map<String,String> orgUnitUsers, Logger logger) True if the user repeater needs changes
protected boolean	_synchronizeUserRepeaterOperation(ModifiableDefaultContent orgUnitContent, String orgUnitIdValue, Logger logger) Synchronize user repeater for orgunit content
protected boolean	additionalImportOperations(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, Map<String,Object> importParams, Logger logger) Add specific fields to the content.
protected boolean	additionalSynchronizeOperations(ModifiableDefaultContent content, Map<String,List<Object>> remoteValues, Logger logger) Add specific fields to the content.
protected void	deleteUnexistingContents(Logger logger) Delete contents created by a previous synchronization which does not exist anymore in remote source
String	getLoginUserColumnName() Get the login user column name
String	getLoginUserMetadataName() Get the login user metadata name
String	getOrgunitJoinColumnNameForUser() Get the name of the orgunit join column name of the user table
String	getOrgUnitRemoteIdColumnName() Get the orgunit remote id column name
String	getRoleUserColumnName() Get the role user column name
String	getUserTableName() Get the name of user SQL table
protected Map<String,Map<String,Object>>	internalSearch(Map<String,Object> parameters, int offset, int limit, List<Object> sort, Logger logger) Search values and return the result without any treatment.
List<ModifiableDefaultContent>	populate(Logger logger) Populates contents
protected void	removeEntry(int position, ModifiableCompositeMetadata repositoryComposite) Removes the repeater entry at the given position.
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.plugins.contentio.synchronize.impl.SQLSynchronizableContentsCollection

_checkIdObjectValue, _getNormalizedSearchResult, _getTotalCounParameters, _normalizeSearchResult, getTableName, getTotalCount

Methods inherited from class org.ametys.plugins.contentio.synchronize.impl.AbstractDataSourceSynchronizableContentsCollection

configureDataSource, configureSearchModel, getDataSourceId, getExternalOnlyFields, getIdField, getLocalAndExternalFields, getMapping, getRemoteValues, putIdParameter

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

_fillContent, _getContentsToRemove, _getIdFieldValue, _handleContent, _importContent, _importOrSynchronizeContent, _importOrSynchronizeContents, _isHandled, _synchronizeContent, additionalCommonOperations, configure, createContentAction, getContent, getTransformedRemoteValues, importContent, search, synchronizeContent, updateSyncInformations, validateContent

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

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

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

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

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

handleRightAssignmentContext

Field Detail

ORGUNIT_REMOTE_ID_INTERNAL_METADATA

public static final String ORGUNIT_REMOTE_ID_INTERNAL_METADATA

The internal metadata name for orgUnit remote sql id

See Also:

Constant Field Values

__PARAM_SQL_TABLE_USER

private static final String __PARAM_SQL_TABLE_USER

See Also:

Constant Field Values

__PARAM_SQL_ORGUNIT_JOIN_COLUMN_NAME

private static final String __PARAM_SQL_ORGUNIT_JOIN_COLUMN_NAME

See Also:

Constant Field Values

__PARAM_LOGIN_USER_METADATA_NAME

private static final String __PARAM_LOGIN_USER_METADATA_NAME

See Also:

Constant Field Values

__PARAM_SQL_LOGIN_USER_COLUMN_NAME

private static final String __PARAM_SQL_LOGIN_USER_COLUMN_NAME

See Also:

Constant Field Values

__PARAM_SQL_ROLE_USER_COLUMN_NAME

private static final String __PARAM_SQL_ROLE_USER_COLUMN_NAME

See Also:

Constant Field Values

__PARAM_SQL_ORGUNIT_REMOTE_ID_COLUMN_NAME

private static final String __PARAM_SQL_ORGUNIT_REMOTE_ID_COLUMN_NAME

See Also:

Constant Field Values

_orgUnitParents

protected Map<String,String> _orgUnitParents

The map which link orgunit with this parent

_orgUnitUsers

protected Map<String,Map<String,String>> _orgUnitUsers

The map which link orgunit with users (userId and role)

_orgUnitRemoteIds

protected Map<String,String> _orgUnitRemoteIds

The map which link orgunit with sql remote ids

_orgUnitsToApplyChanges

protected Set<WorkflowAwareContent> _orgUnitsToApplyChanges

The set of orgunits to apply changes

_sqlUserDAO

protected SQLUserSearchDAO _sqlUserDAO

The sql user search DAO

_orgChartPageHandler

protected OrganisationChartPageHandler _orgChartPageHandler

The organisation chart page handler

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The content workflow helper

_userProvider

protected CurrentUserProvider _userProvider

The current user provider

_outgoingReferencesExtractor

protected OutgoingReferencesExtractor _outgoingReferencesExtractor

The OutgoingReferences extractor

_deleteOrgUnitComponent

protected DeleteOrgUnitComponent _deleteOrgUnitComponent

The delete orgUnit component

Constructor Detail

SQLSynchronizableUDOrgunitCollection

public SQLSynchronizableUDOrgunitCollection()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SQLSynchronizableContentsCollection

Throws:

ServiceException

getUserTableName

public String getUserTableName()

Get the name of user SQL table

Returns:

The user SQL table name

getOrgunitJoinColumnNameForUser

public String getOrgunitJoinColumnNameForUser()

Get the name of the orgunit join column name of the user table

Returns:

The name of the orgunit join column name

getLoginUserMetadataName

public String getLoginUserMetadataName()

Get the login user metadata name

Returns:

The login user metadata name

getLoginUserColumnName

public String getLoginUserColumnName()

Get the login user column name

Returns:

The login user column name

getRoleUserColumnName

public String getRoleUserColumnName()

Get the role user column name

Returns:

The role user column name

getOrgUnitRemoteIdColumnName

public String getOrgUnitRemoteIdColumnName()

Get the orgunit remote id column name

Returns:

The orgunit remote id column name

_getSearchParameters

protected Map<String,Object> _getSearchParameters(Map<String,Object> parameters,
                                                  int offset,
                                                  int limit,
                                                  List<Object> sort,
                                                  List<String> columns)

Description copied from class: SQLSynchronizableContentsCollection

Get the parameters map for mybatis search

Overrides:

_getSearchParameters in class SQLSynchronizableContentsCollection

Parameters:

parameters - the filter parameter

offset - the offset

limit - the limit

sort - the sort map

columns - the list of columns

Returns:

the parameter map

internalSearch

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

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Search values and return the result without any treatment.

Overrides:

internalSearch in class SQLSynchronizableContentsCollection

Parameters:

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

populate

public List<ModifiableDefaultContent> populate(Logger logger)

Description copied from interface: SynchronizableContentsCollection

Populates contents

Specified by:

populate in interface SynchronizableContentsCollection

Overrides:

populate in class AbstractSimpleSynchronizableContentsCollection

Parameters:

logger - The logger

Returns:

Return the populated contents (imported or synchronized)

_internalPopulate

public List<ModifiableDefaultContent> _internalPopulate(Logger logger)

Description copied from class: AbstractSynchronizableContentsCollection

Internal implementation of AbstractSynchronizableContentsCollection.populate(Logger)

Overrides:

_internalPopulate in class AbstractSimpleSynchronizableContentsCollection

Parameters:

logger - The logger

Returns:

The list of created/synchronized contents

_importOrSynchronizeContent

protected List<ModifiableDefaultContent> _importOrSynchronizeContent(String idValue,
                                                                     String lang,
                                                                     Map<String,List<Object>> remoteValues,
                                                                     boolean forceImport,
                                                                     Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Imports or synchronizes a content for a given language

Overrides:

_importOrSynchronizeContent in class AbstractSimpleSynchronizableContentsCollection

Parameters:

idValue - The unique identifier of the content

lang - The language of content to import or synchronize

remoteValues - The remote values

forceImport - To force import and ignoring the synchronize existing contents only option

logger - The logger

Returns:

The list of imported and synchronized contents

additionalSynchronizeOperations

protected boolean additionalSynchronizeOperations(ModifiableDefaultContent content,
                                                  Map<String,List<Object>> remoteValues,
                                                  Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Add specific fields to the content.

Overrides:

additionalSynchronizeOperations in class AbstractSimpleSynchronizableContentsCollection

Parameters:

content - Content to update

remoteValues - Values of the content

logger - The logger

Returns:

true if there are changes

additionalImportOperations

protected boolean additionalImportOperations(ModifiableDefaultContent content,
                                             Map<String,List<Object>> remoteValues,
                                             Map<String,Object> importParams,
                                             Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Add specific fields to the content.

Overrides:

additionalImportOperations in class AbstractSimpleSynchronizableContentsCollection

Parameters:

content - Content to update

remoteValues - Values of the content

importParams - Import parameters

logger - The logger

Returns:

true if there are changes

_additionalOperations

protected boolean _additionalOperations(ModifiableDefaultContent orgUnit,
                                        Map<String,List<Object>> remoteValues,
                                        Logger logger)

Do additional operations

Parameters:

orgUnit - the orgUnit content

remoteValues - the remote values

logger - the logger

Returns:

true if changes

_getOrgUnitUser

protected Map<String,Map<String,String>> _getOrgUnitUser(Logger logger)

Get orgUnit user map

Parameters:

logger - the logger

Returns:

the orgUnit user map

_fillOrgUnitUserMap

protected void _fillOrgUnitUserMap(Map<String,Map<String,String>> orgUnitUsers,
                                   String remoteOrgUnitKey,
                                   String loginColumnName,
                                   String roleColumnName,
                                   Map<String,Object> normalizedUserMap,
                                   Logger logger)

Fill the orgUnitUsers map

Parameters:

orgUnitUsers - the orgunit user map

remoteOrgUnitKey - the remote key

loginColumnName - the login column name

roleColumnName - the role column name

normalizedUserMap - the normalized search user map

logger - the logger

_setContentsRelationWithParentOrgunit

protected void _setContentsRelationWithParentOrgunit(List<ModifiableDefaultContent> orgUnitContents,
                                                     Logger logger)

Set all orgunit parents relation for each synchronized content

Parameters:

orgUnitContents - the synchronized content

logger - the logger

_setRelationWithParentOrgunit

protected void _setRelationWithParentOrgunit(ModifiableDefaultContent parentContent,
                                             ModifiableDefaultContent childContent,
                                             Logger logger)
                                      throws com.opensymphony.workflow.WorkflowException

Set the relation between the orgunit parent and its child

Parameters:

parentContent - the parent content

childContent - the child content

logger - the logger

Throws:

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

_applyChanges

private void _applyChanges(WorkflowAwareContent content,
                           int actionId,
                           String comment)
                    throws com.opensymphony.workflow.WorkflowException

Throws:

com.opensymphony.workflow.WorkflowException

_synchronizeUserRepeaterOperation

protected boolean _synchronizeUserRepeaterOperation(ModifiableDefaultContent orgUnitContent,
                                                    String orgUnitIdValue,
                                                    Logger logger)
                                             throws com.opensymphony.workflow.WorkflowException

Synchronize user repeater for orgunit content

Parameters:

orgUnitContent - the orgunit content

orgUnitIdValue - the orgUnit id value

logger - the logger

Returns:

true if changes

Throws:

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

_synchronizeUserRepeater

protected boolean _synchronizeUserRepeater(ModifiableDefaultContent orgUnitContent,
                                           Map<String,String> orgUnitUsers,
                                           Logger logger)
                                    throws com.opensymphony.workflow.WorkflowException

True if the user repeater needs changes

Parameters:

orgUnitContent - the orgUnit content

orgUnitUsers - the map of orgunit users

logger - the logger

Returns:

true if the user repeater needs changes

Throws:

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

_setInvertRelationForUser

protected void _setInvertRelationForUser(ModifiableDefaultContent orgUnitContent,
                                         Content userContent)
                                  throws com.opensymphony.workflow.WorkflowException

Set invert relation for user

Parameters:

orgUnitContent - the orgUnit content

userContent - the user content

Throws:

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

removeEntry

protected void removeEntry(int position,
                           ModifiableCompositeMetadata repositoryComposite)

Removes the repeater entry at the given position. The position starts at index 1. The position can be an integer between 1 and the repeater size to remove an entry from the beginning Or the position can an integer between 0 and - the repeater size to remove an entry from the end (0 means at the end, -1 means before the last one and so on)

Parameters:

position - The position of the entry to remove

repositoryComposite - the repository composite of the repeater

Throws:

IllegalArgumentException - if the position is not between the negative and positive repeater size

_getUserContent

protected Content _getUserContent(String loginValue,
                                  String lang,
                                  Logger logger)

Get user content from login value

Parameters:

loginValue - the login value

lang - the language

logger - the logger

Returns:

the user content

_getOrgUnitContentFromRemoteId

protected Content _getOrgUnitContentFromRemoteId(String remoteId,
                                                 String lang,
                                                 Logger logger)

Get orgunit content from the remote Id

Parameters:

remoteId - the remote Id

lang - the language

logger - the logger

Returns:

the orgunit content

_getSearchUserParameters

protected Map<String,Object> _getSearchUserParameters(String orgUnitColumnKey,
                                                      Logger logger)

Get the parameters map for user mybatis search

Parameters:

orgUnitColumnKey - the column name of the orgunit key

logger - the logger

Returns:

the parameter map

_getUserIdValue

protected String _getUserIdValue(ModifiableDefaultContent userContent,
                                 Logger logger)

Get the user id value

Parameters:

userContent - the user content

logger - the logger

Returns:

the user id value

deleteUnexistingContents

protected void deleteUnexistingContents(Logger logger)

Description copied from class: AbstractSynchronizableContentsCollection

Delete contents created by a previous synchronization which does not exist anymore in remote source

Overrides:

deleteUnexistingContents in class AbstractSynchronizableContentsCollection

Parameters:

logger - The logger