org.sakaiproject.unboundid

Interface UserTypeMapper

All Known Implementing Classes:

EmptyStringUserTypeMapper, EntryAttributeToUserTypeMapper, EntryContainerRdnToUserTypeMapper, StringUserTypeMapper

public interface UserTypeMapper

Represents a pluggable strategy for calculating a Sakai user type given a user's directory entry

Author:

Dan McCallum, Unicon Inc

Method Summary

Modifier and Type	Method and Description
String	mapLdapEntryToSakaiUserType(com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPEntry ldapEntry, LdapAttributeMapper mapper) Calculate a Sakai user type given a LDAPEntry and a LdapAttributeMapper.

Method Detail

mapLdapEntryToSakaiUserType

String mapLdapEntryToSakaiUserType(com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPEntry ldapEntry,
                                   LdapAttributeMapper mapper)

Calculate a Sakai user type given a LDAPEntry and a LdapAttributeMapper.

Parameters:

ldapEntry - a user's LDAPEntry, should not be null

mapper - encapsulates mapping configuration

Returns:

a Sakai user type symbolic String, nulls and empty Strings typically represent an unsuccessful mapping