Package org.sakaiproject.unboundid

Class EmailAddressDerivingLdapAttributeMapper

java.lang.Object

org.sakaiproject.unboundid.SimpleLdapAttributeMapper

org.sakaiproject.unboundid.EmailAddressDerivingLdapAttributeMapper

All Implemented Interfaces:

EidDerivedEmailAddressHandler, LdapAttributeMapper

public class EmailAddressDerivingLdapAttributeMapper
extends SimpleLdapAttributeMapper
implements EidDerivedEmailAddressHandler

Constructor Summary

Constructors

Constructor	Description
EmailAddressDerivingLdapAttributeMapper()

Method Summary

Modifier and Type	Method	Description
String	deriveAddressFromEid(String rawEid)	Calculate an email address from the given user EID.
protected String	doUnpackEidFromAddress(String address)	Calculates a user EID from an email address, assuming the address has already passed muster with validateAddress(String).
String	getAddressPattern()	Access the current email address validation pattern, as assigned by setAddressPattern(String).
String	getDefaultAddressDomain()	See setDefaultAddressDomain(String)
void	mapLdapEntryOntoUserData(com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPEntry ldapEntry, LdapUserData userData)	Performs LDAPEntry-to- attribute mappings.
void	setAddressPattern(String addressPattern)	Assign the Pattern against which strings passed to unpackEidFromAddress(String) must validate in order to be processed by doUnpackEidFromAddress(String)
void	setDefaultAddressDomain(String domain)	Assign the domain to be used when deriving email addresses from user EIDs.
String	unpackEidFromAddress(String address)	Returns doUnpackEidFromAddress(String) if the given email/code> string validates against validateAddress(String).
protected boolean	validateAddress(String address)	Validate the given string against the Pattern configured by setAddressPattern(String).

Methods inherited from class org.sakaiproject.unboundid.SimpleLdapAttributeMapper

escapeSearchFilterTerm, getAttributeMapping, getAttributeMappings, getFindUserByAidFilter, getFindUserByCrossAttributeSearchFilter, getFindUserByEidFilter, getFindUserByEmailFilter, getManyUsersInOneSearch, getReverseAttributeMap, getReverseAttributeMappings, getSearchResultAttributes, getUserBindDn, getUserDataDn, getUserTypeMapper, getValueMappings, init, mapLdapAttributeOntoUserData, mapLdapAttributeOntoUserData, 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

EmailAddressDerivingLdapAttributeMapper

public EmailAddressDerivingLdapAttributeMapper()

Method Detail

unpackEidFromAddress

public String unpackEidFromAddress(String address)
                            throws InvalidEmailAddressException

Returns doUnpackEidFromAddress(String) if the given email/code> string validates against validateAddress(String). Otherwise throws a . Throws the same exception type if doUnpackEidFromAddress(String) returns null or a whitespace string.

Specified by:

unpackEidFromAddress in interface EidDerivedEmailAddressHandler

Parameters:

address - and email address. Not necessarily guaranteed to be non-null or even contain valid email syntax

Returns:

an EID derived from the email argument

Throws:

InvalidEmailAddressException - if email cannot be processed for any reason. Implementation should raise this exception in any situation where it might otherwise return null

validateAddress

protected boolean validateAddress(String address)

Validate the given string against the Pattern configured by setAddressPattern(String). A null pattern has wildcard semantics.

Parameters:

address - an email address to be validated against some pattern, typically to verify that it belongs to an institutional domain

Returns:

doUnpackEidFromAddress

protected String doUnpackEidFromAddress(String address)

Calculates a user EID from an email address, assuming the address has already passed muster with validateAddress(String). This implementation strips all characters following the first occurance of '@' and returns the remaining characters.

Parameters:

address - a validated email address

Returns:

A user EID calculated from the given email address. This EID is not itself validated in any way. May return null or whitespace strings.

mapLdapEntryOntoUserData

public void mapLdapEntryOntoUserData(com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPEntry ldapEntry,
                                     LdapUserData userData)

Description copied from class: SimpleLdapAttributeMapper

Performs LDAPEntry-to- attribute mappings. Assigns the given LDAPEntry's DN to the LdapUserData as a property keyed by AttributeMappingConstants.USER_DN_PROPERTY. Then iterates over LDAPEntry.getAttributeSet(), handing each attribute to SimpleLdapAttributeMapper.mapLdapAttributeOntoUserData(LDAPAttribute, LdapUserData, Collection). Then enforces the preferred first name field, if it exists. Finally, assigns a "type" to the LdapUserData as defined by SimpleLdapAttributeMapper.mapLdapEntryToSakaiUserType(LDAPEntry).

Specified by:

mapLdapEntryOntoUserData in interface LdapAttributeMapper

Overrides:

mapLdapEntryOntoUserData in class SimpleLdapAttributeMapper

Parameters:

ldapEntry - the user's directory entry

userData - target LdapUserData

See Also:

UserTypeMapper

deriveAddressFromEid

public String deriveAddressFromEid(String rawEid)

Calculate an email address from the given user EID. This implementation simply appends the "@" delim and the domain configured by setDefaultAddressDomain(String). If that value is null, or the inbound eid is null or whitespace, simply returns null

Parameters:

string -

Returns:

getAddressPattern

public String getAddressPattern()

Access the current email address validation pattern, as assigned by setAddressPattern(String).

Returns:

a string representation of the currently cached Pattern. May return null

setAddressPattern

public void setAddressPattern(String addressPattern)

Assign the Pattern against which strings passed to unpackEidFromAddress(String) must validate in order to be processed by doUnpackEidFromAddress(String)

Parameters:

addressPattern - a string to compile into a Pattern. Compilation errors are raised immediately without modifications to any already-assigned pattern. nulls accepted and have wildcard semantics.

getDefaultAddressDomain

public String getDefaultAddressDomain()

See setDefaultAddressDomain(String)

setDefaultAddressDomain

public void setDefaultAddressDomain(String domain)

Assign the domain to be used when deriving email addresses from user EIDs. This is distinct from the pattern configured by setAddressPattern(String), so there could in fact be many domains from which an EID could be unpacked, but only one domain in which EID-derived email addresses will be created. This behavior can technically be overridden in deriveEmailFromEid(String).

Parameters:

object - some email domain. Not validated. May be null.