org.exoplatform.services.organization

Interface UserHandler

public interface UserHandler

Created by The eXo Platform SAS
This interface is a sub part of the organization service. It is used to manage the user accounts and broadcast the user events to all the registered listeners in the organization service. The user event can be: new user event, update user event and delete user event. Each event should have 2 phases: pre event and post event. The method createUser , saveUser and removeUser broadcast the event at each phase so the listeners can handle the event properly

Author:

Tuan Nguyen

Level API:

Platform

Field Summary

Fields

Modifier and Type	Field and Description
static String	POST_CREATE_USER_EVENT
static String	POST_DELETE_USER_EVENT
static String	POST_UPDATE_USER_EVENT
static String	PRE_CREATE_USER_EVENT
static String	PRE_DELETE_USER_EVENT
static String	PRE_UPDATE_USER_EVENT

Method Summary

Methods

Modifier and Type	Method and Description
void	addUserEventListener(UserEventListener listener) This method is used to register an user event listener
boolean	authenticate(String username, String password) Check if the username and the password of an user is valid.
void	createUser(User user, boolean broadcast) This method is used to persist a new user object.
User	createUserInstance() Deprecated. This method create an User instance that implement the User interface. The user instance is not persisted yet
User	createUserInstance(String username) This method create an User instance that implement the User interface.
ListAccess<User>	findAllUsers() This method is used to get all the users in the database
User	findUserByName(String userName)
org.exoplatform.commons.utils.PageList<User>	findUsers(org.exoplatform.services.organization.Query query) Deprecated. use findUsersByQuery(Query) instead
org.exoplatform.commons.utils.PageList<User>	findUsersByGroup(String groupId) Deprecated. use findUsersByGroupId(String) instead
ListAccess<User>	findUsersByGroupId(String groupId) This method should search and return the list of the users in a given group.
ListAccess<User>	findUsersByQuery(org.exoplatform.services.organization.Query query) This method search for the users accordding to a search criteria, the query
org.exoplatform.commons.utils.PageList<User>	getUserPageList(int pageSize) Deprecated. use findAllUsers() instead
User	removeUser(String userName, boolean broadcast) Remove an user and broadcast the event to all the registerd listener.
void	removeUserEventListener(UserEventListener listener) This method is used to unregister an user event listener
void	saveUser(User user, boolean broadcast) This method is used to update an existing User object

Field Detail

PRE_DELETE_USER_EVENT

static final String PRE_DELETE_USER_EVENT

See Also:

Constant Field Values

POST_DELETE_USER_EVENT

static final String POST_DELETE_USER_EVENT

See Also:

Constant Field Values

PRE_CREATE_USER_EVENT

static final String PRE_CREATE_USER_EVENT

See Also:

Constant Field Values

POST_CREATE_USER_EVENT

static final String POST_CREATE_USER_EVENT

See Also:

Constant Field Values

PRE_UPDATE_USER_EVENT

static final String PRE_UPDATE_USER_EVENT

See Also:

Constant Field Values

POST_UPDATE_USER_EVENT

static final String POST_UPDATE_USER_EVENT

See Also:

Constant Field Values

Method Detail

createUserInstance

User createUserInstance()

Deprecated. This method create an User instance that implement the User interface. The user instance is not persisted yet

Returns:

User instance

createUserInstance

User createUserInstance(String username)

This method create an User instance that implement the User interface. The user instance is not persisted yet

Parameters:

username - Username for new user instance.

Returns:

the user object

createUser

void createUser(User user,
              boolean broadcast)
                throws Exception

This method is used to persist a new user object.

Parameters:

user - The user object to save

broadcast - If the broadcast value is true , then the UserHandler should broadcast the event to all the listener that register with the organization service. For example, the portal service register an user event listener with the organization service. when a new account is created, a portal configuration should be created for the new user account at the same time. In this case the portal user event listener will be called in the createUser method.

Throws:

Exception: - The exception can be throwed if the the UserHandler cannot persist the user object or any listeners fail to handle the user event.

Exception

saveUser

void saveUser(User user,
            boolean broadcast)
              throws Exception

This method is used to update an existing User object

Parameters:

user - The user object to update

broadcast - If the broadcast is true , then all the user event listener that register with the organization service will be called

Throws:

Exception - The exception can be throwed if the the UserHandler cannot save the user object or any listeners fail to handle the user event.

removeUser

User removeUser(String userName,
              boolean broadcast)
                throws Exception

Remove an user and broadcast the event to all the registerd listener. When the user is removed , the user profile and all the membershisp of the user should be removed as well.

Parameters:

userName - The user should be removed from the user database

broadcast - If broadcast is true, the the delete user event should be broadcasted to all registered listener

Returns:

return the User object after that user has beed removed from database

Throws:

Exception

findUserByName

User findUserByName(String userName)
                    throws Exception

Parameters:

userName - the user that the user handler should search for

Returns:

The method return null if there no user matchs the given username. The method return an User object if an user that mathch the username.

Throws:

Exception - The exception is throwed if the method fail to access the user database or more than one user object with the same username is found

findUsersByGroup

@Deprecated
org.exoplatform.commons.utils.PageList<User> findUsersByGroup(String groupId)
                                                              throws Exception

Deprecated. use findUsersByGroupId(String) instead

This method should search and return the list of the users in a given group.

Parameters:

groupId - id of the group. The return users list should be in this group

Returns:

return a page list iterator of a group of the user in the database

Throws:

Exception

findUsersByGroupId

ListAccess<User> findUsersByGroupId(String groupId)
                                    throws Exception

This method should search and return the list of the users in a given group.

Parameters:

groupId - id of the group. The return users list should be in this group

Returns:

return a page list iterator of a group of the user in the database

Throws:

Exception - any exception

getUserPageList

@Deprecated
org.exoplatform.commons.utils.PageList<User> getUserPageList(int pageSize)
                                                             throws Exception

Deprecated. use findAllUsers() instead

This method is used to get all the users in the database

Parameters:

pageSize - The number of user in each page

Returns:

return a page list iterator. The page list should allow the developer get all the users or get a page of users if the return number of users is too large.

Throws:

Exception

findAllUsers

ListAccess<User> findAllUsers()
                              throws Exception

This method is used to get all the users in the database

Returns:

return a page list iterator. The page list should allow the developer get all the users or get a page of users if the return number of users is too large.

Throws:

Exception - any exception

findUsers

@Deprecated
org.exoplatform.commons.utils.PageList<User> findUsers(org.exoplatform.services.organization.Query query)
                                                       throws Exception

Deprecated. use findUsersByQuery(Query) instead

This method search for the users accordding to a search criteria, the query

Parameters:

query - The query object contains the search criteria.

Returns:

return the found users in a page list according to the query.

Throws:

Exception - throw exception if the service cannot access the database

findUsersByQuery

ListAccess<User> findUsersByQuery(org.exoplatform.services.organization.Query query)
                                  throws Exception

This method search for the users accordding to a search criteria, the query

Parameters:

query - The query object contains the search criteria.

Returns:

return the found users in a page list according to the query.

Throws:

Exception - throw exception if the service cannot access the database

authenticate

boolean authenticate(String username,
                   String password)
                     throws Exception

Check if the username and the password of an user is valid.

Parameters:

username - the name of user to authenticate

password - the password of user to authenticate

Returns:

return true if the username and the password is match with an user record in the database, else return false.

Throws:

Exception - throw an exception if cannot access the database

addUserEventListener

void addUserEventListener(UserEventListener listener)

This method is used to register an user event listener

Parameters:

listener - the user event listener to register

removeUserEventListener

void removeUserEventListener(UserEventListener listener)

This method is used to unregister an user event listener

Parameters:

listener - the user event listener to unregister