Package org.sakaiproject.unboundid

Class MultipleEmailLdapAttributeMapper

java.lang.Object

org.sakaiproject.unboundid.SimpleLdapAttributeMapper

org.sakaiproject.unboundid.MultipleEmailLdapAttributeMapper

All Implemented Interfaces:

LdapAttributeMapper

public class MultipleEmailLdapAttributeMapper
extends SimpleLdapAttributeMapper

Adds support for finding users by email address where users may have email addresses stored across multiple LDAP attributes.

Thanks to Erik Froese of NYU for the original patch

Author:

dmccallum@unicon.net

Constructor Summary

Constructors

Constructor	Description
MultipleEmailLdapAttributeMapper()

Method Summary

Modifier and Type	Method	Description
protected StringBuilder	appendSingleSearchPredicate(StringBuilder into, String physicalAttrName, String rawSearchTerm)
String	getFindUserByEmailFilter(String emailAddr)	Builds a filter of the form <email-attr>=<emailAddr>
List<String>	getSearchableEmailAttributes()	Access the list of logical attribute names searched when locating a user entry by email address.
void	setSearchableEmailAttributes(List<String> searchableEmailAttributes)	Assign the list of logical attribute names to search when locating a user entry by email address.

Methods inherited from class org.sakaiproject.unboundid.SimpleLdapAttributeMapper

escapeSearchFilterTerm, getAttributeMapping, getAttributeMappings, getFindUserByAidFilter, getFindUserByCrossAttributeSearchFilter, getFindUserByEidFilter, getManyUsersInOneSearch, getReverseAttributeMap, getReverseAttributeMappings, getSearchResultAttributes, getUserBindDn, getUserDataDn, getUserTypeMapper, getValueMappings, init, mapLdapAttributeOntoUserData, mapLdapAttributeOntoUserData, mapLdapEntryOntoUserData, mapLdapEntryToSakaiUserType, mapUserDataOntoUserEdit, reverseAttributeMap, setAttributeMappings, setUserDataDn, setUserTypeMapper, setValueMappings, usePreferredFirstName

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipleEmailLdapAttributeMapper

public MultipleEmailLdapAttributeMapper()

Method Detail

getSearchableEmailAttributes

public List<String> getSearchableEmailAttributes()

Access the list of logical attribute names searched when locating a user entry by email address.

Returns:

a list of logical LDAP attribute names. Will not return null

getFindUserByEmailFilter

public String getFindUserByEmailFilter(String emailAddr)

Description copied from class: SimpleLdapAttributeMapper

Builds a filter of the form <email-attr>=<emailAddr>

Specified by:

getFindUserByEmailFilter in interface LdapAttributeMapper

Overrides:

getFindUserByEmailFilter in class SimpleLdapAttributeMapper

Parameters:

emailAddr - an email address to search on

Returns:

an LDAP search filter

appendSingleSearchPredicate

protected StringBuilder appendSingleSearchPredicate(StringBuilder into,
                                                    String physicalAttrName,
                                                    String rawSearchTerm)

setSearchableEmailAttributes

public void setSearchableEmailAttributes(List<String> searchableEmailAttributes)

Assign the list of logical attribute names to search when locating a user entry by email address. If null, will have the effect of clearing the current attribute list. Note that this configuration option has no bearing on the email address which will be mapped to UserEdit.email

Parameters:

searchableEmailAttributes - a list of logical attribute names. null treated like an empty list.