Package org.ametys.plugins.userdirectory.synchronize

Class SQLSynchronizableUsersCollection

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

All Implemented Interfaces:

SynchronizableContentsCollection, Component, Configurable, Serviceable

public class SQLSynchronizableUsersCollection
extends SQLSynchronizableContentsCollection

SQL synchronizable collection for users

Field Summary

Fields

Modifier and Type	Field	Description
protected DeleteUserComponent	_deleteUserComponent	The delete user component
protected UserManager	_userManager	The user manager

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, _jsonUtils, _mapping, _syncFields

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

Method Summary

Modifier and Type	Method	Description
protected boolean	_checkIdObjectValue(String remoteKey, Object idObjectValue, Logger logger)	Check if the id object value is correct
protected int	_deleteContents(List<Content> contentsToRemove, Logger logger)	Delete contents.
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>	getAdditionalAttributeValues(String idValue, Content content, Map<String,Object> additionalParameters, boolean create, Logger logger)	Retrieves additional values to synchronize for a content
String	getIdField()	Get the path of metadata holding the unique identifier
String	getLoginSQLColumnName()	Get the login column name of user SQL table
Map<String,List<String>>	getMapping()	Get the field mapping
String	getPopulationId()	Get population Id
boolean	handleRightAssignmentContext()	Return true if a RightAssignmentContext should be automatically generated for the contents of this SCC
void	service(ServiceManager smanager)

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

_getNormalizedSearchResult, _getTotalCounParameters, _normalizeSearchResult, getTableName, getTotalCount, internalSearch

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

configureDataSource, configureSearchModel, getDataSourceId, getLocalAndExternalFields, getRemoteValues, putIdParameter

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

_addEditInputsForSCC, _editContent, _fillContent, _getContentsToRemove, _getEditInputs, _getEditInputsContextParameters, _handleContent, _importContent, _importOrSynchronizeContent, _importOrSynchronizeContent, _importOrSynchronizeContents, _importOrSynchronizeContents, _internalPopulate, _isHandled, _synchronizeContent, _transformRemoteValues, configure, createContentAction, getContent, getNotSynchronizedRelatedContentIds, getTransformedRemoteValues, importContent, populate, search, synchronizeContent, updateSyncInformations, validateContent

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

_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, getLanguages, 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

_userManager

protected UserManager _userManager

The user manager

_deleteUserComponent

protected DeleteUserComponent _deleteUserComponent

The delete user component

Constructor Details

SQLSynchronizableUsersCollection

public SQLSynchronizableUsersCollection()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SQLSynchronizableContentsCollection

Throws:

ServiceException

handleRightAssignmentContext

public boolean handleRightAssignmentContext()

Description copied from interface: SynchronizableContentsCollection

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

Returns:

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

getIdField

public String getIdField()

Description copied from interface: SynchronizableContentsCollection

Get the path of metadata holding the unique identifier

Specified by:

getIdField in interface SynchronizableContentsCollection

Overrides:

getIdField in class AbstractDataSourceSynchronizableContentsCollection

Returns:

the path to the metadata. Can be null.

getMapping

public Map<String,List<String>> getMapping()

Description copied from class: AbstractDataSourceSynchronizableContentsCollection

Get the field mapping

Overrides:

getMapping in class AbstractDataSourceSynchronizableContentsCollection

Returns:

The mapping

getLoginSQLColumnName

public String getLoginSQLColumnName()

Get the login column name of user SQL table

Returns:

The login column name of user SQL table

getPopulationId

public String getPopulationId()

Get population Id

Returns:

The population Id

_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

_checkIdObjectValue

protected boolean _checkIdObjectValue(String remoteKey,
 Object idObjectValue,
 Logger logger)

Description copied from class: SQLSynchronizableContentsCollection

Check if the id object value is correct

Overrides:

_checkIdObjectValue in class SQLSynchronizableContentsCollection

Parameters:

remoteKey - the remove key

idObjectValue - the id object value

logger - the logger

Returns:

true if the id object value is correct

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

_deleteContents

protected int _deleteContents(List<Content> contentsToRemove,
 Logger logger)

Description copied from class: AbstractSynchronizableContentsCollection

Delete contents.

Overrides:

_deleteContents in class AbstractSynchronizableContentsCollection

Parameters:

contentsToRemove - List of contents to remove

logger - The logger

Returns:

the number of deleted contents