org.flowable.idm.engine.impl

Class IdmIdentityServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<IdmEngineConfiguration>

org.flowable.idm.engine.impl.IdmIdentityServiceImpl

All Implemented Interfaces:

IdmIdentityService

Direct Known Subclasses:

KeycloakIdentityServiceImpl, LDAPIdentityServiceImpl

public class IdmIdentityServiceImpl
extends CommonEngineServiceImpl<IdmEngineConfiguration>
implements IdmIdentityService

Author:

Tijs Rademakers

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor and Description
IdmIdentityServiceImpl(IdmEngineConfiguration idmEngineConfiguration)

Method Summary

Modifier and Type	Method and Description
void	addGroupPrivilegeMapping(String privilegeId, String groupId) Assigns a privilege to a group.
void	addUserPrivilegeMapping(String privilegeId, String userId) Assigns a privilege to a user.
boolean	checkPassword(String userId, String password) Checks if the password is valid for the given user.
GroupQuery	createGroupQuery() Creates a GroupQuery that allows to programmatically query the groups.
void	createMembership(String userId, String groupId)
NativeGroupQuery	createNativeGroupQuery() Returns a new NativeQuery for tasks.
NativeTokenQuery	createNativeTokenQuery() Returns a new NativeQuery for tokens.
NativeUserQuery	createNativeUserQuery() Returns a new NativeQuery for tasks.
Privilege	createPrivilege(String name) Creates a new Privilege with the provided name.
PrivilegeQuery	createPrivilegeQuery() Creates a PrivilegeQuery that allows to programmatically query privileges.
TokenQuery	createTokenQuery() Creates a TokenQuery that allows to programmatically query the tokens.
UserQuery	createUserQuery() Creates a UserQuery that allows to programmatically query the users.
void	deleteGroup(String groupId) Deletes the group.
void	deleteGroupPrivilegeMapping(String privilegeId, String groupId) Delete a privilege for a group.
void	deleteMembership(String userId, String groupId) Delete the membership of the user in the group.
void	deletePrivilege(String id) Deletes the privilege with the given id.
void	deleteToken(String tokenId)
void	deleteUser(String userId)
void	deleteUserInfo(String userId, String key) Delete an entry of the generic extensibility key-value pairs associated with a user
void	deleteUserPrivilegeMapping(String privilegeId, String userId) Removes a privilege for a user.
List<Group>	getGroupsWithPrivilege(String name) Returns all Group instances that have a particular privilege.
List<PrivilegeMapping>	getPrivilegeMappingsByPrivilegeId(String privilegeId) Get all privilege mappings for a specific privilege
String	getUserInfo(String userId, String key) Generic extensibility key-value pairs associated with a user
List<String>	getUserInfoKeys(String userId) Generic extensibility keys associated with a user
Picture	getUserPicture(String userId) Retrieves the picture for a given user.
List<User>	getUsersWithPrivilege(String name) Returns all User instances that have a particular privilege.
Group	newGroup(String groupId) Creates a new group.
Token	newToken(String tokenId) Creates a new token.
User	newUser(String userId) Creates a new user.
void	saveGroup(Group group) Saves the group.
void	saveToken(Token token) Saves the token.
void	saveUser(User user) Saves the user.
void	setAuthenticatedUserId(String authenticatedUserId) Passes the authenticated user id for this particular thread.
void	setUserInfo(String userId, String key, String value) Generic extensibility key-value pairs associated with a user
void	setUserPicture(String userId, Picture picture) Sets the picture for a given user.
void	updateUserPassword(User user) Update user password.

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

IdmIdentityServiceImpl

public IdmIdentityServiceImpl(IdmEngineConfiguration idmEngineConfiguration)

Method Detail

newGroup

public Group newGroup(String groupId)

Description copied from interface: IdmIdentityService

Creates a new group. The group is transient and must be saved using IdmIdentityService.saveGroup(Group).

Specified by:

newGroup in interface IdmIdentityService

Parameters:

groupId - id for the new group, cannot be null.

newUser

public User newUser(String userId)

Description copied from interface: IdmIdentityService

Creates a new user. The user is transient and must be saved using IdmIdentityService.saveUser(User).

Specified by:

newUser in interface IdmIdentityService

Parameters:

userId - id for the new user, cannot be null.

saveGroup

public void saveGroup(Group group)

Description copied from interface: IdmIdentityService

Saves the group. If the group already existed, the group is updated.

Specified by:

saveGroup in interface IdmIdentityService

Parameters:

group - group to save. Cannot be null.

saveUser

public void saveUser(User user)

Description copied from interface: IdmIdentityService

Saves the user. If the user already existed, the user is updated except user password. Use IdmIdentityService.updateUserPassword(User) to update existing user password.

Specified by:

saveUser in interface IdmIdentityService

Parameters:

user - user to save, cannot be null.

See Also:

IdmIdentityService.updateUserPassword(User)

updateUserPassword

public void updateUserPassword(User user)

Description copied from interface: IdmIdentityService

Update user password. Use IdmIdentityService.saveUser(User) for new user.

Specified by:

updateUserPassword in interface IdmIdentityService

Parameters:

user - user password to change, cannot be null.

See Also:

IdmIdentityService.saveUser(User)

createUserQuery

public UserQuery createUserQuery()

Description copied from interface: IdmIdentityService

Creates a UserQuery that allows to programmatically query the users.

Specified by:

createUserQuery in interface IdmIdentityService

createNativeUserQuery

public NativeUserQuery createNativeUserQuery()

Description copied from interface: IdmIdentityService

Returns a new NativeQuery for tasks.

Specified by:

createNativeUserQuery in interface IdmIdentityService

createGroupQuery

public GroupQuery createGroupQuery()

Description copied from interface: IdmIdentityService

Creates a GroupQuery that allows to programmatically query the groups.

Specified by:

createGroupQuery in interface IdmIdentityService

createNativeGroupQuery

public NativeGroupQuery createNativeGroupQuery()

Description copied from interface: IdmIdentityService

Returns a new NativeQuery for tasks.

Specified by:

createNativeGroupQuery in interface IdmIdentityService

createMembership

public void createMembership(String userId,
                             String groupId)

Specified by:

createMembership in interface IdmIdentityService

Parameters:

userId - the userId, cannot be null.

groupId - the groupId, cannot be null.

deleteGroup

public void deleteGroup(String groupId)

Description copied from interface: IdmIdentityService

Deletes the group. When no group exists with the given id, this operation is ignored.

Specified by:

deleteGroup in interface IdmIdentityService

Parameters:

groupId - id of the group that should be deleted, cannot be null.

deleteMembership

public void deleteMembership(String userId,
                             String groupId)

Description copied from interface: IdmIdentityService

Delete the membership of the user in the group. When the group or user don't exist or when the user is not a member of the group, this operation is ignored.

Specified by:

deleteMembership in interface IdmIdentityService

Parameters:

userId - the user's id, cannot be null.

groupId - the group's id, cannot be null.

checkPassword

public boolean checkPassword(String userId,
                             String password)

Description copied from interface: IdmIdentityService

Checks if the password is valid for the given user. Arguments userId and password are nullsafe.

Specified by:

checkPassword in interface IdmIdentityService

setAuthenticatedUserId

public void setAuthenticatedUserId(String authenticatedUserId)

Description copied from interface: IdmIdentityService

Passes the authenticated user id for this particular thread. All service method (from any service) invocations done by the same thread will have access to this authenticatedUserId.

Specified by:

setAuthenticatedUserId in interface IdmIdentityService

deleteUser

public void deleteUser(String userId)

Specified by:

deleteUser in interface IdmIdentityService

Parameters:

userId - id of user to delete, cannot be null. When an id is passed for a non-existent user, this operation is ignored.

newToken

public Token newToken(String tokenId)

Description copied from interface: IdmIdentityService

Creates a new token. The token is transient and must be saved using IdmIdentityService.saveToken(Token).

Specified by:

newToken in interface IdmIdentityService

Parameters:

tokenId - id for the new token, cannot be null.

saveToken

public void saveToken(Token token)

Description copied from interface: IdmIdentityService

Saves the token. If the token already existed, the token is updated.

Specified by:

saveToken in interface IdmIdentityService

Parameters:

token - token to save, cannot be null.

deleteToken

public void deleteToken(String tokenId)

Specified by:

deleteToken in interface IdmIdentityService

Parameters:

tokenId - id of token to delete, cannot be null. When an id is passed for an non-existent token, this operation is ignored.

createTokenQuery

public TokenQuery createTokenQuery()

Description copied from interface: IdmIdentityService

Creates a TokenQuery that allows to programmatically query the tokens.

Specified by:

createTokenQuery in interface IdmIdentityService

createNativeTokenQuery

public NativeTokenQuery createNativeTokenQuery()

Description copied from interface: IdmIdentityService

Returns a new NativeQuery for tokens.

Specified by:

createNativeTokenQuery in interface IdmIdentityService

setUserPicture

public void setUserPicture(String userId,
                           Picture picture)

Description copied from interface: IdmIdentityService

Sets the picture for a given user.

Specified by:

setUserPicture in interface IdmIdentityService

picture - can be null to delete the picture.

getUserPicture

public Picture getUserPicture(String userId)

Description copied from interface: IdmIdentityService

Retrieves the picture for a given user.

Specified by:

getUserPicture in interface IdmIdentityService

Returns:

null if the user doesn't have a picture.

getUserInfo

public String getUserInfo(String userId,
                          String key)

Description copied from interface: IdmIdentityService

Generic extensibility key-value pairs associated with a user

Specified by:

getUserInfo in interface IdmIdentityService

getUserInfoKeys

public List<String> getUserInfoKeys(String userId)

Description copied from interface: IdmIdentityService

Generic extensibility keys associated with a user

Specified by:

getUserInfoKeys in interface IdmIdentityService

setUserInfo

public void setUserInfo(String userId,
                        String key,
                        String value)

Description copied from interface: IdmIdentityService

Generic extensibility key-value pairs associated with a user

Specified by:

setUserInfo in interface IdmIdentityService

deleteUserInfo

public void deleteUserInfo(String userId,
                           String key)

Description copied from interface: IdmIdentityService

Delete an entry of the generic extensibility key-value pairs associated with a user

Specified by:

deleteUserInfo in interface IdmIdentityService

createPrivilege

public Privilege createPrivilege(String name)

Description copied from interface: IdmIdentityService

Creates a new Privilege with the provided name.

Specified by:

createPrivilege in interface IdmIdentityService

addUserPrivilegeMapping

public void addUserPrivilegeMapping(String privilegeId,
                                    String userId)

Description copied from interface: IdmIdentityService

Assigns a privilege to a user.

Specified by:

addUserPrivilegeMapping in interface IdmIdentityService

deleteUserPrivilegeMapping

public void deleteUserPrivilegeMapping(String privilegeId,
                                       String userId)

Description copied from interface: IdmIdentityService

Removes a privilege for a user.

Specified by:

deleteUserPrivilegeMapping in interface IdmIdentityService

addGroupPrivilegeMapping

public void addGroupPrivilegeMapping(String privilegeId,
                                     String groupId)

Description copied from interface: IdmIdentityService

Assigns a privilege to a group.

Specified by:

addGroupPrivilegeMapping in interface IdmIdentityService

deleteGroupPrivilegeMapping

public void deleteGroupPrivilegeMapping(String privilegeId,
                                        String groupId)

Description copied from interface: IdmIdentityService

Delete a privilege for a group.

Specified by:

deleteGroupPrivilegeMapping in interface IdmIdentityService

getPrivilegeMappingsByPrivilegeId

public List<PrivilegeMapping> getPrivilegeMappingsByPrivilegeId(String privilegeId)

Description copied from interface: IdmIdentityService

Get all privilege mappings for a specific privilege

Specified by:

getPrivilegeMappingsByPrivilegeId in interface IdmIdentityService

deletePrivilege

public void deletePrivilege(String id)

Description copied from interface: IdmIdentityService

Deletes the privilege with the given id. Note that this also removes all user/group mappings for this privilege.

Specified by:

deletePrivilege in interface IdmIdentityService

createPrivilegeQuery

public PrivilegeQuery createPrivilegeQuery()

Description copied from interface: IdmIdentityService

Creates a PrivilegeQuery that allows to programmatically query privileges.

Specified by:

createPrivilegeQuery in interface IdmIdentityService

getGroupsWithPrivilege

public List<Group> getGroupsWithPrivilege(String name)

Description copied from interface: IdmIdentityService

Returns all Group instances that have a particular privilege.

Specified by:

getGroupsWithPrivilege in interface IdmIdentityService

getUsersWithPrivilege

public List<User> getUsersWithPrivilege(String name)

Description copied from interface: IdmIdentityService

Returns all User instances that have a particular privilege.

Specified by:

getUsersWithPrivilege in interface IdmIdentityService