org.apereo.services.persondir.support.ldap

Class LdaptivePersonAttributeDao

java.lang.Object

org.apereo.services.persondir.support.BasePersonAttributeDao

org.apereo.services.persondir.support.AbstractFlatteningPersonAttributeDao

org.apereo.services.persondir.support.AbstractDefaultAttributePersonAttributeDao

org.apereo.services.persondir.support.AbstractQueryPersonAttributeDao<org.ldaptive.SearchFilter>

org.apereo.services.persondir.support.ldap.LdaptivePersonAttributeDao

All Implemented Interfaces:

java.lang.Comparable<IPersonAttributeDao>, IPersonAttributeDao

public class LdaptivePersonAttributeDao
extends AbstractQueryPersonAttributeDao<org.ldaptive.SearchFilter>

Person directory IPersonAttribute implementation that queries an LDAP directory with ldaptive components to populate person attributes.

Since:

4.0.0

Author:

Marvin S. Addison

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger Logger instance.

Fields inherited from class org.apereo.services.persondir.support.AbstractQueryPersonAttributeDao

DEFAULT_CASE_CANONICALIZATION_MODE, DEFAULT_USERNAME_CASE_CANONICALIZATION_MODE

Fields inherited from interface org.apereo.services.persondir.IPersonAttributeDao

WILDCARD, WILDCARD_PATTERN

Constructor Summary

Constructors

Constructor and Description
LdaptivePersonAttributeDao()

Method Summary

Modifier and Type	Method and Description
protected org.ldaptive.SearchFilter	appendAttributeToQuery(org.ldaptive.SearchFilter filter, java.lang.String attribute, java.util.List<java.lang.Object> values) Append the attribute and value to the queryBuilder.
protected java.util.List<IPersonAttributes>	getPeopleForQuery(org.ldaptive.SearchFilter filter, java.lang.String userName) Executes the query for the generated queryBuilder object and returns a list where each entry is a Map of attributes for a single IPersonAttributes.
void	initialize() Initializes the object after properties are set.
void	setBaseDN(java.lang.String dn) Sets the base DN of the LDAP search for attributes.
void	setConnectionFactory(org.ldaptive.ConnectionFactory connectionFactory) Sets the connection factory that produces LDAP connections on which searches occur.
void	setSearchControls(javax.naming.directory.SearchControls searchControls) Sets a number of parameters that control LDAP search semantics including search scope, maximum number of results retrieved, and search timeout.
void	setSearchFilter(java.lang.String filter) Sets the LDAP search filter used to query for person attributes.

Methods inherited from class org.apereo.services.persondir.support.AbstractQueryPersonAttributeDao

appendCanonicalizedAttributeToQuery, canonicalizeAttribute, generateQuery, getAvailableQueryAttributes, getCaseCanonicalizationLocale, getCaseInsensitiveQueryAttributes, getCaseInsensitiveResultAttributes, getConfiguredUserNameAttribute, getDefaultCaseCanonicalizationMode, getPeopleWithMultivaluedAttributes, getPossibleUserAttributeNames, getQueryAttributeMapping, getResultAttributeMapping, getUnmappedUsernameAttribute, getUsernameCaseCanonicalizationMode, isRequireAllQueryAttributes, isUseAllQueryAttributes, isUserNameAttributeConfigured, mapPersonAttributes, setCaseCanonicalizationLocale, setCaseInsensitiveQueryAttributes, setCaseInsensitiveQueryAttributesAsCollection, setCaseInsensitiveResultAttributes, setCaseInsensitiveResultAttributesAsCollection, setDefaultCaseCanonicalizationMode, setQueryAttributeMapping, setRequireAllQueryAttributes, setResultAttributeMapping, setUnmappedUsernameAttribute, setUseAllQueryAttributes, setUsernameCaseCanonicalizationMode

Methods inherited from class org.apereo.services.persondir.support.AbstractDefaultAttributePersonAttributeDao

getPerson, getUsernameAttributeProvider, setUsernameAttributeProvider, toSeedMap

Methods inherited from class org.apereo.services.persondir.support.AbstractFlatteningPersonAttributeDao

getPeople, toMultivaluedSeed

Methods inherited from class org.apereo.services.persondir.support.BasePersonAttributeDao

compareTo, flattenResults, getMultivaluedUserAttributes, getMultivaluedUserAttributes, getOrder, getUserAttributes, getUserAttributes, setOrder

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Logger instance.

Constructor Detail

LdaptivePersonAttributeDao

public LdaptivePersonAttributeDao()

Method Detail

setBaseDN

public void setBaseDN(java.lang.String dn)

Sets the base DN of the LDAP search for attributes.

Parameters:

dn - LDAP base DN of search.

setSearchFilter

public void setSearchFilter(java.lang.String filter)

Sets the LDAP search filter used to query for person attributes.

Parameters:

filter - Search filter of the form "(usernameAttribute={0})" where {0} and similar ordinal placeholders are replaced with query parameters.

setSearchControls

public void setSearchControls(javax.naming.directory.SearchControls searchControls)

Sets a number of parameters that control LDAP search semantics including search scope, maximum number of results retrieved, and search timeout.

Parameters:

searchControls - LDAP search controls.

setConnectionFactory

public void setConnectionFactory(org.ldaptive.ConnectionFactory connectionFactory)

Sets the connection factory that produces LDAP connections on which searches occur. It is strongly recommended that this be a PooledConnecitonFactory object.

Parameters:

connectionFactory - LDAP connection factory.

initialize

@PostConstruct
public void initialize()

Initializes the object after properties are set.

getPeopleForQuery

protected java.util.List<IPersonAttributes> getPeopleForQuery(org.ldaptive.SearchFilter filter,
                                                              java.lang.String userName)

Description copied from class: AbstractQueryPersonAttributeDao

Executes the query for the generated queryBuilder object and returns a list where each entry is a Map of attributes for a single IPersonAttributes.

Specified by:

getPeopleForQuery in class AbstractQueryPersonAttributeDao<org.ldaptive.SearchFilter>

Parameters:

filter - The query generated by calls to AbstractQueryPersonAttributeDao.appendAttributeToQuery(Object, String, List)

userName - The username passed in the query map, if no username attribute existed in the query Map null is provided.

Returns:

The list of IPersons found by the query. The user attributes should be using the raw names from the data layer.

appendAttributeToQuery

protected org.ldaptive.SearchFilter appendAttributeToQuery(org.ldaptive.SearchFilter filter,
                                                           java.lang.String attribute,
                                                           java.util.List<java.lang.Object> values)

Description copied from class: AbstractQueryPersonAttributeDao

Append the attribute and value to the queryBuilder.

Specified by:

appendAttributeToQuery in class AbstractQueryPersonAttributeDao<org.ldaptive.SearchFilter>

Parameters:

filter - The sub-class specific query builder object

attribute - The full attribute name to append

values - The values for the data attribute

Returns:

An updated queryBuilder