org.ametys.plugins.datasourcesexplorer

Class LDAPConnector

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.core.util.ldap.AbstractLDAPConnector

org.ametys.plugins.datasourcesexplorer.LDAPConnector

All Implemented Interfaces:

LogEnabled, Disposable, Initializable, Component, Serviceable

public class LDAPConnector
extends AbstractLDAPConnector
implements Component

Connection stuff to read ldap

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LDAPConnector.DN A DN

Field Summary

Fields

Modifier and Type	Field and Description
private static int	__LEVEL_SIZE
static String	ROLE The compoent 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
LDAPConnector()

Method Summary

Modifier and Type	Method and Description
protected int	_count(int pageSize, String name, String filter, Object[] filterArgs, SearchControls searchControls) Count the number of results
protected int	_count(LdapContext context) Ccount the child node of a cocntext
protected boolean	_hasResults(int pageSize, String name, String filter, Object[] filterArgs, SearchControls searchControls) Count the number of results
List<Map<String,String>>	getAttributes(String ldapDatasourceId, String dn) Get the ldap attributes of a node
Collection<LDAPConnector.DN>	getChildren(String ldapDatasourceId, String dn) Get children DN

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

_cleanup, _delayedInitialize, _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

The compoent role

__LEVEL_SIZE

private static final int __LEVEL_SIZE

See Also:

Constant Field Values

Constructor Detail

LDAPConnector

public LDAPConnector()

Method Detail

getAttributes

public List<Map<String,String>> getAttributes(String ldapDatasourceId,
                                              String dn)
                                       throws ProcessingException

Get the ldap attributes of a node

Parameters:

ldapDatasourceId - The ldap datasource id

dn - The dn of the ldap node to get

Returns:

The attributes

Throws:

ProcessingException - If an error occurred with ldap

getChildren

public Collection<LDAPConnector.DN> getChildren(String ldapDatasourceId,
                                                String dn)
                                         throws ProcessingException

Get children DN

Parameters:

ldapDatasourceId - The ldap datasource id

dn - The parent DN. Can be empty to get root DN.

Returns:

The children DNs

Throws:

ProcessingException - If an exception occurred while reading the ldap

_hasResults

protected boolean _hasResults(int pageSize,
                              String name,
                              String filter,
                              Object[] filterArgs,
                              SearchControls searchControls)
                       throws NamingException

Count the number of results

Parameters:

pageSize - The number of entries in a page

name - the name of the context or object to search

filter - the filter expression to use for the search

filterArgs - the array of arguments to substitute for the variables in filter. Can be null.

searchControls - the search controls that control the search.

Returns:

The number of results

Throws:

NamingException - If an error occurred

_count

protected int _count(LdapContext context)
              throws NamingException

Ccount the child node of a cocntext

Parameters:

context - The context

Returns:

The number of children

Throws:

NamingException - if an error occurred

_count

protected int _count(int pageSize,
                     String name,
                     String filter,
                     Object[] filterArgs,
                     SearchControls searchControls)
              throws NamingException

Count the number of results

Parameters:

pageSize - The number of entries in a page

name - the name of the context or object to search

filter - the filter expression to use for the search

filterArgs - the array of arguments to substitute for the variables in filter. Can be null.

searchControls - the search controls that control the search.

Returns:

The number of results

Throws:

NamingException - If an error occurred