org.bonitasoft.engine.api

Interface UserAPI

All Known Subinterfaces:

IdentityAPI

public interface UserAPI

Author:

Feng Hui, Matthieu Chaffotte, Celine Souchet

Method Summary

Methods

Modifier and Type	Method and Description
User	createUser(String userName, String password) Creates a user.
User	createUser(String userName, String password, String firstName, String lastName) Creates a user.
User	createUser(UserCreator creator) Creates a user.
void	deleteUser(long userId) Deletes the user.
void	deleteUser(String userName) Deletes the user.
void	deleteUsers(List<Long> userIds) Deletes the users.
long	getNumberOfUsers() Returns the total number of users.
long	getNumberOfUsersInGroup(long groupId) Returns the total number of users of the group.
long	getNumberOfUsersInRole(long roleId) Returns the total number of users of the role.
User	getUser(long userId) Retrieves the user.
User	getUserByUserName(String userName) Retrieves the user.
ContactData	getUserContactData(long userId, boolean personal) Retrieves the contact data (personal or professional) of the user.
List<User>	getUsers(int startIndex, int maxResults, UserCriterion criterion) Retrieves the paginated list of users.
Map<Long,User>	getUsers(List<Long> userIds) Retrieves the users.
List<User>	getUsersInGroup(long groupId, int startIndex, int maxResults, UserCriterion criterion) Retrieves the paginated list of groups.
List<User>	getUsersInRole(long roleId, int startIndex, int maxResults, UserCriterion criterion) Retrieves the paginated list of roles.
SearchResult<User>	searchUsers(SearchOptions options) Searches users according to the criteria containing in the options.
User	updateUser(long userId, UserUpdater updater) Updates the user according to the updater values.

Method Detail

createUser

User createUser(String userName,
              String password)
                throws AlreadyExistsException,
                       CreationException

Creates a user. The password can be empty.

Parameters:

userName - the name of the user

password - the password of the user

Returns:

the created user

Throws:

AlreadyExistsException - If the name is already taken by an existing user

CreationException - If an exception occurs during the user creation

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

createUser

User createUser(String userName,
              String password,
              String firstName,
              String lastName)
                throws AlreadyExistsException,
                       CreationException

Creates a user. The password can be empty.

Parameters:

userName - the name of the user

password - the password of the user

firstName - the first name of the user

lastName - the last name of the user

Returns:

the created user

Throws:

AlreadyExistsException - If the name is already taken by an existing user

CreationException - If an exception occurs during the user creation

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

createUser

User createUser(UserCreator creator)
                throws AlreadyExistsException,
                       CreationException

Creates a user. It takes the values of the creator in order to create the user.

Parameters:

creator - the user to create

Returns:

the created user

Throws:

AlreadyExistsException - If the name is already taken by an existing user

CreationException - If an exception occurs during the user creation

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

updateUser

User updateUser(long userId,
              UserUpdater updater)
                throws UserNotFoundException,
                       UpdateException

Updates the user according to the updater values.

Parameters:

userId - the identifier of the user

updater - the user updater

Returns:

the updated user

Throws:

UserNotFoundException - If the user identifier does not refer to an existing user

UpdateException - If an exception occurs during the user update

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

deleteUser

void deleteUser(long userId)
                throws DeletionException

Deletes the user.

Parameters:

userId - the identifier of the user

Throws:

DeletionException - If an exception occurs during the user deletion

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

deleteUser

void deleteUser(String userName)
                throws DeletionException

Deletes the user.

Parameters:

userName - the name of the user

Throws:

DeletionException - If an exception occurs during the user deletion

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

deleteUsers

void deleteUsers(List<Long> userIds)
                 throws DeletionException

Deletes the users.

Parameters:

userIds - the identifiers of the users

Throws:

DeletionException - If an exception occurs during the user deletion

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getUser

User getUser(long userId)
             throws UserNotFoundException

Retrieves the user. It throws a UserNotFoundException if the user identifier equals the technical user identifier (-1).

Parameters:

userId - the identifier of the user

Returns:

the searched user

Throws:

UserNotFoundException - If the user identifier does not refer to an existing user

RetrieveException - If an exception occurs during the user retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getUserByUserName

User getUserByUserName(String userName)
                       throws UserNotFoundException

Retrieves the user.

Parameters:

userName - the name of the user

Returns:

the role

Throws:

UserNotFoundException - If the user name does not refer to an existing user

RetrieveException - If an exception occurs during the role retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getUserContactData

ContactData getUserContactData(long userId,
                             boolean personal)
                               throws UserNotFoundException

Retrieves the contact data (personal or professional) of the user.

Parameters:

userId - the identifier of the user

personal - true if the contact data is the personal one

Returns:

the contact data

Throws:

UserNotFoundException - If the user name does not refer to an existing user

RetrieveException - If an exception occurs during the role retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getNumberOfUsers

long getNumberOfUsers()

Returns the total number of users.

Returns:

the total number of users

Throws:

RetrieveException - If an exception occurs during the count retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getUsers

List<User> getUsers(int startIndex,
                  int maxResults,
                  UserCriterion criterion)

Retrieves the paginated list of users. It retrieves from the startIndex to the startIndex + maxResults.

Parameters:

startIndex - the start index

maxResults - the max number of users

criterion - the sorting criterion

Returns:

the paginated list of users

Throws:

RetrieveException - If an exception occurs during the user retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getUsers

Map<Long,User> getUsers(List<Long> userIds)

Retrieves the users. The map contains the couples userId/User. If a user does not exists, no exception is thrown and no value is added in the map.

Parameters:

userIds - the identifiers of the users

Returns:

the users

Throws:

RetrieveException - If an exception occurs during the user retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

searchUsers

SearchResult<User> searchUsers(SearchOptions options)
                               throws SearchException

Searches users according to the criteria containing in the options.

Parameters:

options - the search criteria

Returns:

the search result

Throws:

SearchException - If an exception occurs during the user searching

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getNumberOfUsersInRole

long getNumberOfUsersInRole(long roleId)

Returns the total number of users of the role.

Parameters:

roleId - the identifier of the role

Returns:

the total number of users of the role

Throws:

RetrieveException - If an exception occurs during the count retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getUsersInRole

List<User> getUsersInRole(long roleId,
                        int startIndex,
                        int maxResults,
                        UserCriterion criterion)

Retrieves the paginated list of roles. It retrieves from the startIndex to the startIndex + maxResults.

Parameters:

roleId - the identifier of the role

startIndex - the start index

maxResults - the max number of roles

criterion - the sorting criterion

Returns:

the paginated list of roles

Throws:

RetrieveException - If an exception occurs during the role retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getNumberOfUsersInGroup

long getNumberOfUsersInGroup(long groupId)
                             throws BonitaException

Returns the total number of users of the group.

Parameters:

groupId - the identifier of the group

Returns:

the total number of users of the group

Throws:

RetrieveException - If an exception occurs during the count retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

BonitaException

Since:

6.0

getUsersInGroup

List<User> getUsersInGroup(long groupId,
                         int startIndex,
                         int maxResults,
                         UserCriterion criterion)

Retrieves the paginated list of groups. It retrieves from the startIndex to the startIndex + maxResults.

Parameters:

groupId - the identifier of the group

startIndex - the start index

maxResults - the max number of groups

criterion - the sorting criterion

Returns:

the paginated list of groups

Throws:

RetrieveException - If an exception occurs during the group retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0