org.flowable.engine.impl

Class IdentityServiceImpl

java.lang.Object

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

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

org.flowable.engine.impl.IdentityServiceImpl

All Implemented Interfaces:

IdentityService

public class IdentityServiceImpl
extends CommonEngineServiceImpl<ProcessEngineConfigurationImpl>
implements IdentityService

Author:

Tom Baeyens

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
IdentityServiceImpl(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Summary

Modifier and Type	Method and Description
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.
NativeUserQuery	createNativeUserQuery() Returns a new NativeQuery for tasks.
UserQuery	createUserQuery() Creates a UserQuery that allows to programmatically query the users.
void	deleteGroup(String groupId) Deletes the group.
void	deleteMembership(String userId, String groupId) Delete the membership of the user in the group.
void	deleteUser(String userId)
void	deleteUserInfo(String userId, String key) Delete an entry of the generic extensibility key-value pairs associated with a user
protected IdmIdentityService	getIdmIdentityService()
List<Group>	getPotentialStarterGroups(String processDefinitionId) Returns the potential starter groups for a given process definition.
List<User>	getPotentialStarterUsers(String processDefinitionId) Returns the potential starter users for a given process definition.
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.
Group	newGroup(String groupId) Creates a new group.
User	newUser(String userId) Creates a new user.
void	saveGroup(Group group) Saves the group.
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

IdentityServiceImpl

public IdentityServiceImpl(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Detail

newGroup

public Group newGroup(String groupId)

Description copied from interface: IdentityService

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

Specified by:

newGroup in interface IdentityService

Parameters:

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

newUser

public User newUser(String userId)

Description copied from interface: IdentityService

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

Specified by:

newUser in interface IdentityService

Parameters:

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

saveGroup

public void saveGroup(Group group)

Description copied from interface: IdentityService

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

Specified by:

saveGroup in interface IdentityService

Parameters:

group - group to save. Cannot be null.

saveUser

public void saveUser(User user)

Description copied from interface: IdentityService

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

Specified by:

saveUser in interface IdentityService

Parameters:

user - user to save, cannot be null.

See Also:

IdentityService.updateUserPassword(User)

updateUserPassword

public void updateUserPassword(User user)

Description copied from interface: IdentityService

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

Specified by:

updateUserPassword in interface IdentityService

Parameters:

user - user password to change, cannot be null.

See Also:

IdentityService.saveUser(User)

createUserQuery

public UserQuery createUserQuery()

Description copied from interface: IdentityService

Creates a UserQuery that allows to programmatically query the users.

Specified by:

createUserQuery in interface IdentityService

createNativeUserQuery

public NativeUserQuery createNativeUserQuery()

Description copied from interface: IdentityService

Returns a new NativeQuery for tasks.

Specified by:

createNativeUserQuery in interface IdentityService

createGroupQuery

public GroupQuery createGroupQuery()

Description copied from interface: IdentityService

Creates a GroupQuery that allows to programmatically query the groups.

Specified by:

createGroupQuery in interface IdentityService

createNativeGroupQuery

public NativeGroupQuery createNativeGroupQuery()

Description copied from interface: IdentityService

Returns a new NativeQuery for tasks.

Specified by:

createNativeGroupQuery in interface IdentityService

getPotentialStarterGroups

public List<Group> getPotentialStarterGroups(String processDefinitionId)

Description copied from interface: IdentityService

Returns the potential starter groups for a given process definition.

Specified by:

getPotentialStarterGroups in interface IdentityService

Parameters:

processDefinitionId - process definition identifier

Returns:

list of potential starter groups

getPotentialStarterUsers

public List<User> getPotentialStarterUsers(String processDefinitionId)

Description copied from interface: IdentityService

Returns the potential starter users for a given process definition.

Specified by:

getPotentialStarterUsers in interface IdentityService

Parameters:

processDefinitionId - process definition identifier

Returns:

list of potential starter users

createMembership

public void createMembership(String userId,
                             String groupId)

Specified by:

createMembership in interface IdentityService

Parameters:

userId - the userId, cannot be null.

groupId - the groupId, cannot be null.

deleteGroup

public void deleteGroup(String groupId)

Description copied from interface: IdentityService

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

Specified by:

deleteGroup in interface IdentityService

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: IdentityService

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 IdentityService

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: IdentityService

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

Specified by:

checkPassword in interface IdentityService

deleteUser

public void deleteUser(String userId)

Specified by:

deleteUser in interface IdentityService

Parameters:

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

setUserPicture

public void setUserPicture(String userId,
                           Picture picture)

Description copied from interface: IdentityService

Sets the picture for a given user.

Specified by:

setUserPicture in interface IdentityService

picture - can be null to delete the picture.

getUserPicture

public Picture getUserPicture(String userId)

Description copied from interface: IdentityService

Retrieves the picture for a given user.

Specified by:

getUserPicture in interface IdentityService

Returns:

null if the user doesn't have a picture.

setAuthenticatedUserId

public void setAuthenticatedUserId(String authenticatedUserId)

Description copied from interface: IdentityService

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 IdentityService

getUserInfo

public String getUserInfo(String userId,
                          String key)

Description copied from interface: IdentityService

Generic extensibility key-value pairs associated with a user

Specified by:

getUserInfo in interface IdentityService

getUserInfoKeys

public List<String> getUserInfoKeys(String userId)

Description copied from interface: IdentityService

Generic extensibility keys associated with a user

Specified by:

getUserInfoKeys in interface IdentityService

setUserInfo

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

Description copied from interface: IdentityService

Generic extensibility key-value pairs associated with a user

Specified by:

setUserInfo in interface IdentityService

deleteUserInfo

public void deleteUserInfo(String userId,
                           String key)

Description copied from interface: IdentityService

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

Specified by:

deleteUserInfo in interface IdentityService

getIdmIdentityService

protected IdmIdentityService getIdmIdentityService()