Package org.ametys.plugins.userdirectory.synchronize

Class LDAPSynchronizableUsersCollection

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

org.ametys.plugins.userdirectory.synchronize.LDAPSynchronizableUsersCollection

All Implemented Interfaces:

SynchronizableContentsCollection, Initializable, Component, Configurable, Serviceable

public class LDAPSynchronizableUsersCollection
extends LDAPSynchronizableContentsCollection

SQL synchronizable collection for users

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__PARAM_LDAP_TABLE_LOGIN
private static String	__PARAM_POPULATION_ID
protected DeleteUserComponent	_deleteUserComponent	The delete user component
protected UserManager	_userManager	The user manager
protected UserSCCHelper	_userSCCHelper	The user SCC helper

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

_ldapHelper, _pageSize

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, _synchronizingContentOperatorEP

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

_contentTypeEP, _currentUserProvider, _hasGlobalError, _i18nUtils, _nbCreatedContents, _nbDeletedContents, _nbError, _nbNotChangedContents, _nbSynchronizedContents, _observationManager, _synchroComponent, SCC_UNIQUE_ID

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

_contentDAO, _contentPrefix, _contentType, _id, _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_PROPERTY

Constructor Summary

Constructors

Constructor	Description
LDAPSynchronizableUsersCollection()

Method Summary

Modifier and Type	Method	Description
protected int	_deleteContents(List<Content> contentsToRemove, org.slf4j.Logger logger)	Delete contents.
protected boolean	_fillContent(Map<String,List<Object>> remoteValues, ModifiableDefaultContent content, boolean create, org.slf4j.Logger logger)	Fill the content with remote values.
String	getIdField()	Get the path of metadata holding the unique identifier
String	getLoginLDAPColumnName()	Get the login column name of user LDAP
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
protected Map<String,Map<String,Object>>	internalSearch(Map<String,Object> parameters, int offset, int limit, List<Object> sort, org.slf4j.Logger logger)	Search values and return the result without any treatment.
void	service(ServiceManager smanager)

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

configureDataSource, configureSearchModel, getFilter, getRelativeDN, getRemoteValues, getSearchScope, initialize

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

getDataSourceId, getExternalOnlyFields, getLocalAndExternalFields, putIdParameter

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

_getContentsToRemove, _getIdFieldValue, _handleContent, _importContent, _importOrSynchronizeContent, _importOrSynchronizeContent, _importOrSynchronizeContents, _internalPopulate, _isHandled, _synchronizeContent, additionalCommonOperations, additionalImportOperations, additionalSynchronizeOperations, configure, createContentAction, getContent, getTotalCount, getTransformedRemoteValues, importContent, populate, 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, deleteUnexistingContents, empty, 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

Field Detail

__PARAM_LDAP_TABLE_LOGIN

private static final String __PARAM_LDAP_TABLE_LOGIN

See Also:

Constant Field Values

__PARAM_POPULATION_ID

private static final String __PARAM_POPULATION_ID

See Also:

Constant Field Values

_userManager

protected UserManager _userManager

The user manager

_userSCCHelper

protected UserSCCHelper _userSCCHelper

The user SCC helper

_deleteUserComponent

protected DeleteUserComponent _deleteUserComponent

The delete user component

Constructor Detail

LDAPSynchronizableUsersCollection

public LDAPSynchronizableUsersCollection()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class LDAPSynchronizableContentsCollection

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

getLoginLDAPColumnName

public String getLoginLDAPColumnName()

Get the login column name of user LDAP

Returns:

The login column name of user LDAP

getPopulationId

public String getPopulationId()

Get population Id

Returns:

The population Id

_fillContent

protected boolean _fillContent(Map<String,List<Object>> remoteValues,
                               ModifiableDefaultContent content,
                               boolean create,
                               org.slf4j.Logger logger)

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Fill the content with remote values.

Overrides:

_fillContent in class AbstractSimpleSynchronizableContentsCollection

Parameters:

remoteValues - The remote values

content - The content to synchronize

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

logger - The logger

Returns:

true if changes were made

internalSearch

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

Description copied from class: AbstractSimpleSynchronizableContentsCollection

Search values and return the result without any treatment.

Overrides:

internalSearch in class LDAPSynchronizableContentsCollection

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.

_deleteContents

protected int _deleteContents(List<Content> contentsToRemove,
                              org.slf4j.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