org.sakaiproject.component.imsent.user

Class IMSEntUserDirectoryProvider

java.lang.Object

org.sakaiproject.component.imsent.user.IMSEntUserDirectoryProvider

All Implemented Interfaces:

UserDirectoryProvider

public class IMSEntUserDirectoryProvider
extends Object
implements UserDirectoryProvider

IMSEntUserDirectoryProvider is a sample UserDirectoryProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IMSEntUserDirectoryProvider.SakaiIMSUser UserDirectoryProvider implementation

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_autoDdl Configuration: to run the ddl on init or not.
protected SqlService	m_sqlService Dependency: SqlService

Constructor Summary

Constructors

Constructor and Description
IMSEntUserDirectoryProvider() Construct.

Method Summary

Modifier and Type	Method and Description
boolean	authenticateUser(String userId, UserEdit edit, String password) Authenticate a user / password.
boolean	authenticateWithProviderFirst(String id)
void	destroy() Returns to uninitialized state.
boolean	findUserByEmail(UserEdit edit, String email) Find a user object who has this email address.
boolean	getUser(UserEdit edit) Access a user object.
void	getUsers(Collection users) Access a collection of UserEdit objects; if the user is found, update the information, otherwise remove the UserEdit object from the collection.
void	init() Final initialization, once all dependencies are set.
IMSEntUserDirectoryProvider.SakaiIMSUser	retrieveUser(String userId, boolean isEmail)
void	setAutoDdl(String value) Configuration: to run the ddl on init or not.
void	setSqlService(SqlService service) Dependency: SqlService.

Methods inherited from class java.lang.Object

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

Field Detail

m_sqlService

protected SqlService m_sqlService

Dependency: SqlService

m_autoDdl

protected boolean m_autoDdl

Configuration: to run the ddl on init or not.

Constructor Detail

IMSEntUserDirectoryProvider

public IMSEntUserDirectoryProvider()

Construct.

Method Detail

setSqlService

public void setSqlService(SqlService service)

Dependency: SqlService.

Parameters:

service - The SqlService.

setAutoDdl

public void setAutoDdl(String value)

Configuration: to run the ddl on init or not.

Parameters:

value - the auto ddl value.

init

public void init()

Final initialization, once all dependencies are set.

destroy

public void destroy()

Returns to uninitialized state. You can use this method to release resources thet your Service allocated when Turbine shuts down.

retrieveUser

public IMSEntUserDirectoryProvider.SakaiIMSUser retrieveUser(String userId,
                                                             boolean isEmail)

getUser

public boolean getUser(UserEdit edit)

Access a user object. Update the object with the information found.

Specified by:

getUser in interface UserDirectoryProvider

Parameters:

edit - The user object (id is set) to fill in.

Returns:

true if the user object was found and information updated, false if not.

getUsers

public void getUsers(Collection users)

Access a collection of UserEdit objects; if the user is found, update the information, otherwise remove the UserEdit object from the collection.

Specified by:

getUsers in interface UserDirectoryProvider

Parameters:

users - The UserEdit objects (with id set) to fill in or remove.

findUserByEmail

public boolean findUserByEmail(UserEdit edit,
                               String email)

Find a user object who has this email address. Update the object with the information found.

Specified by:

findUserByEmail in interface UserDirectoryProvider

Parameters:

email - The email address string.

Returns:

true if the user object was found and information updated, false if not.

authenticateUser

public boolean authenticateUser(String userId,
                                UserEdit edit,
                                String password)

Authenticate a user / password. If the user edit exists it may be modified, and will be stored if...

Specified by:

authenticateUser in interface UserDirectoryProvider

Parameters:

id - The user id.

edit - The UserEdit matching the id to be authenticated (and updated) if we have one.

password - The password.

Returns:

true if authenticated, false if not.

authenticateWithProviderFirst

public boolean authenticateWithProviderFirst(String id)

Specified by:

authenticateWithProviderFirst in interface UserDirectoryProvider