IdentityServiceImpl (bonita-server 7.12.1 API)

java.lang.Object
- org.bonitasoft.engine.identity.impl.IdentityServiceImpl

All Implemented Interfaces:

IdentityService
```
public class IdentityServiceImpl
extends java.lang.Object
implements IdentityService
```
Default implementation of the Identity service

Author:

Baptiste Mesta, Matthieu Chaffotte, Bole Zhang, Hongwen Zang, Celine Souchet

Field Summary
- Fields inherited from interface org.bonitasoft.engine.identity.IdentityService
  CUSTOM_USER_INFO_DEFINITION, CUSTOM_USER_INFO_VALUE, GROUP, ICON, ROLE, USER, USER_CONTACT_INFO, USER_LOGIN, USERMEMBERSHIP

Constructor Summary

Constructors
Constructor and Description
`IdentityServiceImpl(ReadPersistenceService persistenceService, Recorder recorder, EventService eventService, TechnicalLoggerService logger, QueriableLoggerService queriableLoggerService, CredentialsEncrypter encrypter)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`checkCredentials(SUser user, java.lang.String password)` Checks whether the couple user/password is valid.
`SCustomUserInfoDefinition`	`createCustomUserInfoDefinition(SCustomUserInfoDefinition customUserInfo)` Create custom user info definition in DB for a server given custom user info definition
`SCustomUserInfoValue`	`createCustomUserInfoValue(SCustomUserInfoValue customUserInfo)` Create profileMetadataValue in DB for give profileMetadataValue object
`void`	`createGroup(SGroup group, java.lang.String iconFileName, byte[] iconContent)` Create group in DB for the given group object
`void`	`createRole(SRole role, java.lang.String iconFilename, byte[] iconContent)` Create role in DB for the given role
`SUser`	`createUser(SUser user)` Create `SUser` and store it to persistence layer
`SUser`	`createUser(SUser sUser, SContactInfo personalContactInfo, SContactInfo proContactInfo, java.lang.String iconFilename, byte[] iconContent)` create a new user in database along with its contact data
`SContactInfo`	`createUserContactInfo(SContactInfo contactInfo)` Create user contact information for given data
`void`	`createUserMembership(SUserMembership userMembership)` Create userMembership in DB for the given userMembership object
`SUser`	`createUserWithoutEncryptingPassword(SUser user)` Deprecated.
`void`	`deleteAllGroups()` Delete all groups for the connected tenant
`void`	`deleteAllRoles()` Delete all roles for the connected tenant
`void`	`deleteAllUserMemberships()` Delete all user memberships for the connected tenant
`void`	`deleteAllUsers()` Delete all users for the connected tenant
`java.util.List<java.lang.Long>`	`deleteChildrenGroup(long groupId)` delete children groups of the given group if there is some
`void`	`deleteCustomUserInfoDefinition(long customUserInfoDefinitionId)` Delete the id specified custom user info
`void`	`deleteCustomUserInfoDefinition(SCustomUserInfoDefinition info)` Delete the specific custom user info
`void`	`deleteCustomUserInfoValue(long customUserInfoValueId)` Delete the id specified profileMetadataValue
`void`	`deleteCustomUserInfoValue(SCustomUserInfoValue customUserInfo)` Delete the specific profileMetadataValue
`void`	`deleteGroup(long groupId)` Delete the id specified group
`void`	`deleteGroup(SGroup group)` Delete the specific group
`void`	`deleteLightUserMembership(SUserMembership userMembership)` Delete the specific light userMembership
`void`	`deleteRole(long roleId)` Delete the id specified role
`void`	`deleteRole(SRole role)` Delete the specific role
`void`	`deleteUser(long userId)` Delete user by its id
`void`	`deleteUser(SUser user)` Delete the specific user
`void`	`deleteUserMembership(long id)` Delete the id specified userMembership
`void`	`deleteUserMembership(SUserMembership userMembership)` Delete the specific userMembership
`java.util.List<SUser>`	`getActiveUsersInGroup(long groupId, int fromIndex, int numberOfUsers, java.lang.String field, OrderByType order)` Get a `List` of Active `SUser` for given `SGroup` from specific interval, sorted by field attribute in the given `OrderByType` order order.
`java.util.List<SUser>`	`getActiveUsersWithManager(long managerId, int fromIndex, int numberMaxOfUsers, java.lang.String field, OrderByType order)` Get all active users managed by a specific manager from a specific interval.
`java.util.List<SUser>`	`getActiveUsersWithRole(long roleId, int fromIndex, int numberOfUsers)` Get a `List` of active `SUser` from a specific interval for the given `SRole` identifier.
`java.util.List<SUser>`	`getActiveUsersWithRole(long roleId, int fromIndex, int numberOfUsers, java.lang.String field, OrderByType order)` Get a `List` of active `SUser` for given `SRole` from specific interval, sorted by field attribute in the given `OrderByType` order order.
`SCustomUserInfoDefinition`	`getCustomUserInfoDefinition(long customUserInfoDefinitionId)` Get `SCustomUserInfoDefinition` by its id
`SCustomUserInfoDefinition`	`getCustomUserInfoDefinitionByName(java.lang.String name)` Get a `SCustomUserInfoDefinition` by its name
`java.util.List<SCustomUserInfoDefinition>`	`getCustomUserInfoDefinitions(int fromIndex, int maxResults)` Get a `List` of `SCustomUserInfoDefinition` from specific interval
`java.util.List<SCustomUserInfoDefinition>`	`getCustomUserInfoDefinitions(java.util.List<java.lang.Long> customUserInfoDefinitionIds)` Get a `List` of `SCustomUserInfoDefinition` of the given identifiers
`SCustomUserInfoValue`	`getCustomUserInfoValue(long customUserInfoValueId)` Get `SCustomUserInfoValue` by its id
`java.util.List<SCustomUserInfoValue>`	`getCustomUserInfoValueOfUserAndDefinitions(long userId, java.util.List<java.lang.Long> definitionsIds)` Get SCustomUserInfoValues of definitions for a user
`java.util.List<SCustomUserInfoValue>`	`getCustomUserInfoValues(java.util.List<java.lang.Long> customUserInfoValueIds)` Get a `List` of `SCustomUserInfoValue` of the given identifiers
`SGroup`	`getGroup(long groupId)` Get `SGroup` by its identifier
`SGroup`	`getGroupByPath(java.lang.String groupPath)` Get the `SGroup` by its path
`java.util.List<SGroup>`	`getGroupChildren(long groupId, int fromIndex, int numberOfGroups)` Get a `List` child `SGroup` in a specific interval for specific group.
`java.util.List<SGroup>`	`getGroupChildren(long groupId, int fromIndex, int numberOfGroups, java.lang.String field, OrderByType order)` Get a `List` of child `SGroup` in specific interval, sorted by field attribute in the given `OrderByType` order.
`java.util.List<SGroup>`	`getGroups(int fromIndex, int numberOfGroups)` Get a `List` of `SGroup` in a specific interval, this is used for pagination If the number of existing results are lower than the number asked, all results from the given index are retrieved.
`java.util.List<SGroup>`	`getGroups(int fromIndex, int numberOfGroups, java.lang.String field, OrderByType order)` Get a `List` of `SGroup` in specific interval, sorted by field attribute in the given `OrderByType` order.
`java.util.List<SGroup>`	`getGroups(java.util.List<java.lang.Long> groupIds)` Get a `List` of `SGroup` for specific groupIds
`SIcon`	`getIcon(long id)` get the icon using its id
`java.util.List<SUser>`	`getInactiveUsersInGroup(long groupId, int fromIndex, int numberOfUsers, java.lang.String field, OrderByType order)` Get a `List` of Inactive `SUser` for given `SGroup` from specific interval, sorted by field attribute in the given `OrderByType` order order.
`java.util.List<SUser>`	`getInactiveUsersWithManager(long managerId, int fromIndex, int numberMaxOfUsers, java.lang.String field, OrderByType order)` Get all inactive users managed by a specific manager from a specific interval.
`java.util.List<SUser>`	`getInactiveUsersWithRole(long roleId, int fromIndex, int numberOfUsers)` Get a `List` of inactive `SUser` from a specific interval for the given `SRole` identifier.
`java.util.List<SUser>`	`getInactiveUsersWithRole(long roleId, int fromIndex, int numberOfUsers, java.lang.String field, OrderByType order)` Get a `List` of Inactive `SUser` for given `SRole` from specific interval, sorted by field attribute in the given `OrderByType` order order.
`SUserMembership`	`getLightUserMembership(long userMembershipId)` Get light userMembership by its id
`SUserMembership`	`getLightUserMembership(long userId, long groupId, long roleId)` Get the `SUserMembership` of the specific user, group and role without userName, groupName and roleName being set.
`java.util.List<SUserMembership>`	`getLightUserMemberships(int startIndex, int numberOfElements)` Get light userMembership in a specific interval, this is used for pagination
`long`	`getNumberOfCustomUserInfoDefinition()` Get total number of `SCustomUserInfoDefinition` of the current tenant
`long`	`getNumberOfCustomUserInfoValue(QueryOptions options)` Get total number of `SCustomUserInfoValue` of the current tenant matching the criterias of the given `QueryOptions`
`long`	`getNumberOfGroupChildren(long parentGroupId)` Get number of child groups for the group identified by the given id
`long`	`getNumberOfGroups()` Get total number of `SGroup` in the current tenant
`long`	`getNumberOfGroups(QueryOptions options)` Get total number of groups according to specific query options
`long`	`getNumberOfRoles()` Get total number of `SRole` for this tenant
`long`	`getNumberOfRoles(QueryOptions options)` Get total number of roles according to specific query options
`long`	`getNumberOfUserMemberships()` Get total number of userMemberships of the current tenant
`long`	`getNumberOfUserMembershipsOfUser(long userId)` Get total number of `SUserMembership` for a specific user
`long`	`getNumberOfUsers()` Get total number of `SUser` on the current tenant
`long`	`getNumberOfUsers(QueryOptions options)` Get total number of users according to specific query options
`long`	`getNumberOfUsersByGroup(long groupId)` Get total number of users for the given `SGroup`
`long`	`getNumberOfUsersByMembership(long groupId, long roleId)` Get total number of userMemberships contains specific group and role
`long`	`getNumberOfUsersByRole(long roleId)` Get total number of users for the given role on the current tenant
`SRole`	`getRole(long roleId)` Gets the `SRole` given by its identifier.
`SRole`	`getRoleByName(java.lang.String roleName)` Get the `SRole` given by its name.
`java.util.List<SRole>`	`getRoles(int fromIndex, int numberOfRoles)` Get a `List` of `SRole` in specific interval If the number of existing results are lower than the number asked, all results from the given index are retrieved.
`java.util.List<SRole>`	`getRoles(int fromIndex, int numberOfRoles, java.lang.String field, OrderByType order)` Get a `List` of `SRole` in specific interval, sorted by field attribute in the given `OrderByType` order.
`java.util.List<SRole>`	`getRoles(java.util.List<java.lang.Long> roleIds)` Get a `List` of `SRole` by their identifiers
`SUser`	`getUser(long userId)` Get `SUser` by its id
`SUser`	`getUserByUserName(java.lang.String userName)` Get `SUser` by its name
`SContactInfo`	`getUserContactInfo(long userId, boolean isPersonal)` Return the user contact info for a specific user.
`java.util.List<java.lang.Long>`	`getUserIdsWithCustomUserInfo(java.lang.String userInfoName, java.lang.String userInfoValue, boolean usePartialMatch, int fromIndex, int maxResults)` Retrieve a `List` of user identifiers from specific interval.
`SUserMembership`	`getUserMembership(long userMembershipId)` Get `SUserMembership` by given id
`SUserMembership`	`getUserMembership(long userId, long groupId, long roleId)` Get `SUserMembership` of specific `SUser`, `SGroup` and `SRole`
`java.util.List<SUserMembership>`	`getUserMemberships(int fromIndex, int numberOfUserMemberships)` Get a `List` of `SUserMembership` from specific interval
`java.util.List<SUserMembership>`	`getUserMemberships(int fromIndex, int numberOfResult, OrderByOption orderByOption)` Get a `List` of `SUserMembership` from specific interval, sorted by field attribute in the given `OrderByType` order order.
`java.util.List<SUserMembership>`	`getUserMemberships(java.util.List<java.lang.Long> userMembershipIds)` Get a `List` of `SUserMembership` of the given identifiers if they exists
`java.util.List<SUserMembership>`	`getUserMembershipsOfGroup(long groupId, int startIndex, int maxResults)` Get a `List` of `SUserMembership` for given group from specific interval
`java.util.List<SUserMembership>`	`getUserMembershipsOfRole(long roleId, int startIndex, int maxResults)` Get a `List` of `SUserMembership` for given role from specific interval
`java.util.List<SUserMembership>`	`getUserMembershipsOfUser(long userId, int fromIndex, int numberOfUsers)` Get `SUserMembership` for a specific interval for a given user
`java.util.List<SUserMembership>`	`getUserMembershipsOfUser(long userId, int fromIndex, int numberPerPage, OrderByOption orderByOption)` Get a `List` of `SUserMembership` of a given user from specific interval, sorted by default field in the given `OrderByType` sortOrder order.
`java.util.List<SUserMembership>`	`getUserMembershipsOfUser(long userId, int fromIndex, int numberOfMemberships, java.lang.String field, OrderByType order)` Get a `List` of `SUserMembership` of a given user from specific interval, sorted by field attribute in the given `OrderByType` sortOrder order.
`java.util.List<SUser>`	`getUsers(int fromIndex, int numberOfUsers)` Get a `List` of `SUser` from a specific interval.
`java.util.List<SUser>`	`getUsers(int fromIndex, int numberOfUsers, java.lang.String field, OrderByType order)` Get a `List` of child `SUser` from specific interval, sorted by field attribute in the given `OrderByType` order order.
`java.util.List<SUser>`	`getUsers(java.util.List<java.lang.Long> userIds)` Get `SUser` by their userIds
`java.util.List<SUser>`	`getUsersByUsername(java.util.List<java.lang.String> userNames)` retrieve a `List` of `SUser` from their names.
`java.util.List<SUser>`	`getUsersInGroup(long groupId, int fromIndex, int numberOfUsers, java.lang.String field, OrderByType order)` Get a `List` of `SUser` for given `SGroup` from specific interval, sorted by field attribute in the given `OrderByType` order order.
`java.util.List<SUser>`	`getUsersWithManager(long managerId, int fromIndex, int numberMaxOfUsers, java.lang.String field, OrderByType order)` Get all users (both active and inactive) managed by a specific manager from a specific interval.
`java.util.List<SUser>`	`getUsersWithRole(long roleId, int fromIndex, int numberOfUsers)` Get a `List` of `SUser` from a specific interval for the given `SRole` identifier.
`java.util.List<SUser>`	`getUsersWithRole(long roleId, int fromIndex, int numberOfUsers, java.lang.String field, OrderByType order)` Get a `List` of `SUser` for given `SRole` from specific interval, sorted by field attribute in the given `OrderByType` order order.
`boolean`	`hasCustomUserInfoDefinition(java.lang.String name)` Verify if there is a `SCustomUserInfoDefinition` of the given name
`java.util.List<SCustomUserInfoValue>`	`searchCustomUserInfoValue(QueryOptions options)` Search `SCustomUserInfoValue` matching the criterias of the given `QueryOptions`
`java.util.List<SGroup>`	`searchGroups(QueryOptions options)` Search groups according to specific query options
`java.util.List<SRole>`	`searchRoles(QueryOptions options)` Search roles according to specific query options
`java.util.List<SUser>`	`searchUsers(QueryOptions options)` Search users according to specific query options
`void`	`updateCustomUserInfoDefinition(SCustomUserInfoDefinition customUserInfo, EntityUpdateDescriptor descriptor)` Update customUserInfoDefinition according to the descriptor
`void`	`updateCustomUserInfoValue(SCustomUserInfoValue customUserInfo, EntityUpdateDescriptor descriptor)` Update profileMetadataValue according to the descriptor
`void`	`updateGroup(SGroup group, EntityUpdateDescriptor descriptor, EntityUpdateDescriptor iconUpdater)` Update group according to the descriptor
`SRole`	`updateRole(SRole role, EntityUpdateDescriptor descriptor, EntityUpdateDescriptor iconUpdater)` Update role according to the descriptor
`SUser`	`updateUser(long userId, EntityUpdateDescriptor userUpdateDescriptor, EntityUpdateDescriptor personalDataUpdateDescriptor, EntityUpdateDescriptor professionalDataUpdateDescriptor, EntityUpdateDescriptor iconUpdater)` Update the user having id userId according to the entity update descriptors in parameters
`void`	`updateUser(SUser user, EntityUpdateDescriptor descriptor)` Update `SUser` according to the `EntityUpdateDescriptor`
`void`	`updateUser(SUser user, EntityUpdateDescriptor descriptor, boolean isPasswordEncrypted)` Deprecated.
`void`	`updateUserContactInfo(SContactInfo contactInfo, EntityUpdateDescriptor descriptor)` Update user contact information according to the descriptor
`void`	`updateUserMembership(SUserMembership userMembership, EntityUpdateDescriptor descriptor)` Update userMembership according to the descriptor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IdentityServiceImpl
```
public IdentityServiceImpl(ReadPersistenceService persistenceService,
                           Recorder recorder,
                           EventService eventService,
                           TechnicalLoggerService logger,
                           QueriableLoggerService queriableLoggerService,
                           CredentialsEncrypter encrypter)
```
- Method Detail
  - createGroup
```
public void createGroup(SGroup group,
                        java.lang.String iconFileName,
                        byte[] iconContent)
                 throws SGroupCreationException
```
    Description copied from interface: IdentityService
    
    Create group in DB for the given group object
    
    Specified by:
    
    createGroup in interface IdentityService
    
    Parameters:
    
    group - A group object
    
    Throws:
    
    SGroupCreationException
  - createCustomUserInfoDefinition
```
public SCustomUserInfoDefinition createCustomUserInfoDefinition(SCustomUserInfoDefinition customUserInfo)
                                                         throws SCustomUserInfoDefinitionAlreadyExistsException,
                                                                SCustomUserInfoDefinitionCreationException
```
    Description copied from interface: IdentityService
    
    Create custom user info definition in DB for a server given custom user info definition
    
    Specified by:
    
    createCustomUserInfoDefinition in interface IdentityService
    
    Parameters:
    
    customUserInfo - SCustomUserInfoDefinition object
    
    Throws:
    
    SCustomUserInfoDefinitionAlreadyExistsException - TODO
    
    SCustomUserInfoDefinitionCreationException - TODO
  - createCustomUserInfoValue
```
public SCustomUserInfoValue createCustomUserInfoValue(SCustomUserInfoValue customUserInfo)
                                               throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Create profileMetadataValue in DB for give profileMetadataValue object
    
    Specified by:
    
    createCustomUserInfoValue in interface IdentityService
    
    Parameters:
    
    customUserInfo - A profileMetadataValue object
    
    Throws:
    
    SIdentityException
  - createRole
```
public void createRole(SRole role,
                       java.lang.String iconFilename,
                       byte[] iconContent)
                throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Create role in DB for the given role
    
    Specified by:
    
    createRole in interface IdentityService
    
    Parameters:
    
    role - A role object
    
    Throws:
    
    SIdentityException
  - createUser
```
public SUser createUser(SUser user)
                 throws SUserCreationException
```
    Description copied from interface: IdentityService
    
    Create SUser and store it to persistence layer
    
    Specified by:
    
    createUser in interface IdentityService
    
    Parameters:
    
    user - The user to create and store
    
    Returns:
    
    the created user with its identifier set
    
    Throws:
    
    SUserCreationException - occurs on persistence layer access problem
  - createUserWithoutEncryptingPassword
```
@Deprecated
public SUser createUserWithoutEncryptingPassword(SUser user)
                                                      throws SUserCreationException
```
    Deprecated.
    
    Description copied from interface: IdentityService
    
    Create user in DB for given user and
    
    Specified by:
    
    createUserWithoutEncryptingPassword in interface IdentityService
    
    Parameters:
    
    user - The user object
    
    Throws:
    
    SUserCreationException
  - createUserContactInfo
```
public SContactInfo createUserContactInfo(SContactInfo contactInfo)
                                   throws SUserCreationException
```
    Description copied from interface: IdentityService
    
    Create user contact information for given data
    
    Specified by:
    
    createUserContactInfo in interface IdentityService
    
    Parameters:
    
    contactInfo - The user contact information object
    
    Returns:
    
    The contact info created
    
    Throws:
    
    SUserCreationException
  - createUserMembership
```
public void createUserMembership(SUserMembership userMembership)
                          throws SUserMembershipCreationException
```
    Description copied from interface: IdentityService
    
    Create userMembership in DB for the given userMembership object
    
    Specified by:
    
    createUserMembership in interface IdentityService
    
    Parameters:
    
    userMembership - A userMembership object
    
    Throws:
    
    SUserMembershipCreationException
  - deleteGroup
```
public void deleteGroup(long groupId)
                 throws SGroupNotFoundException,
                        SGroupDeletionException
```
    Description copied from interface: IdentityService
    
    Delete the id specified group
    
    Specified by:
    
    deleteGroup in interface IdentityService
    
    Parameters:
    
    groupId - The identifier of group
    
    Throws:
    
    SGroupNotFoundException - Error occurs when no group found with the specific groupId
    
    SGroupDeletionException
  - deleteGroup
```
public void deleteGroup(SGroup group)
                 throws SGroupDeletionException
```
    Description copied from interface: IdentityService
    
    Delete the specific group
    
    Specified by:
    
    deleteGroup in interface IdentityService
    
    Parameters:
    
    group - The group will be deleted
    
    Throws:
    
    SGroupDeletionException
  - deleteAllGroups
```
public void deleteAllGroups()
                     throws SGroupDeletionException
```
    Description copied from interface: IdentityService
    
    Delete all groups for the connected tenant
    
    Specified by:
    
    deleteAllGroups in interface IdentityService
    
    Throws:
    
    SGroupDeletionException
  - deleteChildrenGroup
```
public java.util.List<java.lang.Long> deleteChildrenGroup(long groupId)
                                                   throws SGroupDeletionException,
                                                          SGroupNotFoundException
```
    Description copied from interface: IdentityService
    
    delete children groups of the given group if there is some
    
    Specified by:
    
    deleteChildrenGroup in interface IdentityService
    
    Parameters:
    
    groupId - The index of the group to delete
    
    Throws:
    
    SGroupDeletionException
    
    SGroupNotFoundException
  - deleteCustomUserInfoDefinition
```
public void deleteCustomUserInfoDefinition(long customUserInfoDefinitionId)
                                    throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Delete the id specified custom user info
    
    Specified by:
    
    deleteCustomUserInfoDefinition in interface IdentityService
    
    Parameters:
    
    customUserInfoDefinitionId - The identifier of custom user info
    
    Throws:
    
    SIdentityException
  - deleteCustomUserInfoDefinition
```
public void deleteCustomUserInfoDefinition(SCustomUserInfoDefinition info)
                                    throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Delete the specific custom user info
    
    Specified by:
    
    deleteCustomUserInfoDefinition in interface IdentityService
    
    Parameters:
    
    info - The custom user info object will be deleted
    
    Throws:
    
    SIdentityException
  - deleteCustomUserInfoValue
```
public void deleteCustomUserInfoValue(long customUserInfoValueId)
                               throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Delete the id specified profileMetadataValue
    
    Specified by:
    
    deleteCustomUserInfoValue in interface IdentityService
    
    Parameters:
    
    customUserInfoValueId - The identifier of profileMetadataValue
    
    Throws:
    
    SIdentityException
  - deleteCustomUserInfoValue
```
public void deleteCustomUserInfoValue(SCustomUserInfoValue customUserInfo)
                               throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Delete the specific profileMetadataValue
    
    Specified by:
    
    deleteCustomUserInfoValue in interface IdentityService
    
    Parameters:
    
    customUserInfo - The profileMetadataValue object will be deleted
    
    Throws:
    
    SIdentityException
  - deleteRole
```
public void deleteRole(long roleId)
                throws SRoleNotFoundException,
                       SRoleDeletionException
```
    Description copied from interface: IdentityService
    
    Delete the id specified role
    
    Specified by:
    
    deleteRole in interface IdentityService
    
    Parameters:
    
    roleId - The role identifier
    
    Throws:
    
    SRoleNotFoundException - Error occurs when no role found with the specific roleId
    
    SRoleDeletionException
  - deleteRole
```
public void deleteRole(SRole role)
                throws SRoleDeletionException
```
    Description copied from interface: IdentityService
    
    Delete the specific role
    
    Specified by:
    
    deleteRole in interface IdentityService
    
    Parameters:
    
    role - The role will be deleted
    
    Throws:
    
    SRoleDeletionException
  - deleteAllRoles
```
public void deleteAllRoles()
                    throws SRoleDeletionException
```
    Description copied from interface: IdentityService
    
    Delete all roles for the connected tenant
    
    Specified by:
    
    deleteAllRoles in interface IdentityService
    
    Throws:
    
    SRoleDeletionException
  - deleteUser
```
public void deleteUser(long userId)
                throws SUserDeletionException
```
    Description copied from interface: IdentityService
    
    Delete user by its id
    
    Specified by:
    
    deleteUser in interface IdentityService
    
    Parameters:
    
    userId - The identifier of user
    
    Throws:
    
    SUserDeletionException
  - deleteUser
```
public void deleteUser(SUser user)
                throws SUserDeletionException
```
    Description copied from interface: IdentityService
    
    Delete the specific user
    
    Specified by:
    
    deleteUser in interface IdentityService
    
    Parameters:
    
    user - The user will be deleted
    
    Throws:
    
    SUserDeletionException
  - deleteAllUsers
```
public void deleteAllUsers()
                    throws SUserDeletionException
```
    Description copied from interface: IdentityService
    
    Delete all users for the connected tenant
    
    Specified by:
    
    deleteAllUsers in interface IdentityService
    
    Throws:
    
    SUserDeletionException
  - getLightUserMembership
```
public SUserMembership getLightUserMembership(long userMembershipId)
                                       throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get light userMembership by its id
    
    Specified by:
    
    getLightUserMembership in interface IdentityService
    
    Parameters:
    
    userMembershipId - The identifier of userMembership
    
    Returns:
    
    a SUserMembership object without userName, groupName and roleName
    
    Throws:
    
    SIdentityException
  - deleteUserMembership
```
public void deleteUserMembership(SUserMembership userMembership)
                          throws SMembershipDeletionException
```
    Description copied from interface: IdentityService
    
    Delete the specific userMembership
    
    Specified by:
    
    deleteUserMembership in interface IdentityService
    
    Parameters:
    
    userMembership - The userMembership will be deleted
    
    Throws:
    
    SMembershipDeletionException
  - deleteUserMembership
```
public void deleteUserMembership(long id)
                          throws SMembershipDeletionException
```
    Description copied from interface: IdentityService
    
    Delete the id specified userMembership
    
    Specified by:
    
    deleteUserMembership in interface IdentityService
    
    Parameters:
    
    id - The identifier of userMembership
    
    Throws:
    
    SMembershipDeletionException
  - deleteLightUserMembership
```
public void deleteLightUserMembership(SUserMembership userMembership)
                               throws SMembershipDeletionException
```
    Description copied from interface: IdentityService
    
    Delete the specific light userMembership
    
    Specified by:
    
    deleteLightUserMembership in interface IdentityService
    
    Throws:
    
    SMembershipDeletionException
  - deleteAllUserMemberships
```
public void deleteAllUserMemberships()
                              throws SMembershipDeletionException
```
    Description copied from interface: IdentityService
    
    Delete all user memberships for the connected tenant
    
    Specified by:
    
    deleteAllUserMemberships in interface IdentityService
    
    Throws:
    
    SMembershipDeletionException
  - getGroup
```
public SGroup getGroup(long groupId)
                throws SGroupNotFoundException
```
    Description copied from interface: IdentityService
    
    Get SGroup by its identifier
    
    Specified by:
    
    getGroup in interface IdentityService
    
    Parameters:
    
    groupId - The group identifier
    
    Returns:
    
    the group
    
    Throws:
    
    SGroupNotFoundException - occurs when the groupId does not refer to any group.
  - getGroupChildren
```
public java.util.List<SGroup> getGroupChildren(long groupId,
                                               int fromIndex,
                                               int numberOfGroups)
                                        throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List child SGroup in a specific interval for specific group. This is used for pagination If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getGroupChildren in interface IdentityService
    
    Parameters:
    
    groupId - The parent group identifier
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfGroups - Number of result to retrieve
    
    Returns:
    
    a List of child SGroup
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getGroupChildren
```
public java.util.List<SGroup> getGroupChildren(long groupId,
                                               int fromIndex,
                                               int numberOfGroups,
                                               java.lang.String field,
                                               OrderByType order)
                                        throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of child SGroup in specific interval, sorted by field attribute in the given OrderByType order.
    For instance, getGroupChildren(0,10,"displayName", OrderByType.DESC) returns the 10 first child SGroup of the parent SGroup identified by parentGroupId sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SGroupBuilderFactory to get a list of available field keys to sort
    
    Specified by:
    
    getGroupChildren in interface IdentityService
    
    Parameters:
    
    groupId - The parent group identifier
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfGroups - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of child SGroup
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getGroups
```
public java.util.List<SGroup> getGroups(int fromIndex,
                                        int numberOfGroups)
                                 throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SGroup in a specific interval, this is used for pagination If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getGroups in interface IdentityService
    
    Parameters:
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfGroups - Number of result to retrieve
    
    Returns:
    
    a List of SGroup
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getGroups
```
public java.util.List<SGroup> getGroups(int fromIndex,
                                        int numberOfGroups,
                                        java.lang.String field,
                                        OrderByType order)
                                 throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SGroup in specific interval, sorted by field attribute in the given OrderByType order.
    For instance, getGroups(0,10,"displayName", OrderByType.DESC) returns the 10 first SGroup sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SGroupBuilderFactory to get a list of available field keys to sort
    
    Specified by:
    
    getGroups in interface IdentityService
    
    Parameters:
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfGroups - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of paginated SGroup objects
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
    
    See Also:
    
    SGroupBuilderFactory
  - getGroups
```
public java.util.List<SGroup> getGroups(java.util.List<java.lang.Long> groupIds)
                                 throws SGroupNotFoundException
```
    Description copied from interface: IdentityService
    
    Get a List of SGroup for specific groupIds
    
    Specified by:
    
    getGroups in interface IdentityService
    
    Parameters:
    
    groupIds - The group identifiers
    
    Returns:
    
    a List of SGroup object
    
    Throws:
    
    SGroupNotFoundException - occurs when no given group identifiers refer to any group.
  - getUserMemberships
```
public java.util.List<SUserMembership> getUserMemberships(int fromIndex,
                                                          int numberOfResult,
                                                          OrderByOption orderByOption)
                                                   throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUserMembership from specific interval, sorted by field attribute in the given OrderByType order order.
    For instance, getUserMemberships(0,10,"id", OrderByType.DESC) returns the 10 first SUserMembership sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SUserMembershipBuilderFactory to check available field keys to sort
    
    Specified by:
    
    getUserMemberships in interface IdentityService
    
    Parameters:
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfResult - Number of result to retrieve
    
    Returns:
    
    a List of SUserMembership
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
    
    See Also:
    
    SUserMembershipBuilderFactory
  - getUserMembershipsOfGroup
```
public java.util.List<SUserMembership> getUserMembershipsOfGroup(long groupId,
                                                                 int startIndex,
                                                                 int maxResults)
                                                          throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUserMembership for given group from specific interval
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getUserMembershipsOfGroup in interface IdentityService
    
    Parameters:
    
    groupId - Identifier of the group
    
    startIndex - Index of the record to be retrieved from. First record has index 0
    
    maxResults - Number of result to retrieve
    
    Returns:
    
    a List of SUserMembership
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getUserMembershipsOfRole
```
public java.util.List<SUserMembership> getUserMembershipsOfRole(long roleId,
                                                                int startIndex,
                                                                int maxResults)
                                                         throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUserMembership for given role from specific interval
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getUserMembershipsOfRole in interface IdentityService
    
    Parameters:
    
    roleId - Identifier of the role
    
    startIndex - Index of the record to be retrieved from. First record has index 0
    
    maxResults - Number of result to retrieve
    
    Returns:
    
    a List of SUserMembership
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getNumberOfGroupChildren
```
public long getNumberOfGroupChildren(long parentGroupId)
                              throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get number of child groups for the group identified by the given id
    
    Specified by:
    
    getNumberOfGroupChildren in interface IdentityService
    
    Parameters:
    
    parentGroupId - The parent group identifier
    
    Returns:
    
    the number of child groups
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getNumberOfGroups
```
public long getNumberOfGroups()
                       throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get total number of SGroup in the current tenant
    
    Specified by:
    
    getNumberOfGroups in interface IdentityService
    
    Returns:
    
    the total number of SGroup
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getNumberOfCustomUserInfoDefinition
```
public long getNumberOfCustomUserInfoDefinition()
                                         throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get total number of SCustomUserInfoDefinition of the current tenant
    
    Specified by:
    
    getNumberOfCustomUserInfoDefinition in interface IdentityService
    
    Returns:
    
    the total number of SCustomUserInfoDefinition of the current tenant
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getNumberOfCustomUserInfoValue
```
public long getNumberOfCustomUserInfoValue(QueryOptions options)
                                    throws SBonitaReadException
```
    Description copied from interface: IdentityService
    
    Get total number of SCustomUserInfoValue of the current tenant matching the criterias of the given QueryOptions
    
    Specified by:
    
    getNumberOfCustomUserInfoValue in interface IdentityService
    
    Parameters:
    
    options - The QueryOptions containing filtering conditions
    
    Returns:
    
    the total number of custom user info value
    
    Throws:
    
    SBonitaReadException
  - getNumberOfRoles
```
public long getNumberOfRoles()
                      throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get total number of SRole for this tenant
    
    Specified by:
    
    getNumberOfRoles in interface IdentityService
    
    Returns:
    
    the total number of roles for this tenant
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getNumberOfUsers
```
public long getNumberOfUsers()
                      throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get total number of SUser on the current tenant
    
    Specified by:
    
    getNumberOfUsers in interface IdentityService
    
    Returns:
    
    the total number of users
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getNumberOfUserMembershipsOfUser
```
public long getNumberOfUserMembershipsOfUser(long userId)
                                      throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get total number of SUserMembership for a specific user
    
    Specified by:
    
    getNumberOfUserMembershipsOfUser in interface IdentityService
    
    Parameters:
    
    userId - The user's identifier
    
    Returns:
    
    total number of userMemberships for the specific user
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getNumberOfUsersByGroup
```
public long getNumberOfUsersByGroup(long groupId)
                             throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get total number of users for the given SGroup
    
    Specified by:
    
    getNumberOfUsersByGroup in interface IdentityService
    
    Parameters:
    
    groupId - The identifier of the SGroup
    
    Returns:
    
    total number of users in the given group
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getNumberOfUsersByRole
```
public long getNumberOfUsersByRole(long roleId)
                            throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get total number of users for the given role on the current tenant
    
    Specified by:
    
    getNumberOfUsersByRole in interface IdentityService
    
    Parameters:
    
    roleId - The identifier of role
    
    Returns:
    
    total number of users related to the given role
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getNumberOfUsersByMembership
```
public long getNumberOfUsersByMembership(long groupId,
                                         long roleId)
                                  throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get total number of userMemberships contains specific group and role
    
    Specified by:
    
    getNumberOfUsersByMembership in interface IdentityService
    
    Parameters:
    
    groupId - The identifier of group
    
    roleId - The identifier of role
    
    Returns:
    
    the number of userMemberships
    
    Throws:
    
    SIdentityException
  - getCustomUserInfoDefinitionByName
```
public SCustomUserInfoDefinition getCustomUserInfoDefinitionByName(java.lang.String name)
                                                            throws SCustomUserInfoDefinitionNotFoundException,
                                                                   SCustomUserInfoDefinitionReadException
```
    Description copied from interface: IdentityService
    
    Get a SCustomUserInfoDefinition by its name
    
    Specified by:
    
    getCustomUserInfoDefinitionByName in interface IdentityService
    
    Parameters:
    
    name - The name of the SCustomUserInfoDefinition to retrieve
    
    Returns:
    
    the SCustomUserInfoDefinition identified by the given name
    
    Throws:
    
    SCustomUserInfoDefinitionNotFoundException - if there is no custom user info definition for the given name
    
    SCustomUserInfoDefinitionReadException - if an exception occurs when trying to retrieve the custom user info definition
  - hasCustomUserInfoDefinition
```
public boolean hasCustomUserInfoDefinition(java.lang.String name)
                                    throws SCustomUserInfoDefinitionReadException
```
    Description copied from interface: IdentityService
    
    Verify if there is a SCustomUserInfoDefinition of the given name
    
    Specified by:
    
    hasCustomUserInfoDefinition in interface IdentityService
    
    Parameters:
    
    name - The SCustomUserInfoDefinition's name to check
    
    Returns:
    
    the SCustomUserInfoDefinition of the given name
    
    Throws:
    
    SCustomUserInfoDefinitionReadException - if an exception occurs when trying to retrieve the custom user info definition
  - getCustomUserInfoDefinitions
```
public java.util.List<SCustomUserInfoDefinition> getCustomUserInfoDefinitions(int fromIndex,
                                                                              int maxResults)
                                                                       throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SCustomUserInfoDefinition from specific interval
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getCustomUserInfoDefinitions in interface IdentityService
    
    Parameters:
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    maxResults - Number of result to retrieve
    
    Returns:
    
    a List of SCustomUserInfoDefinition
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getUserIdsWithCustomUserInfo
```
public java.util.List<java.lang.Long> getUserIdsWithCustomUserInfo(java.lang.String userInfoName,
                                                                   java.lang.String userInfoValue,
                                                                   boolean usePartialMatch,
                                                                   int fromIndex,
                                                                   int maxResults)
                                                            throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Retrieve a List of user identifiers from specific interval. The returned user's ids have their associated user's userInfo of the given name userInfoName matches the given value userInfoValue partially or not depending on the usePartialMatch parameter.
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getUserIdsWithCustomUserInfo in interface IdentityService
    
    Parameters:
    
    userInfoName - The user's information name.
    
    userInfoValue - The user's information value.
    
    usePartialMatch - Defines whether the custom user information value should use a partial match.
    
    fromIndex - The index of the first record to be retrieved. First record has index 0.
    
    maxResults - The max results to be retrieved.
    
    Returns:
    
    the list identifiers of users matching the given user's information name & value.
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getCustomUserInfoDefinition
```
public SCustomUserInfoDefinition getCustomUserInfoDefinition(long customUserInfoDefinitionId)
                                                      throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get SCustomUserInfoDefinition by its id
    
    Specified by:
    
    getCustomUserInfoDefinition in interface IdentityService
    
    Parameters:
    
    customUserInfoDefinitionId - The SCustomUserInfoDefinition's identifier
    
    Returns:
    
    the customUserInfoDefinition
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getCustomUserInfoDefinitions
```
public java.util.List<SCustomUserInfoDefinition> getCustomUserInfoDefinitions(java.util.List<java.lang.Long> customUserInfoDefinitionIds)
                                                                       throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SCustomUserInfoDefinition of the given identifiers
    
    Specified by:
    
    getCustomUserInfoDefinitions in interface IdentityService
    
    Parameters:
    
    customUserInfoDefinitionIds - A List of SCustomUserInfoDefinition identifiers
    
    Returns:
    
    a List of SCustomUserInfoDefinition
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem or if none identifiers match an existing SCustomUserInfoDefinition
  - getCustomUserInfoValue
```
public SCustomUserInfoValue getCustomUserInfoValue(long customUserInfoValueId)
                                            throws SCustomUserInfoValueNotFoundException,
                                                   SCustomUserInfoValueReadException
```
    Description copied from interface: IdentityService
    
    Get SCustomUserInfoValue by its id
    
    Specified by:
    
    getCustomUserInfoValue in interface IdentityService
    
    Parameters:
    
    customUserInfoValueId - The identifier of the custom user info value
    
    Returns:
    
    the SCustomUserInfoValue
    
    Throws:
    
    SCustomUserInfoValueNotFoundException - if no custom user info value is found for the given id
    
    SCustomUserInfoValueReadException - if an exception occurs while trying to get the custom user info value
  - getCustomUserInfoValues
```
public java.util.List<SCustomUserInfoValue> getCustomUserInfoValues(java.util.List<java.lang.Long> customUserInfoValueIds)
                                                             throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SCustomUserInfoValue of the given identifiers
    
    Specified by:
    
    getCustomUserInfoValues in interface IdentityService
    
    Parameters:
    
    customUserInfoValueIds - A List of SCustomUserInfoValue identifiers
    
    Returns:
    
    A List of SCustomUserInfoValue
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem or if none identifiers match an existing SCustomUserInfoDefinition
  - getRole
```
public SRole getRole(long roleId)
              throws SRoleNotFoundException
```
    Description copied from interface: IdentityService
    
    Gets the SRole given by its identifier.
    
    Specified by:
    
    getRole in interface IdentityService
    
    Parameters:
    
    roleId - the role identifier
    
    Returns:
    
    the role of the given id
    
    Throws:
    
    SRoleNotFoundException - occurs when the roleId does not refer to any role.
  - getRoleByName
```
public SRole getRoleByName(java.lang.String roleName)
                    throws SRoleNotFoundException
```
    Description copied from interface: IdentityService
    
    Get the SRole given by its name.
    
    Specified by:
    
    getRoleByName in interface IdentityService
    
    Parameters:
    
    roleName - The name of role
    
    Returns:
    
    the role of the given name
    
    Throws:
    
    SRoleNotFoundException - occurs when the roleName does not refer to any role.
  - getGroupByPath
```
public SGroup getGroupByPath(java.lang.String groupPath)
                      throws SGroupNotFoundException
```
    Description copied from interface: IdentityService
    
    Get the SGroup by its path
    
    Specified by:
    
    getGroupByPath in interface IdentityService
    
    Parameters:
    
    groupPath - The group path
    
    Returns:
    
    the group
    
    Throws:
    
    SGroupNotFoundException - Occurs when the groupPath does not refer to any group.
  - getRoles
```
public java.util.List<SRole> getRoles(int fromIndex,
                                      int numberOfRoles)
                               throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SRole in specific interval If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getRoles in interface IdentityService
    
    Parameters:
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfRoles - Number of result to retrieve
    
    Returns:
    
    a list of SRole objects
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getRoles
```
public java.util.List<SRole> getRoles(int fromIndex,
                                      int numberOfRoles,
                                      java.lang.String field,
                                      OrderByType order)
                               throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SRole in specific interval, sorted by field attribute in the given OrderByType order.
    For instance, getRoles(0,10,"displayName", OrderByType.DESC) returns the 10 first roles sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SRoleBuilderFactory to get a list of available field keys to sort
    
    Specified by:
    
    getRoles in interface IdentityService
    
    Parameters:
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfRoles - Number of result to retrieve
    
    field - The field used by the sort
    
    order - ASC or DESC
    
    Returns:
    
    a list of paginated SRole objects
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
    
    See Also:
    
    to get a list of available field keys to use
  - getRoles
```
public java.util.List<SRole> getRoles(java.util.List<java.lang.Long> roleIds)
                               throws SRoleNotFoundException
```
    Description copied from interface: IdentityService
    
    Get a List of SRole by their identifiers
    
    Specified by:
    
    getRoles in interface IdentityService
    
    Parameters:
    
    roleIds - the role identifiers
    
    Returns:
    
    a list of SRole objects
    
    Throws:
    
    SRoleNotFoundException - Occurs when roleId does not refer to any role.
  - getUser
```
public SUser getUser(long userId)
              throws SUserNotFoundException
```
    Description copied from interface: IdentityService
    
    Get SUser by its id
    
    Specified by:
    
    getUser in interface IdentityService
    
    Parameters:
    
    userId - The user identifier
    
    Returns:
    
    the user
    
    Throws:
    
    SUserNotFoundException - occurs when the userId does not refer to any user.
  - getUserContactInfo
```
public SContactInfo getUserContactInfo(long userId,
                                       boolean isPersonal)
                                throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Return the user contact info for a specific user.
    
    Specified by:
    
    getUserContactInfo in interface IdentityService
    
    Parameters:
    
    userId - the ID of the user to retrieve the contact info from
    
    isPersonal - Do we want personal contact information (or professional) ?
    
    Returns:
    
    the corresponding SContactInfo, if found
    
    Throws:
    
    SIdentityException - if a Read problem occurred
  - getUserByUserName
```
public SUser getUserByUserName(java.lang.String userName)
                        throws SUserNotFoundException
```
    Description copied from interface: IdentityService
    
    Get SUser by its name
    
    Specified by:
    
    getUserByUserName in interface IdentityService
    
    Parameters:
    
    userName - The user name
    
    Returns:
    
    the user
    
    Throws:
    
    SUserNotFoundException - occurs when the user name does not refer to any user.
  - getUserMembership
```
public SUserMembership getUserMembership(long userMembershipId)
                                  throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get SUserMembership by given id
    
    Specified by:
    
    getUserMembership in interface IdentityService
    
    Parameters:
    
    userMembershipId - The identifier of userMembership
    
    Returns:
    
    the SUserMembership of the given id
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem or if the SUserMembership does not exists
  - getUserMemberships
```
public java.util.List<SUserMembership> getUserMemberships(java.util.List<java.lang.Long> userMembershipIds)
                                                   throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUserMembership of the given identifiers if they exists
    
    Specified by:
    
    getUserMemberships in interface IdentityService
    
    Parameters:
    
    userMembershipIds - The SUserMembership's identifiers
    
    Returns:
    
    a List of SUserMembership
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem or if none identifiers match an existing SUserMembership
  - getUsers
```
public java.util.List<SUser> getUsers(int fromIndex,
                                      int numberOfUsers)
                               throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUser from a specific interval. If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getUsers in interface IdentityService
    
    Parameters:
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getUsers
```
public java.util.List<SUser> getUsers(int fromIndex,
                                      int numberOfUsers,
                                      java.lang.String field,
                                      OrderByType order)
                               throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of child SUser from specific interval, sorted by field attribute in the given OrderByType order order.
    For instance, getUsers(0,10,"displayName", OrderByType.DESC) returns the 10 first SUser sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SUser to get a list of available field keys to sort
    
    Specified by:
    
    getUsers in interface IdentityService
    
    Parameters:
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result we want to get. Maximum number of result returned.
    
    field - The field used by the order
    
    order - ASC or DESC
    
    Returns:
    
    a List of paginated SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getUsers
```
public java.util.List<SUser> getUsers(java.util.List<java.lang.Long> userIds)
                               throws SUserNotFoundException
```
    Description copied from interface: IdentityService
    
    Get SUser by their userIds
    
    Specified by:
    
    getUsers in interface IdentityService
    
    Parameters:
    
    userIds - A List of user identifiers
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SUserNotFoundException - occurs when none of the given userIds refer to any user.
  - getUsersByUsername
```
public java.util.List<SUser> getUsersByUsername(java.util.List<java.lang.String> userNames)
                                         throws SIdentityException
```
    Description copied from interface: IdentityService
    
    retrieve a List of SUser from their names.
    
    Specified by:
    
    getUsersByUsername in interface IdentityService
    
    Parameters:
    
    userNames - the list of user names
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - If an exception occurs when retrieving the users
  - getUsersInGroup
```
public java.util.List<SUser> getUsersInGroup(long groupId,
                                             int fromIndex,
                                             int numberOfUsers,
                                             java.lang.String field,
                                             OrderByType order)
                                      throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUser for given SGroup from specific interval, sorted by field attribute in the given OrderByType order order.
    For instance, getUsersInGroup(1,0,10,"displayName", OrderByType.DESC) returns the 10 first SUser of the SGroup with id '1' sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SUser to get a list of available field keys to sort
    
    Specified by:
    
    getUsersInGroup in interface IdentityService
    
    Parameters:
    
    groupId - Identifier of the SGroup
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getActiveUsersInGroup
```
public java.util.List<SUser> getActiveUsersInGroup(long groupId,
                                                   int fromIndex,
                                                   int numberOfUsers,
                                                   java.lang.String field,
                                                   OrderByType order)
                                            throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of Active SUser for given SGroup from specific interval, sorted by field attribute in the given OrderByType order order.
    For instance, getActiveUsersInGroup(1,0,10,"displayName", OrderByType.DESC) returns the 10 first SUser of the SGroup with id '1' sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SUser to get a list of available field keys to sort
    
    Specified by:
    
    getActiveUsersInGroup in interface IdentityService
    
    Parameters:
    
    groupId - Identifier of the SGroup
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getInactiveUsersInGroup
```
public java.util.List<SUser> getInactiveUsersInGroup(long groupId,
                                                     int fromIndex,
                                                     int numberOfUsers,
                                                     java.lang.String field,
                                                     OrderByType order)
                                              throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of Inactive SUser for given SGroup from specific interval, sorted by field attribute in the given OrderByType order order.
    For instance, getInactiveUsersInGroup(1,0,10,"displayName", OrderByType.DESC) returns the 10 first SUser of the SGroup with id '1' sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SUser to get a list of available field keys to sort
    
    Specified by:
    
    getInactiveUsersInGroup in interface IdentityService
    
    Parameters:
    
    groupId - Identifier of the SGroup
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getUsersWithManager
```
public java.util.List<SUser> getUsersWithManager(long managerId,
                                                 int fromIndex,
                                                 int numberMaxOfUsers,
                                                 java.lang.String field,
                                                 OrderByType order)
                                          throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get all users (both active and inactive) managed by a specific manager from a specific interval. If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getUsersWithManager in interface IdentityService
    
    Parameters:
    
    managerId - The manager identifier, actually it is user identifier
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberMaxOfUsers - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getActiveUsersWithManager
```
public java.util.List<SUser> getActiveUsersWithManager(long managerId,
                                                       int fromIndex,
                                                       int numberMaxOfUsers,
                                                       java.lang.String field,
                                                       OrderByType order)
                                                throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get all active users managed by a specific manager from a specific interval. If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getActiveUsersWithManager in interface IdentityService
    
    Parameters:
    
    managerId - The manager identifier, actually it is user identifier
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberMaxOfUsers - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getInactiveUsersWithManager
```
public java.util.List<SUser> getInactiveUsersWithManager(long managerId,
                                                         int fromIndex,
                                                         int numberMaxOfUsers,
                                                         java.lang.String field,
                                                         OrderByType order)
                                                  throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get all inactive users managed by a specific manager from a specific interval. If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getInactiveUsersWithManager in interface IdentityService
    
    Parameters:
    
    managerId - The manager identifier, actually it is user identifier
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberMaxOfUsers - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getUsersWithRole
```
public java.util.List<SUser> getUsersWithRole(long roleId,
                                              int fromIndex,
                                              int numberOfUsers)
                                       throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUser from a specific interval for the given SRole identifier. If the number of existing results are lower than the number asked, all results from the given index are retrieved. Note that this method returns both active and inactive users.
    
    Specified by:
    
    getUsersWithRole in interface IdentityService
    
    Parameters:
    
    roleId - The identifier of the SRole of the SUser to retrieve
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getActiveUsersWithRole
```
public java.util.List<SUser> getActiveUsersWithRole(long roleId,
                                                    int fromIndex,
                                                    int numberOfUsers)
                                             throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of active SUser from a specific interval for the given SRole identifier. If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getActiveUsersWithRole in interface IdentityService
    
    Parameters:
    
    roleId - The identifier of the SRole of the SUser to retrieve
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getInactiveUsersWithRole
```
public java.util.List<SUser> getInactiveUsersWithRole(long roleId,
                                                      int fromIndex,
                                                      int numberOfUsers)
                                               throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of inactive SUser from a specific interval for the given SRole identifier. If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getInactiveUsersWithRole in interface IdentityService
    
    Parameters:
    
    roleId - The identifier of the SRole of the SUser to retrieve
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getUsersWithRole
```
public java.util.List<SUser> getUsersWithRole(long roleId,
                                              int fromIndex,
                                              int numberOfUsers,
                                              java.lang.String field,
                                              OrderByType order)
                                       throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUser for given SRole from specific interval, sorted by field attribute in the given OrderByType order order.
    For instance, getUsersWithRole(1,0,10,"displayName", OrderByType.DESC) returns the 10 first SUser of the SRole with id '1' sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SUser to get a list of available field keys to sort
    
    Specified by:
    
    getUsersWithRole in interface IdentityService
    
    Parameters:
    
    roleId - The identifier of the SRole
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getActiveUsersWithRole
```
public java.util.List<SUser> getActiveUsersWithRole(long roleId,
                                                    int fromIndex,
                                                    int numberOfUsers,
                                                    java.lang.String field,
                                                    OrderByType order)
                                             throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of active SUser for given SRole from specific interval, sorted by field attribute in the given OrderByType order order.
    For instance, getActiveUsersWithRole(1,0,10,"displayName", OrderByType.DESC) returns the 10 first SUser of the SRole with id '1' sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SUser to get a list of available field keys to sort
    
    Specified by:
    
    getActiveUsersWithRole in interface IdentityService
    
    Parameters:
    
    roleId - The identifier of the SRole
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getInactiveUsersWithRole
```
public java.util.List<SUser> getInactiveUsersWithRole(long roleId,
                                                      int fromIndex,
                                                      int numberOfUsers,
                                                      java.lang.String field,
                                                      OrderByType order)
                                               throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of Inactive SUser for given SRole from specific interval, sorted by field attribute in the given OrderByType order order.
    For instance, getInactiveUsersWithRole(1,0,10,"displayName", OrderByType.DESC) returns the 10 first SUser of the SRole with id '1' sorted by "displayName" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SUser to get a list of available field keys to sort
    
    Specified by:
    
    getInactiveUsersWithRole in interface IdentityService
    
    Parameters:
    
    roleId - The identifier of the SRole
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    field - The field used to sort
    
    order - ASC or DESC
    
    Returns:
    
    a List of SUser
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - updateGroup
```
public void updateGroup(SGroup group,
                        EntityUpdateDescriptor descriptor,
                        EntityUpdateDescriptor iconUpdater)
                 throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Update group according to the descriptor
    
    Specified by:
    
    updateGroup in interface IdentityService
    
    Parameters:
    
    group - The group will be updated
    
    descriptor - The update description
    
    Throws:
    
    SIdentityException
  - updateCustomUserInfoDefinition
```
public void updateCustomUserInfoDefinition(SCustomUserInfoDefinition customUserInfo,
                                           EntityUpdateDescriptor descriptor)
                                    throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Update customUserInfoDefinition according to the descriptor
    
    Specified by:
    
    updateCustomUserInfoDefinition in interface IdentityService
    
    Parameters:
    
    customUserInfo - The customUserInfoDefinition will be updated
    
    descriptor - The update description
    
    Throws:
    
    SIdentityException
  - updateCustomUserInfoValue
```
public void updateCustomUserInfoValue(SCustomUserInfoValue customUserInfo,
                                      EntityUpdateDescriptor descriptor)
                               throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Update profileMetadataValue according to the descriptor
    
    Specified by:
    
    updateCustomUserInfoValue in interface IdentityService
    
    Parameters:
    
    customUserInfo - The profileMetadataValue will be updated
    
    descriptor - The update description
    
    Throws:
    
    SIdentityException
  - updateRole
```
public SRole updateRole(SRole role,
                        EntityUpdateDescriptor descriptor,
                        EntityUpdateDescriptor iconUpdater)
                 throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Update role according to the descriptor
    
    Specified by:
    
    updateRole in interface IdentityService
    
    Parameters:
    
    role - The role will be updated
    
    descriptor - The update description
    
    Throws:
    
    SIdentityException
  - updateUser
```
public void updateUser(SUser user,
                       EntityUpdateDescriptor descriptor)
                throws SUserUpdateException
```
    Description copied from interface: IdentityService
    
    Update SUser according to the EntityUpdateDescriptor
    
    Specified by:
    
    updateUser in interface IdentityService
    
    Parameters:
    
    user - The SUser to update
    
    descriptor - The SUser contents to update
    
    Throws:
    
    SUserUpdateException - occurs on persistence layer access problem
  - updateUser
```
@Deprecated
public void updateUser(SUser user,
                                   EntityUpdateDescriptor descriptor,
                                   boolean isPasswordEncrypted)
                            throws SUserUpdateException
```
    Deprecated.
    
    Description copied from interface: IdentityService
    
    Update SUser according to the EntityUpdateDescriptor
    
    Specified by:
    
    updateUser in interface IdentityService
    
    Parameters:
    
    user - The SUser to update
    
    descriptor - The SUser contents to update
    
    isPasswordEncrypted - allow to know if the password given in the EntityUpdateDescriptor is encrypted or not
    
    Throws:
    
    SUserUpdateException
  - updateUserContactInfo
```
public void updateUserContactInfo(SContactInfo contactInfo,
                                  EntityUpdateDescriptor descriptor)
                           throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Update user contact information according to the descriptor
    
    Specified by:
    
    updateUserContactInfo in interface IdentityService
    
    Parameters:
    
    contactInfo - The user contact information to be updated
    
    descriptor - The update description
    
    Throws:
    
    SUserUpdateException
    
    SIdentityException
  - updateUserMembership
```
public void updateUserMembership(SUserMembership userMembership,
                                 EntityUpdateDescriptor descriptor)
                          throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Update userMembership according to the descriptor
    
    Specified by:
    
    updateUserMembership in interface IdentityService
    
    Parameters:
    
    userMembership - The userMembership will be updated
    
    descriptor - The update description
    
    Throws:
    
    SIdentityException
  - getUserMemberships
```
public java.util.List<SUserMembership> getUserMemberships(int fromIndex,
                                                          int numberOfUserMemberships)
                                                   throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUserMembership from specific interval
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getUserMemberships in interface IdentityService
    
    Parameters:
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUserMemberships - Number of result to retrieve
    
    Returns:
    
    a List of SUserMembership
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getUserMembershipsOfUser
```
public java.util.List<SUserMembership> getUserMembershipsOfUser(long userId,
                                                                int fromIndex,
                                                                int numberOfUsers)
                                                         throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get SUserMembership for a specific interval for a given user
    
    Specified by:
    
    getUserMembershipsOfUser in interface IdentityService
    
    Parameters:
    
    userId - The user's identifier
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfUsers - Number of result to retrieve
    
    Returns:
    
    a List of SUserMembership
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getUserMembershipsOfUser
```
public java.util.List<SUserMembership> getUserMembershipsOfUser(long userId,
                                                                int fromIndex,
                                                                int numberOfMemberships,
                                                                java.lang.String field,
                                                                OrderByType order)
                                                         throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUserMembership of a given user from specific interval, sorted by field attribute in the given OrderByType sortOrder order.
    For instance, getUserMembershipsOfUser(1,0,10,"id", OrderByType.DESC) returns the 10 first SUserMembership of the given user sorted by "id" in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    check SUserMembershipBuilderFactory to check available field keys to sort
    
    Specified by:
    
    getUserMembershipsOfUser in interface IdentityService
    
    Parameters:
    
    userId - The identifier of user
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfMemberships - Number of result to retrieve
    
    field - The field user to do order
    
    order - ASC or DESC
    
    Returns:
    
    a List of SUserMembership
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
    
    See Also:
    
    SUserMembershipBuilderFactory
  - getUserMembershipsOfUser
```
public java.util.List<SUserMembership> getUserMembershipsOfUser(long userId,
                                                                int fromIndex,
                                                                int numberPerPage,
                                                                OrderByOption orderByOption)
                                                         throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get a List of SUserMembership of a given user from specific interval, sorted by default field in the given OrderByType sortOrder order.
    For instance, getUserMembershipsOfUser(1,0,10, OrderByType.DESC) returns the 10 first SUserMembership of the given user sorted by the default field in desc order
    If the number of existing results are lower than the number asked, all results from the given index are retrieved.
    
    Specified by:
    
    getUserMembershipsOfUser in interface IdentityService
    
    Parameters:
    
    userId - The identifier of user
    
    fromIndex - Index of the record to be retrieved from. First record has index 0
    
    numberPerPage - Number of result o retrieve
    
    orderByOption - OrderByOption object containing order information
    
    Returns:
    
    a list of SUserMembership objects
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getUserMembership
```
public SUserMembership getUserMembership(long userId,
                                         long groupId,
                                         long roleId)
                                  throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get SUserMembership of specific SUser, SGroup and SRole
    
    Specified by:
    
    getUserMembership in interface IdentityService
    
    Parameters:
    
    userId - The user's identifier
    
    groupId - The group's identifier
    
    roleId - The role's identifier
    
    Returns:
    
    the SUserMembership
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem or if the SUserMembership does not exists
  - getLightUserMembership
```
public SUserMembership getLightUserMembership(long userId,
                                              long groupId,
                                              long roleId)
                                       throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get the SUserMembership of the specific user, group and role without userName, groupName and roleName being set.
    
    Specified by:
    
    getLightUserMembership in interface IdentityService
    
    Parameters:
    
    userId - The user's identifier
    
    groupId - The group's identifier
    
    roleId - The role's identifier
    
    Returns:
    
    the lightened SUserMembership
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem or if the SUserMembership does not exists
  - getNumberOfUserMemberships
```
public long getNumberOfUserMemberships()
                                throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get total number of userMemberships of the current tenant
    
    Specified by:
    
    getNumberOfUserMemberships in interface IdentityService
    
    Returns:
    
    total number of userMemberships
    
    Throws:
    
    SIdentityException - occurs on persistence layer access problem
  - getLightUserMemberships
```
public java.util.List<SUserMembership> getLightUserMemberships(int startIndex,
                                                               int numberOfElements)
                                                        throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Get light userMembership in a specific interval, this is used for pagination
    
    Specified by:
    
    getLightUserMemberships in interface IdentityService
    
    Parameters:
    
    startIndex - Index of the record to be retrieved from. First record has index 0
    
    numberOfElements - Number of result we want to get. Maximum number of result returned.
    
    Returns:
    
    a list of SUserMembership objects without userName, groupName and roleName
    
    Throws:
    
    SIdentityException
  - getNumberOfUsers
```
public long getNumberOfUsers(QueryOptions options)
                      throws SBonitaReadException
```
    Description copied from interface: IdentityService
    
    Get total number of users according to specific query options
    
    Specified by:
    
    getNumberOfUsers in interface IdentityService
    
    Parameters:
    
    options - The QueryOptions object containing some query conditions
    
    Returns:
    
    the satisfied user number
    
    Throws:
    
    SBonitaReadException
  - searchUsers
```
public java.util.List<SUser> searchUsers(QueryOptions options)
                                  throws SBonitaReadException
```
    Description copied from interface: IdentityService
    
    Search users according to specific query options
    
    Specified by:
    
    searchUsers in interface IdentityService
    
    Parameters:
    
    options - The QueryOptions object containing some query conditions
    
    Returns:
    
    a list of SUser objects
    
    Throws:
    
    SBonitaReadException
  - getNumberOfRoles
```
public long getNumberOfRoles(QueryOptions options)
                      throws SBonitaReadException
```
    Description copied from interface: IdentityService
    
    Get total number of roles according to specific query options
    
    Specified by:
    
    getNumberOfRoles in interface IdentityService
    
    Parameters:
    
    options - The QueryOptions object containing some query conditions
    
    Returns:
    
    the satisfied role number
    
    Throws:
    
    SBonitaReadException
  - searchRoles
```
public java.util.List<SRole> searchRoles(QueryOptions options)
                                  throws SBonitaReadException
```
    Description copied from interface: IdentityService
    
    Search roles according to specific query options
    
    Specified by:
    
    searchRoles in interface IdentityService
    
    Parameters:
    
    options - The QueryOptions object containing some query conditions
    
    Returns:
    
    a list of SRole objects
    
    Throws:
    
    SBonitaReadException
  - getNumberOfGroups
```
public long getNumberOfGroups(QueryOptions options)
                       throws SBonitaReadException
```
    Description copied from interface: IdentityService
    
    Get total number of groups according to specific query options
    
    Specified by:
    
    getNumberOfGroups in interface IdentityService
    
    Parameters:
    
    options - The QueryOptions object containing some query conditions
    
    Returns:
    
    the group number
    
    Throws:
    
    SBonitaReadException
  - searchGroups
```
public java.util.List<SGroup> searchGroups(QueryOptions options)
                                    throws SBonitaReadException
```
    Description copied from interface: IdentityService
    
    Search groups according to specific query options
    
    Specified by:
    
    searchGroups in interface IdentityService
    
    Parameters:
    
    options - The QueryOptions object containing some query conditions
    
    Returns:
    
    a list of SGroup objects
    
    Throws:
    
    SBonitaReadException
  - checkCredentials
```
public boolean checkCredentials(SUser user,
                                java.lang.String password)
```
    Description copied from interface: IdentityService
    
    Checks whether the couple user/password is valid.
    
    Specified by:
    
    checkCredentials in interface IdentityService
    
    Parameters:
    
    user - the user
    
    password - the password
    
    Returns:
    
    true if the couple user/password is valid; false otherwise
  - searchCustomUserInfoValue
```
public java.util.List<SCustomUserInfoValue> searchCustomUserInfoValue(QueryOptions options)
                                                               throws SBonitaReadException
```
    Description copied from interface: IdentityService
    
    Search SCustomUserInfoValue matching the criterias of the given QueryOptions
    
    Specified by:
    
    searchCustomUserInfoValue in interface IdentityService
    
    Parameters:
    
    options - The QueryOptions object containing some query conditions
    
    Returns:
    
    a list of SCustomUserInfoValue objects
    
    Throws:
    
    SBonitaReadException - occurs on persistence layer access problem or if search parameters are not correct
  - getCustomUserInfoValueOfUserAndDefinitions
```
public java.util.List<SCustomUserInfoValue> getCustomUserInfoValueOfUserAndDefinitions(long userId,
                                                                                       java.util.List<java.lang.Long> definitionsIds)
                                                                                throws SBonitaReadException
```
    Description copied from interface: IdentityService
    
    Get SCustomUserInfoValues of definitions for a user
    
    Specified by:
    
    getCustomUserInfoValueOfUserAndDefinitions in interface IdentityService
    
    Throws:
    
    SBonitaReadException
  - updateUser
```
public SUser updateUser(long userId,
                        EntityUpdateDescriptor userUpdateDescriptor,
                        EntityUpdateDescriptor personalDataUpdateDescriptor,
                        EntityUpdateDescriptor professionalDataUpdateDescriptor,
                        EntityUpdateDescriptor iconUpdater)
                 throws SIdentityException
```
    Description copied from interface: IdentityService
    
    Update the user having id userId according to the entity update descriptors in parameters
    
    Specified by:
    
    updateUser in interface IdentityService
    
    Parameters:
    
    userId - the user to update
    
    userUpdateDescriptor - the entity update descriptor of the user itself
    
    personalDataUpdateDescriptor - the entity update descriptor for the personal data
    
    professionalDataUpdateDescriptor - the entity update descriptor for the professional data
    
    Returns:
    
    the updated user
    
    Throws:
    
    SIdentityException
  - createUser
```
public SUser createUser(SUser sUser,
                        SContactInfo personalContactInfo,
                        SContactInfo proContactInfo,
                        java.lang.String iconFilename,
                        byte[] iconContent)
                 throws SUserCreationException
```
    Description copied from interface: IdentityService
    
    create a new user in database along with its contact data
    
    Specified by:
    
    createUser in interface IdentityService
    
    Parameters:
    
    sUser - the user to persist
    
    personalContactInfo - its personal contact info
    
    proContactInfo - its professional contact info
    
    iconFilename - original name of the icon, used to determine the mime type
    
    iconContent - content of the icon
    
    Returns:
    
    the user persisted
    
    Throws:
    
    SUserCreationException
  - getIcon
```
public SIcon getIcon(long id)
              throws SBonitaReadException
```
    Description copied from interface: IdentityService
    
    get the icon using its id
    
    Specified by:
    
    getIcon in interface IdentityService
    
    Parameters:
    
    id - id of the icon
    
    Returns:
    
    the icon
    
    Throws:
    
    SBonitaReadException

Class IdentityServiceImpl

Field Summary

Fields inherited from interface org.bonitasoft.engine.identity.IdentityService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IdentityServiceImpl

Method Detail

createGroup

createCustomUserInfoDefinition

createCustomUserInfoValue

createRole

createUser

createUserWithoutEncryptingPassword

createUserContactInfo

createUserMembership

deleteGroup

deleteGroup

deleteAllGroups

deleteChildrenGroup

deleteCustomUserInfoDefinition

deleteCustomUserInfoDefinition

deleteCustomUserInfoValue

deleteCustomUserInfoValue

deleteRole

deleteRole

deleteAllRoles

deleteUser

deleteUser

deleteAllUsers

getLightUserMembership

deleteUserMembership

deleteUserMembership

deleteLightUserMembership

deleteAllUserMemberships

getGroup

getGroupChildren

getGroupChildren

getGroups

getGroups

getGroups

getUserMemberships

getUserMembershipsOfGroup

getUserMembershipsOfRole

getNumberOfGroupChildren

getNumberOfGroups

getNumberOfCustomUserInfoDefinition

getNumberOfCustomUserInfoValue

getNumberOfRoles

getNumberOfUsers

getNumberOfUserMembershipsOfUser

getNumberOfUsersByGroup

getNumberOfUsersByRole

getNumberOfUsersByMembership

getCustomUserInfoDefinitionByName

hasCustomUserInfoDefinition

getCustomUserInfoDefinitions

getUserIdsWithCustomUserInfo

getCustomUserInfoDefinition

getCustomUserInfoDefinitions

getCustomUserInfoValue

getCustomUserInfoValues

getRole

getRoleByName

getGroupByPath

getRoles

getRoles

getRoles

getUser

getUserContactInfo

getUserByUserName

getUserMembership

getUserMemberships

getUsers

getUsers

getUsers

getUsersByUsername

getUsersInGroup

getActiveUsersInGroup