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

Class LDAPCollectionHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.util.ldap.AbstractLDAPConnector

org.ametys.plugins.contentio.synchronize.impl.LDAPCollectionHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class LDAPCollectionHelper
extends AbstractLDAPConnector
implements Component

Helper component for SynchronizableContentsCollections which need to access a LDAP

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	LDAPCollectionHelper.LDAPCollectionHelperSearchResult	Results of search(String, String, String, String, int, int, Map, String, Logger, String)

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeEP	The content type extension point
static final String	ROLE	Avalon Role

Fields inherited from class org.ametys.core.util.ldap.AbstractLDAPConnector

__PAGE_SIZE, _ldapAdminPassword, _ldapAdminRelativeDN, _ldapAliasDerefMode, _ldapAuthenticationMethod, _ldapBaseDN, _ldapFollowReferrals, _ldapUrl, _ldapUseSSL, _pagingSupported, _serverSideSorting

Constructor Summary

Constructors

Constructor	Description
LDAPCollectionHelper()

Method Summary

Modifier and Type	Method	Description
protected Object	_getIdValue(String idKey, SearchResult entry, Logger logger)	Gets id value from a ldap entry
protected int	_getScope(String scopeStr)	Get the scope as an integer (handlable by the SearchControls) from the scope string.
protected SearchControls	_getSearchControls(Map<String,List<String>> mapping, String searchScope)	Get the LDAP search controls.
LDAPCollectionHelper.LDAPCollectionHelperSearchResult	search(String collectionId, String relativeDN, String filter, String searchScope, int offset, int limit, Map<String,List<String>> mapping, String idKey, Logger logger, String dataSourceId)	Search over the LDAP the data from the filter.
void	service(ServiceManager serviceManager)
void	transformTypedAttributes(Map<String,Map<String,List<Object>>> results, String contentTypeId, Set<String> allAttributes)	Transform date and datetime attributes on each result line from timestamp to LocalDate (date) or ZonedDateTime (datetime)

Methods inherited from class org.ametys.core.util.ldap.AbstractLDAPConnector

_cleanup, _delayedInitialize, _getConfigParameter, _getContextEnv, _getFilter, _getRootContextEnv, _getSearchScope, _hasMoreEntries, _isPagingSupported, _search, _search, _search, _search, _setResultsControls, _testConnectionsPooled, _testPagingSupported, getSortByFields

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

Avalon Role

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

The content type extension point

Constructor Details

LDAPCollectionHelper

public LDAPCollectionHelper()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractLDAPConnector

Throws:

ServiceException

search

public LDAPCollectionHelper.LDAPCollectionHelperSearchResult search(String collectionId,
 String relativeDN,
 String filter,
 String searchScope,
 int offset,
 int limit,
 Map<String,List<String>> mapping,
 String idKey,
 Logger logger,
 String dataSourceId)

Search over the LDAP the data from the filter.

Parameters:

collectionId - The id of the collection being synchronized

relativeDN - the name of the context or object to search

filter - the filter expression to use for the search

searchScope - The search scope

offset - Begin of the search

limit - Number of results

mapping - The mapping for retrieving the remote values (keys are metadata paths)

idKey - The key where to search the id value of the content

logger - The logger

dataSourceId - the datasource id

Returns:

A map containing the content ids (keys) to import with their remote values (key is attribute, value is the remote value).

_getSearchControls

protected SearchControls _getSearchControls(Map<String,List<String>> mapping,
 String searchScope)
                                     throws ProcessingException

Get the LDAP search controls.

Parameters:

mapping - The mapping

searchScope - The search scope

Returns:

the search controls.

Throws:

ProcessingException - if the scope is not valid

_getScope

protected int _getScope(String scopeStr)
                 throws ProcessingException

Get the scope as an integer (handlable by the SearchControls) from the scope string.

Parameters:

scopeStr - the scope string.

Returns:

the scope as an integer.

Throws:

ProcessingException - if the given scope is not valid

_getIdValue

protected Object _getIdValue(String idKey,
 SearchResult entry,
 Logger logger)
                      throws NamingException

Gets id value from a ldap entry

Parameters:

idKey - The key where to search the id value

entry - The ldap entry

logger - The logger

Returns:

The attribute value

Throws:

NamingException - if a ldap query error occurred

transformTypedAttributes

public void transformTypedAttributes(Map<String,Map<String,List<Object>>> results,
 String contentTypeId,
 Set<String> allAttributes)

Transform date and datetime attributes on each result line from timestamp to LocalDate (date) or ZonedDateTime (datetime)

Parameters:

results - The results from LDAP source

contentTypeId - Content type ID from which attributes come from

allAttributes - All mapped attributes