org.sakaiproject.unboundid

Interface EidDerivedEmailAddressHandler

All Known Implementing Classes:

EmailAddressDerivingLdapAttributeMapper

public interface EidDerivedEmailAddressHandler

Mixin interface for objects capable of calculating a user EID from an email address. Commonly added to LdapAttributeMappers deployed against LDAP hosts which do not actually define email attributes on user entries.

Author:

dmccallum

See Also:

EmailAddressDerivingLdapAttributeMapper

Method Summary

Modifier and Type	Method and Description
String	unpackEidFromAddress(String email) Extract a user EID from the given email address.

Method Detail

unpackEidFromAddress

String unpackEidFromAddress(String email)
                     throws InvalidEmailAddressException

Extract a user EID from the given email address.

Parameters:

email - 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