org.bonitasoft.engine.api.impl

Class IdentityAPIImpl

java.lang.Object

org.bonitasoft.engine.api.impl.IdentityAPIImpl

All Implemented Interfaces:

CustomUserInfoAPI, GroupAPI, IdentityAPI, MembershipAPI, OrganizationAPI, RoleAPI, UserAPI

public class IdentityAPIImpl
extends Object
implements IdentityAPI

Author:

Matthieu Chaffotte, Elias Ricken de Medeiros, Feng Hui, Zhang Bole, Yanyan Liu, Lu Kai, Hongwen Zang, Celine Souchet

Constructor Summary

Constructors

Constructor and Description
IdentityAPIImpl()

Method Summary

Methods

Modifier and Type	Method and Description
UserMembership	addUserMembership(long userId, long groupId, long roleId)
void	addUserMemberships(List<Long> userIds, long groupId, long roleId)
CustomUserInfoDefinition	createCustomUserInfoDefinition(CustomUserInfoDefinitionCreator creator)
Group	createGroup(GroupCreator creator)
Group	createGroup(String name, String parentPath)
Role	createRole(RoleCreator creator)
Role	createRole(String roleName)
User	createUser(String userName, String password)
User	createUser(String userName, String password, String firstName, String lastName)
User	createUser(UserCreator creator)
void	deleteCustomUserInfoDefinition(long id)
void	deleteGroup(long groupId)
void	deleteGroups(List<Long> groupIds)
void	deleteOrganization()
void	deleteRole(long roleId)
void	deleteRoles(List<Long> roleIds)
void	deleteUser(long userId)
void	deleteUser(String userName)
void	deleteUserMembership(long userMembershipId)
void	deleteUserMembership(long userId, long groupId, long roleId)
void	deleteUserMemberships(List<Long> userIds, long groupId, long roleId)
void	deleteUsers(List<Long> userIds)
String	exportOrganization()
List<CustomUserInfo>	getCustomUserInfo(long userId, int startIndex, int maxResult)
List<CustomUserInfoDefinition>	getCustomUserInfoDefinitions(int startIndex, int maxResult)
Group	getGroup(long groupId)
Group	getGroupByPath(String groupPath)
List<Group>	getGroups(int startIndex, int maxResults, GroupCriterion pagingCriterion)
Map<Long,Group>	getGroups(List<Long> groupIds)
Icon	getIcon(long id)
long	getNumberOfCustomInfoDefinitions()
long	getNumberOfGroups()
long	getNumberOfRoles()
long	getNumberOfUserMemberships(long userId)
long	getNumberOfUsers()
long	getNumberOfUsersInGroup(long groupId)
long	getNumberOfUsersInRole(long roleId)
Role	getRole(long roleId)
Role	getRoleByName(String roleName)
List<Role>	getRoles(int startIndex, int maxResults, RoleCriterion criterion)
Map<Long,Role>	getRoles(List<Long> roleIds)
protected TenantServiceAccessor	getTenantAccessor()
User	getUser(long userId)
User	getUserByUserName(String userName)
ContactData	getUserContactData(long userId, boolean personal)
List<Long>	getUserIdsWithCustomUserInfo(String infoName, String infoValue, boolean usePartialMatch, int startIndex, int maxResults)
UserMembership	getUserMembership(long userMembershipId)
List<UserMembership>	getUserMemberships(long userId, int startIndex, int maxResults, UserMembershipCriterion pagingCrterion)
List<UserMembership>	getUserMembershipsByGroup(long groupId, int startIndex, int maxResults)
List<UserMembership>	getUserMembershipsByRole(long roleId, int startIndex, int maxResults)
List<User>	getUsers(int startIndex, int maxResults, UserCriterion criterion)
Map<Long,User>	getUsers(List<Long> userIds)
Map<String,User>	getUsersByUsernames(List<String> userNames)
List<User>	getUsersInGroup(long groupId, int startIndex, int maxResults, UserCriterion crterion)
List<User>	getUsersInRole(long roleId, int startIndex, int maxResults, UserCriterion criterion)
UserWithContactData	getUserWithProfessionalDetails(long userId)
void	importOrganization(String organizationContent)
void	importOrganization(String organizationContent, ImportPolicy policy)
SearchResult<CustomUserInfoValue>	searchCustomUserInfoValues(SearchOptions options)
SearchResult<Group>	searchGroups(SearchOptions options)
SearchResult<Role>	searchRoles(SearchOptions options)
SearchResult<User>	searchUsers(SearchOptions options)
CustomUserInfoValue	setCustomUserInfoValue(long definitionId, long userId, String value)
Group	updateGroup(long groupId, GroupUpdater updater)
Role	updateRole(long roleId, RoleUpdater updateDescriptor)
User	updateUser(long userId, UserUpdater updater)
UserMembership	updateUserMembership(long userMembershipId, long newGroupId, long newRoleId)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityAPIImpl

public IdentityAPIImpl()

Method Detail

getTenantAccessor

protected TenantServiceAccessor getTenantAccessor()

createUser

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

Specified by:

createUser in interface UserAPI

Throws:

AlreadyExistsException

CreationException

createUser

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

Specified by:

createUser in interface UserAPI

Throws:

AlreadyExistsException

CreationException

createUser

public User createUser(UserCreator creator)
                throws CreationException

Specified by:

createUser in interface UserAPI

Throws:

CreationException

updateUser

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

Specified by:

updateUser in interface UserAPI

Throws:

UserNotFoundException

UpdateException

deleteUser

public void deleteUser(long userId)
                throws DeletionException

Specified by:

deleteUser in interface UserAPI

Throws:

DeletionException

deleteUser

public void deleteUser(String userName)
                throws DeletionException

Specified by:

deleteUser in interface UserAPI

Throws:

DeletionException

deleteUsers

public void deleteUsers(List<Long> userIds)
                 throws DeletionException

Specified by:

deleteUsers in interface UserAPI

Throws:

DeletionException

getUser

public User getUser(long userId)
             throws UserNotFoundException

Specified by:

getUser in interface UserAPI

Throws:

UserNotFoundException

getUserByUserName

public User getUserByUserName(String userName)
                       throws UserNotFoundException

Specified by:

getUserByUserName in interface UserAPI

Throws:

UserNotFoundException

getUserWithProfessionalDetails

public UserWithContactData getUserWithProfessionalDetails(long userId)
                                                   throws UserNotFoundException

Specified by:

getUserWithProfessionalDetails in interface UserAPI

Throws:

UserNotFoundException

getUserContactData

public ContactData getUserContactData(long userId,
                             boolean personal)
                               throws UserNotFoundException

Specified by:

getUserContactData in interface UserAPI

Throws:

UserNotFoundException

getNumberOfUsers

public long getNumberOfUsers()

Specified by:

getNumberOfUsers in interface UserAPI

getUsers

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

Specified by:

getUsers in interface UserAPI

getUsers

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

Specified by:

getUsers in interface UserAPI

getUsersByUsernames

public Map<String,User> getUsersByUsernames(List<String> userNames)

Specified by:

getUsersByUsernames in interface UserAPI

searchUsers

public SearchResult<User> searchUsers(SearchOptions options)
                               throws SearchException

Specified by:

searchUsers in interface UserAPI

Throws:

SearchException

getNumberOfUsersInRole

public long getNumberOfUsersInRole(long roleId)

Specified by:

getNumberOfUsersInRole in interface UserAPI

getUsersInRole

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

Specified by:

getUsersInRole in interface UserAPI

getNumberOfUsersInGroup

public long getNumberOfUsersInGroup(long groupId)

Specified by:

getNumberOfUsersInGroup in interface UserAPI

getUsersInGroup

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

Specified by:

getUsersInGroup in interface UserAPI

getUserIdsWithCustomUserInfo

public List<Long> getUserIdsWithCustomUserInfo(String infoName,
                                      String infoValue,
                                      boolean usePartialMatch,
                                      int startIndex,
                                      int maxResults)

Specified by:

getUserIdsWithCustomUserInfo in interface UserAPI

createRole

public Role createRole(String roleName)
                throws AlreadyExistsException,
                       CreationException

Specified by:

createRole in interface RoleAPI

Throws:

AlreadyExistsException

CreationException

createRole

public Role createRole(RoleCreator creator)
                throws AlreadyExistsException,
                       CreationException

Specified by:

createRole in interface RoleAPI

Throws:

AlreadyExistsException

CreationException

updateRole

public Role updateRole(long roleId,
              RoleUpdater updateDescriptor)
                throws RoleNotFoundException,
                       UpdateException

Specified by:

updateRole in interface RoleAPI

Throws:

RoleNotFoundException

UpdateException

deleteRole

public void deleteRole(long roleId)
                throws DeletionException

Specified by:

deleteRole in interface RoleAPI

Throws:

DeletionException

deleteRoles

public void deleteRoles(List<Long> roleIds)
                 throws DeletionException

Specified by:

deleteRoles in interface RoleAPI

Throws:

DeletionException

getRole

public Role getRole(long roleId)
             throws RoleNotFoundException

Specified by:

getRole in interface RoleAPI

Throws:

RoleNotFoundException

getRoleByName

public Role getRoleByName(String roleName)
                   throws RoleNotFoundException

Specified by:

getRoleByName in interface RoleAPI

Throws:

RoleNotFoundException

getNumberOfRoles

public long getNumberOfRoles()

Specified by:

getNumberOfRoles in interface RoleAPI

getRoles

public List<Role> getRoles(int startIndex,
                  int maxResults,
                  RoleCriterion criterion)

Specified by:

getRoles in interface RoleAPI

getRoles

public Map<Long,Role> getRoles(List<Long> roleIds)

Specified by:

getRoles in interface RoleAPI

searchRoles

public SearchResult<Role> searchRoles(SearchOptions options)

Specified by:

searchRoles in interface RoleAPI

createGroup

public Group createGroup(String name,
                String parentPath)
                  throws CreationException

Specified by:

createGroup in interface GroupAPI

Throws:

CreationException

createGroup

public Group createGroup(GroupCreator creator)
                  throws CreationException

Specified by:

createGroup in interface GroupAPI

Throws:

CreationException

updateGroup

public Group updateGroup(long groupId,
                GroupUpdater updater)
                  throws GroupNotFoundException,
                         UpdateException

Specified by:

updateGroup in interface GroupAPI

Throws:

GroupNotFoundException

UpdateException

deleteGroup

public void deleteGroup(long groupId)
                 throws DeletionException

Specified by:

deleteGroup in interface GroupAPI

Throws:

DeletionException

deleteGroups

public void deleteGroups(List<Long> groupIds)
                  throws DeletionException

Specified by:

deleteGroups in interface GroupAPI

Throws:

DeletionException

getGroup

public Group getGroup(long groupId)
               throws GroupNotFoundException

Specified by:

getGroup in interface GroupAPI

Throws:

GroupNotFoundException

getGroupByPath

public Group getGroupByPath(String groupPath)
                     throws GroupNotFoundException

Specified by:

getGroupByPath in interface GroupAPI

Throws:

GroupNotFoundException

getNumberOfGroups

public long getNumberOfGroups()

Specified by:

getNumberOfGroups in interface GroupAPI

getGroups

public Map<Long,Group> getGroups(List<Long> groupIds)

Specified by:

getGroups in interface GroupAPI

getGroups

public List<Group> getGroups(int startIndex,
                    int maxResults,
                    GroupCriterion pagingCriterion)

Specified by:

getGroups in interface GroupAPI

searchGroups

public SearchResult<Group> searchGroups(SearchOptions options)
                                 throws SearchException

Specified by:

searchGroups in interface GroupAPI

Throws:

SearchException

addUserMembership

public UserMembership addUserMembership(long userId,
                               long groupId,
                               long roleId)
                                 throws AlreadyExistsException,
                                        CreationException

Specified by:

addUserMembership in interface MembershipAPI

Throws:

AlreadyExistsException

CreationException

addUserMemberships

public void addUserMemberships(List<Long> userIds,
                      long groupId,
                      long roleId)
                        throws AlreadyExistsException,
                               CreationException

Specified by:

addUserMemberships in interface MembershipAPI

Throws:

AlreadyExistsException

CreationException

updateUserMembership

public UserMembership updateUserMembership(long userMembershipId,
                                  long newGroupId,
                                  long newRoleId)
                                    throws UpdateException

Specified by:

updateUserMembership in interface MembershipAPI

Throws:

UpdateException

deleteUserMembership

public void deleteUserMembership(long userMembershipId)
                          throws DeletionException

Specified by:

deleteUserMembership in interface MembershipAPI

Throws:

DeletionException

deleteUserMembership

public void deleteUserMembership(long userId,
                        long groupId,
                        long roleId)
                          throws DeletionException

Specified by:

deleteUserMembership in interface MembershipAPI

Throws:

DeletionException

deleteUserMemberships

public void deleteUserMemberships(List<Long> userIds,
                         long groupId,
                         long roleId)
                           throws DeletionException

Specified by:

deleteUserMemberships in interface MembershipAPI

Throws:

DeletionException

getUserMembership

public UserMembership getUserMembership(long userMembershipId)
                                 throws MembershipNotFoundException

Specified by:

getUserMembership in interface MembershipAPI

Throws:

MembershipNotFoundException

getNumberOfUserMemberships

public long getNumberOfUserMemberships(long userId)

Specified by:

getNumberOfUserMemberships in interface MembershipAPI

getUserMemberships

public List<UserMembership> getUserMemberships(long userId,
                                      int startIndex,
                                      int maxResults,
                                      UserMembershipCriterion pagingCrterion)

Specified by:

getUserMemberships in interface MembershipAPI

getUserMembershipsByGroup

public List<UserMembership> getUserMembershipsByGroup(long groupId,
                                             int startIndex,
                                             int maxResults)

Specified by:

getUserMembershipsByGroup in interface MembershipAPI

getUserMembershipsByRole

public List<UserMembership> getUserMembershipsByRole(long roleId,
                                            int startIndex,
                                            int maxResults)

Specified by:

getUserMembershipsByRole in interface MembershipAPI

deleteOrganization

public void deleteOrganization()
                        throws DeletionException

Specified by:

deleteOrganization in interface OrganizationAPI

Throws:

DeletionException

importOrganization

public void importOrganization(String organizationContent)
                        throws OrganizationImportException

Specified by:

importOrganization in interface OrganizationAPI

Throws:

OrganizationImportException

importOrganization

public void importOrganization(String organizationContent,
                      ImportPolicy policy)
                        throws OrganizationImportException

Specified by:

importOrganization in interface OrganizationAPI

Throws:

OrganizationImportException

exportOrganization

public String exportOrganization()
                          throws OrganizationExportException

Specified by:

exportOrganization in interface OrganizationAPI

Throws:

OrganizationExportException

createCustomUserInfoDefinition

public CustomUserInfoDefinition createCustomUserInfoDefinition(CustomUserInfoDefinitionCreator creator)
                                                        throws CreationException,
                                                               AlreadyExistsException

Specified by:

createCustomUserInfoDefinition in interface CustomUserInfoAPI

Throws:

CreationException

AlreadyExistsException

getCustomUserInfoDefinitions

public List<CustomUserInfoDefinition> getCustomUserInfoDefinitions(int startIndex,
                                                          int maxResult)
                                                            throws RetrieveException

Specified by:

getCustomUserInfoDefinitions in interface CustomUserInfoAPI

Throws:

RetrieveException

getNumberOfCustomInfoDefinitions

public long getNumberOfCustomInfoDefinitions()

Specified by:

getNumberOfCustomInfoDefinitions in interface CustomUserInfoAPI

deleteCustomUserInfoDefinition

public void deleteCustomUserInfoDefinition(long id)
                                    throws DeletionException

Specified by:

deleteCustomUserInfoDefinition in interface CustomUserInfoAPI

Throws:

DeletionException

getCustomUserInfo

public List<CustomUserInfo> getCustomUserInfo(long userId,
                                     int startIndex,
                                     int maxResult)

Specified by:

getCustomUserInfo in interface CustomUserInfoAPI

searchCustomUserInfoValues

public SearchResult<CustomUserInfoValue> searchCustomUserInfoValues(SearchOptions options)

Specified by:

searchCustomUserInfoValues in interface CustomUserInfoAPI

setCustomUserInfoValue

public CustomUserInfoValue setCustomUserInfoValue(long definitionId,
                                         long userId,
                                         String value)
                                           throws UpdateException

Specified by:

setCustomUserInfoValue in interface CustomUserInfoAPI

Throws:

UpdateException

getIcon

public Icon getIcon(long id)
             throws NotFoundException

Specified by:

getIcon in interface UserAPI

Throws:

NotFoundException