org.ametys.plugins.contentio.synchronize.impl

Class LDAPCollectionHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.util.CachingComponent<Object>

org.ametys.core.util.ldap.AbstractLDAPConnector

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

All Implemented Interfaces:

LogEnabled, Disposable, Initializable, Component, Serviceable

public class LDAPCollectionHelper
extends AbstractLDAPConnector
implements Component

Helper component for SynchronizableContentsCollections which need to access a LDAP

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	_hasGlobalError
private int	_nbError
static String	ROLE Avalon Role

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

__DEFAULT_PAGE_SIZE, _ldapAdminPassword, _ldapAdminRelativeDN, _ldapAliasDerefMode, _ldapAuthenticationMethod, _ldapBaseDN, _ldapFollowReferrals, _ldapUrl, _ldapUseSSL, _pagingSupported

Constructor Summary

Constructors

Constructor and Description
LDAPCollectionHelper()

Method Summary

Modifier and Type	Method and Description
protected void	_cleanup(Context context, NamingEnumeration result, Logger logger) Clean a connection to a ldap server.
void	_delayedInitialize(String dataSourceId) Call this method with the datasource id to initialize this component
protected Map<String,List<Object>>	_getAttributes(SearchResult entry, Map<String,List<String>> mapping) Gets attributes from a ldap entry.
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.
int	getNbErrors() Returns the number of errors which occured search(String, int, String, String, String, Map, String, Logger)
boolean	hasGlobalError() Returns true if the a global error occured during search(String, int, String, String, String, Map, String, Logger)
Map<String,Map<String,List<Object>>>	search(String collectionId, int pageSize, String relativeDN, String filter, String searchScope, Map<String,List<String>> mapping, String idKey, Logger logger) Search over the LDAP the contents to import.

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

_cleanup, _getConfigParameter, _getContextEnv, _getFilter, _getRootContextEnv, _getSearchScope, _search, _search, _setPagingIfSupported, _testPagingSupported, isPagingSupported, service

Methods inherited from class org.ametys.core.util.CachingComponent

addObjectInCache, clearCache, dispose, getObjectFromCache, initialize, isCacheEnabled, removeObjectFromCache

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 Detail

ROLE

public static final String ROLE

Avalon Role

_nbError

private int _nbError

_hasGlobalError

private boolean _hasGlobalError

Constructor Detail

LDAPCollectionHelper

public LDAPCollectionHelper()

Method Detail

_delayedInitialize

public void _delayedInitialize(String dataSourceId)
                        throws Exception

Description copied from class: AbstractLDAPConnector

Call this method with the datasource id to initialize this component

Overrides:

_delayedInitialize in class AbstractLDAPConnector

Parameters:

dataSourceId - The id of the datasource

Throws:

Exception - If an error occurs.

search

public Map<String,Map<String,List<Object>>> search(String collectionId,
                                                   int pageSize,
                                                   String relativeDN,
                                                   String filter,
                                                   String searchScope,
                                                   Map<String,List<String>> mapping,
                                                   String idKey,
                                                   Logger logger)

Search over the LDAP the contents to import. After calling this method, call the methods getNbErrors() and hasGlobalError() to know about error which occured.

Parameters:

collectionId - The id of the collection being synchronized

pageSize - The page size for the search

relativeDN - the name of the context or object to search

filter - the filter expression to use for the search

searchScope - The search scope

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

Returns:

A map containing the content ids (keys) to import with their metadata remote values (key is metadata path, value is the list of remote values for this metadata).

getNbErrors

public int getNbErrors()

Returns the number of errors which occured search(String, int, String, String, String, Map, String, Logger)

Returns:

the number of errors which occured search(String, int, String, String, String, Map, String, Logger)

hasGlobalError

public boolean hasGlobalError()

Returns true if the a global error occured during search(String, int, String, String, String, Map, String, Logger)

Returns:

true if the a global error occured during search(String, int, String, String, String, Map, String, Logger)

_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

_getAttributes

protected Map<String,List<Object>> _getAttributes(SearchResult entry,
                                                  Map<String,List<String>> mapping)
                                           throws NamingException

Gets attributes from a ldap entry.

Parameters:

entry - The ldap entry

mapping - The mapping

Returns:

The attributes in a map

Throws:

NamingException - if a ldap query error occured

_cleanup

protected void _cleanup(Context context,
                        NamingEnumeration result,
                        Logger logger)

Clean a connection to a ldap server.

Parameters:

context - The connection to the database to close.

result - The result to close.

logger - The logger