edu.amc.sakai.user

Class EntryContainerRdnToUserTypeMapper

java.lang.Object

edu.amc.sakai.user.EntryContainerRdnToUserTypeMapper

All Implemented Interfaces:

UserTypeMapper

public class EntryContainerRdnToUserTypeMapper
extends Object
implements UserTypeMapper

Maps from a user entry's container's most-local RDN to a Sakai user type.

Author:

Dan McCallum, Unicon Inc

Constructor Summary

Constructors

Constructor and Description
EntryContainerRdnToUserTypeMapper()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getRdnToSakaiUserTypeMap() mapRdn(String,String)
boolean	isRecurseRdnIfNoMapping() mapRdn(String,String)
boolean	isReturnLiteralRdnValueIfNoMapping() mapRdn(String,String)
String	mapLdapEntryToSakaiUserType(com.novell.ldap.LDAPEntry ldapEntry, LdapAttributeMapper mapper) Returns the user type associated with a matching RDN encountered when iterating through the specified LDAPEntry's containing DN's RDNs.
protected String	mapRdn(String rdnType, String rdnValue) Applies the current mapping configuration to the recieved RDN value.
void	setRdnToSakaiUserTypeMap(Map<String,String> rdnToSakaiUserTypeMap) mapRdn(String,String)
void	setRecurseRdnIfNoMapping(boolean recurseRdnIfNoMapping) mapRdn(String,String)
void	setReturnLiteralRdnIfNoMapping(boolean returnLiteralRdnValueIfNoMapping) mapRdn(String,String)

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryContainerRdnToUserTypeMapper

public EntryContainerRdnToUserTypeMapper()

Method Detail

mapLdapEntryToSakaiUserType

public String mapLdapEntryToSakaiUserType(com.novell.ldap.LDAPEntry ldapEntry,
                                          LdapAttributeMapper mapper)

Returns the user type associated with a matching RDN encountered when iterating through the specified LDAPEntry's containing DN's RDNs. If recurseRdnIfNoMapping is false, the most local RDN will be used for matching. #mapRdn(String, String)) implements the actual value mapping.

Specified by:

mapLdapEntryToSakaiUserType in interface UserTypeMapper

Parameters:

ldapEntry - the user's LDAPEntry

mapper - a source of mapping configuration

Returns:

the entry's mapped RDN

mapRdn

protected String mapRdn(String rdnType,
                        String rdnValue)

Applies the current mapping configuration to the recieved RDN value. If no mapping exists, will return null unless the returnLiteralRdnValueIfNoMapping flag is raised, in which case the RDN value itself will be returned.

Parameters:

rdnType - the RDN's type, primarily for debugging purposes

rdnValue - the RDN value to map

Returns:

the mapped rdnValue

getRdnToSakaiUserTypeMap

public Map<String,String> getRdnToSakaiUserTypeMap()

mapRdn(String,String)

Returns:

the current RDN-to-Sakai user type map

setRdnToSakaiUserTypeMap

public void setRdnToSakaiUserTypeMap(Map<String,String> rdnToSakaiUserTypeMap)

mapRdn(String,String)

Parameters:

rdnToSakaiUserTypeMap - the RDN-to-Sakai user type map

isReturnLiteralRdnValueIfNoMapping

public boolean isReturnLiteralRdnValueIfNoMapping()

mapRdn(String,String)

setReturnLiteralRdnIfNoMapping

public void setReturnLiteralRdnIfNoMapping(boolean returnLiteralRdnValueIfNoMapping)

mapRdn(String,String)

isRecurseRdnIfNoMapping

public boolean isRecurseRdnIfNoMapping()

mapRdn(String,String)

setRecurseRdnIfNoMapping

public void setRecurseRdnIfNoMapping(boolean recurseRdnIfNoMapping)

mapRdn(String,String)