org.sakaiproject.unboundid

Class StringUserTypeMapper

java.lang.Object

org.sakaiproject.unboundid.StringUserTypeMapper

All Implemented Interfaces:

UserTypeMapper

Direct Known Subclasses:

EmptyStringUserTypeMapper

public class StringUserTypeMapper
extends Object
implements UserTypeMapper

Very simple UserTypeMapper which generates the same String value for any users. Technically, this object could be reconfigured at any time.

Author:

dmccallum

Constructor Summary

Constructors

Constructor and Description
StringUserTypeMapper() Leaves the cached user type String initialized to null
StringUserTypeMapper(String userType) Sets the cached user type to the given String.

Method Summary

Modifier and Type	Method and Description
String	getUserType() Access the user type String to be returned from any invocation of mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).
String	mapLdapEntryToSakaiUserType(com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPEntry ldapEntry, LdapAttributeMapper mapper) Always returns the value set by setUserType(String).
void	setUserType(String userType) Set the user type String to be returned from any invocation of mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).

Methods inherited from class java.lang.Object

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

Constructor Detail

StringUserTypeMapper

public StringUserTypeMapper()

Leaves the cached user type String initialized to null

StringUserTypeMapper

public StringUserTypeMapper(String userType)

Sets the cached user type to the given String. Effectively the same as using the no-arg constructor, then invoking setUserType(String). No guarantees exist that this constructor will actually invoke that method, though.

Parameters:

userType - a user type String. null and empty Strings OK

Method Detail

mapLdapEntryToSakaiUserType

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

Always returns the value set by setUserType(String). Default is null

Specified by:

mapLdapEntryToSakaiUserType in interface UserTypeMapper

Parameters:

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

mapper - encapsulates mapping configuration

Returns:

the value cached by setUserType(String).

getUserType

public String getUserType()

Access the user type String to be returned from any invocation of mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).

Returns:

the cached user type String. Might be null or empty.

setUserType

public void setUserType(String userType)

Set the user type String to be returned from any invocation of mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper).

Parameters:

userType - a user type String. null and empty Strings OK