Package org.ametys.plugins.contentio.synchronize.impl

Class LDAPSynchronizableContentsCollection

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

All Implemented Interfaces:

SynchronizableContentsCollection, Component, Configurable, Serviceable

Direct Known Subclasses:

LDAPSynchronizableUsersCollection, PersonSynchronizableContentsCollection

public class LDAPSynchronizableContentsCollection
extends AbstractDataSourceSynchronizableContentsCollection
implements Component

Implementation of SynchronizableContentsCollection to be synchronized with a LDAP data source

Field Summary

Fields

Modifier and Type	Field	Description
protected LDAPCollectionHelper	_ldapHelper	The helper for LDAP connection
protected int	_pageSize	The page size

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

Method Summary

Modifier and Type	Method	Description
protected void	configureDataSource(Configuration configuration)	Configure the data source parameters.
protected void	configureSearchModel()	Configure the search model used by SCCSearchTool.
protected String	getFilter()	Get the LDAP filter
protected String	getRelativeDN()	Get the LDAP relative DN
protected Map<String,Map<String,List<Object>>>	getRemoteValues(Map<String,Object> searchParameters, Logger logger)	Search values and return the result organized by attributes
protected String	getSearchScope()	Get the scope for LDAP search
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.
void	service(ServiceManager serviceManager)

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

getDataSourceId, getIdField, getLocalAndExternalFields, getMapping, putIdParameter

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

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

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

_deleteContents, _getAdditionalInputsForContentCreation, _getContentPathQuery, _getExpressionsList, _hasSomethingChanged, _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, handleRightAssignmentContext

Field Details

_pageSize

protected int _pageSize

The page size

_ldapHelper

protected LDAPCollectionHelper _ldapHelper

The helper for LDAP connection

Constructor Details

LDAPSynchronizableContentsCollection

public LDAPSynchronizableContentsCollection()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractDataSourceSynchronizableContentsCollection

Throws:

ServiceException

configureDataSource

protected void configureDataSource(Configuration configuration)
                            throws ConfigurationException

Description copied from class: AbstractStaticSynchronizableContentsCollection

Configure the data source parameters.

Overrides:

configureDataSource in class AbstractDataSourceSynchronizableContentsCollection

Parameters:

configuration - Configuration to read

Throws:

ConfigurationException - If an error occurs

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.

getSearchScope

protected String getSearchScope()

Get the scope for LDAP search

Returns:

The scope

getFilter

protected String getFilter()

Get the LDAP filter

Returns:

the filter

getRelativeDN

protected String getRelativeDN()

Get the LDAP relative DN

Returns:

the relative DN

configureSearchModel

protected void configureSearchModel()

Description copied from class: AbstractStaticSynchronizableContentsCollection

Configure the search model used by SCCSearchTool.

Overrides:

configureSearchModel in class AbstractDataSourceSynchronizableContentsCollection

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

Overrides:

getRemoteValues in class AbstractDataSourceSynchronizableContentsCollection

Parameters:

searchParameters - Search parameters to restrict the search

logger - The logger

Returns:

Map of results organized by attributes.