java.lang.Object

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

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

com.flowable.idm.engine.impl.BaseIdmIdentityServiceImpl

All Implemented Interfaces:: PlatformIdentityService, org.flowable.idm.api.IdmIdentityService

Direct Known Subclasses:: IdmIdentityServiceImpl, ReadOnlyIdmIdentityService

public abstract class BaseIdmIdentityServiceImpl
extends org.flowable.common.engine.impl.service.CommonEngineServiceImpl<CoreIdmEngineConfiguration>
implements PlatformIdentityService

Author:: Tijs Rademakers, Filip Hrisafov

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 Description

BaseIdmIdentityServiceImpl(CoreIdmEngineConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
`void`	`addGroupPrivilegeMapping(java.lang.String privilegeId, java.lang.String groupId)`
`void`	`addUserPrivilegeMapping(java.lang.String privilegeId, java.lang.String userId)`
`org.flowable.idm.api.GroupQuery`	`createGroupQuery()`
`org.flowable.idm.api.NativeTokenQuery`	`createNativeTokenQuery()`
`PlatformIdentityInfoBuilder`	`createPlatformIdentityInfoBuilder()`	Create a builder for updating or creating a platform identity info.
`PlatformIdentityInfoQuery`	`createPlatformIdentityInfoQuery()`	Create a query for querying platform identity infos.
`org.flowable.idm.api.Privilege`	`createPrivilege(java.lang.String name)`
`org.flowable.idm.api.PrivilegeQuery`	`createPrivilegeQuery()`
`IdmProperty`	`createProperty(java.lang.String name, java.lang.String value)`
`org.flowable.idm.api.TokenQuery`	`createTokenQuery()`
`org.flowable.idm.api.UserQuery`	`createUserQuery()`
`void`	`deleteGroupPrivilegeMapping(java.lang.String privilegeId, java.lang.String groupId)`
`void`	`deletePlatformIdentityInfoById(java.lang.String id)`
`void`	`deletePlatformIdentityInfoByUserId(java.lang.String userId)`
`void`	`deletePrivilege(java.lang.String id)`
`void`	`deleteProperty(java.lang.String name)`
`void`	`deleteToken(java.lang.String tokenId)`
`void`	`deleteUserInfo(java.lang.String userId, java.lang.String key)`
`void`	`deleteUserPrivilegeMapping(java.lang.String privilegeId, java.lang.String userId)`
`PlatformIdentityInfo`	`findIdentityInfoByUserIdAndName(java.lang.String userId, java.lang.String name)`
`IdmProperty`	`findPropertyByName(java.lang.String name)`
`<T> java.util.Optional<T>`	`getPlatformUserInfo(java.lang.String userId, java.lang.String name, java.lang.Class<T> infoClass)`
`java.util.List<org.flowable.idm.api.PrivilegeMapping>`	`getPrivilegeMappingsByPrivilegeId(java.lang.String privilegeId)`
`java.lang.String`	`getUserInfo(java.lang.String userId, java.lang.String key)`
`java.util.List<java.lang.String>`	`getUserInfoKeys(java.lang.String userId)`
`org.flowable.idm.api.Picture`	`getUserPicture(java.lang.String userId)`
`org.flowable.idm.api.Token`	`newToken(java.lang.String tokenId)`
`void`	`saveToken(org.flowable.idm.api.Token token)`
`void`	`setAuthenticatedUserId(java.lang.String authenticatedUserId)`
`void`	`setPlatformUserInfo(java.lang.String userId, java.lang.String name, java.lang.Object value)`
`void`	`setUserDefinitionById(java.lang.String userId, java.lang.String userDefinitionId)`	Update the user definition of the provided user.
`void`	`setUserDefinitionByKey(java.lang.String userId, java.lang.String userDefinitionKey, java.lang.String tenantId)`	Update the user definition of the provided user.
`void`	`setUserInfo(java.lang.String userId, java.lang.String key, java.lang.String value)`
`void`	`setUserPicture(java.lang.String userId, org.flowable.idm.api.Picture picture)`
`void`	`setUserStateAndSubState(java.lang.String userId, java.lang.String state, java.lang.String subState)`	Update the state and/or subState of the provided user.
`void`	`setUserStateAndSubState(java.lang.String userId, java.lang.String state, java.lang.String subState, java.lang.String tenantId)`	Update the state and/or subState of the provided user.
`void`	`updateProperty(IdmProperty idmProperty)`
`void`	`updateUserPresence(java.lang.String userId, java.lang.String presence)`	Updates the presence status of the user
`void`	`updateUserPresence(java.lang.String userId, java.lang.String tenantId, java.lang.String presence)`	Updates the presence status of the user in the given tenant

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

Methods inherited from interface org.flowable.idm.api.IdmIdentityService

checkPassword, createMembership, createNativeGroupQuery, createNativeUserQuery, deleteGroup, deleteMembership, deleteUser, getGroupsWithPrivilege, getUsersWithPrivilege, newGroup, newUser, saveGroup, saveUser, updateUserPassword

Methods inherited from interface com.flowable.core.idm.api.PlatformIdentityService

createNewGroupBuilder, createNewUserBuilder, createPlatformGroupQuery, createPlatformUserQuery, createUpdateGroupBuilder, createUpdateUserBuilder, deactivateUser, findPlatformGroupById, findPlatformGroupsForUser, findPlatformUserById, findUniqueTenantIds, reactivateUser, setUserState, setUserSubState

Constructor Details
- BaseIdmIdentityServiceImpl
  
  public BaseIdmIdentityServiceImpl(CoreIdmEngineConfiguration configuration)
Method Details
- setUserStateAndSubState
  
  public void setUserStateAndSubState(java.lang.String userId, java.lang.String state, java.lang.String subState)
  
  Description copied from interface: PlatformIdentityService
  
  Update the state and/or subState of the provided user. If the value for the state is null then the state of the user won't be changed. If the value for the subState is null then the subState of the user won't be changed. At least one of state and / or subState must be set
  
  Specified by:
  
  setUserStateAndSubState in interface PlatformIdentityService
  
  Parameters:
  
  userId - the id of the user that needs to have its state updated
  
  state - the optional new state to set, if null it won't be changed
  
  subState - the optional new subState to set, if null it won't be changed
  
  See Also:
  
  for a list of commonly used states, although you can create your own ones, for a list of commonly used sub states, although you can create your own ones
- setUserStateAndSubState
  
  public void setUserStateAndSubState(java.lang.String userId, java.lang.String state, java.lang.String subState, java.lang.String tenantId)
  
  Description copied from interface: PlatformIdentityService
  
  Update the state and/or subState of the provided user. If the value for the state is null then the state of the user won't be changed. If the value for the subState is null then the subState of the user won't be changed. At least one of state and / or subState must be set
  
  Specified by:
  
  setUserStateAndSubState in interface PlatformIdentityService
  
  Parameters:
  
  userId - the id of the user that needs to have its state updated
  
  state - the optional new state to set, if null it won't be changed
  
  subState - the optional new subState to set, if null it won't be changed
  
  tenantId - the tenant id in which the change should be done
  
  See Also:
  
  for a list of commonly used states, although you can create your own ones, for a list of commonly used sub states, although you can create your own ones
- setUserDefinitionById
  
  public void setUserDefinitionById(java.lang.String userId, java.lang.String userDefinitionId)
  
  Description copied from interface: PlatformIdentityService
  
  Update the user definition of the provided user.
  
  Specified by:
  
  setUserDefinitionById in interface PlatformIdentityService
  
  Parameters:
  
  userId - the id of the user that needs to have its user definition updated
  
  userDefinitionId - the user definition id of the new user definition
- setUserDefinitionByKey
  
  public void setUserDefinitionByKey(java.lang.String userId, java.lang.String userDefinitionKey, java.lang.String tenantId)
  
  Description copied from interface: PlatformIdentityService
  
  Update the user definition of the provided user.
  
  Specified by:
  
  setUserDefinitionByKey in interface PlatformIdentityService
  
  Parameters:
  
  userId - the id of the user that needs to have its user definition updated
  
  userDefinitionKey - the key of the new user definition
  
  tenantId - the tenant id of the new user definition
- updateUserPresence
  
  public void updateUserPresence(java.lang.String userId, java.lang.String presence)
  
  Description copied from interface: PlatformIdentityService
  
  Updates the presence status of the user
  
  Specified by:
  
  updateUserPresence in interface PlatformIdentityService
  
  Parameters:
  
  userId - the id of the user for which the presence status needs to be updated
  
  presence - the id of the user for which the presence status needs to be updated
  
  See Also:
  
  for known states
- updateUserPresence
  
  public void updateUserPresence(java.lang.String userId, java.lang.String tenantId, java.lang.String presence)
  
  Description copied from interface: PlatformIdentityService
  
  Updates the presence status of the user in the given tenant
  
  Specified by:
  
  updateUserPresence in interface PlatformIdentityService
  
  Parameters:
  
  userId - the id of the user for which the presence status needs to be updated
  
  tenantId - the id of tenant in which the presence status needs to be updated
  
  presence - the id of the user for which the presence status needs to be updated
  
  See Also:
  
  for known states
- createUserQuery
  
  public org.flowable.idm.api.UserQuery createUserQuery()
  
  Specified by:
  
  createUserQuery in interface org.flowable.idm.api.IdmIdentityService
- getPlatformUserInfo
  
  public <T> java.util.Optional<T> getPlatformUserInfo(java.lang.String userId, java.lang.String name, java.lang.Class<T> infoClass)
  
  Specified by:
  
  getPlatformUserInfo in interface PlatformIdentityService
- setPlatformUserInfo
  
  public void setPlatformUserInfo(java.lang.String userId, java.lang.String name, java.lang.Object value)
  
  Specified by:
  
  setPlatformUserInfo in interface PlatformIdentityService
- createPlatformIdentityInfoBuilder
  
  public PlatformIdentityInfoBuilder createPlatformIdentityInfoBuilder()
  
  Description copied from interface: PlatformIdentityService
  
  Create a builder for updating or creating a platform identity info.
  
  Specified by:
  
  createPlatformIdentityInfoBuilder in interface PlatformIdentityService
- createPlatformIdentityInfoQuery
  
  public PlatformIdentityInfoQuery createPlatformIdentityInfoQuery()
  
  Description copied from interface: PlatformIdentityService
  
  Create a query for querying platform identity infos.
  
  Specified by:
  
  createPlatformIdentityInfoQuery in interface PlatformIdentityService
- createGroupQuery
  
  public org.flowable.idm.api.GroupQuery createGroupQuery()
  
  Specified by:
  
  createGroupQuery in interface org.flowable.idm.api.IdmIdentityService
- setAuthenticatedUserId
  
  public void setAuthenticatedUserId(java.lang.String authenticatedUserId)
  
  Specified by:
  
  setAuthenticatedUserId in interface org.flowable.idm.api.IdmIdentityService
- newToken
  
  public org.flowable.idm.api.Token newToken(java.lang.String tokenId)
  
  Specified by:
  
  newToken in interface org.flowable.idm.api.IdmIdentityService
- saveToken
  
  public void saveToken(org.flowable.idm.api.Token token)
  
  Specified by:
  
  saveToken in interface org.flowable.idm.api.IdmIdentityService
- deleteToken
  
  public void deleteToken(java.lang.String tokenId)
  
  Specified by:
  
  deleteToken in interface org.flowable.idm.api.IdmIdentityService
- createTokenQuery
  
  public org.flowable.idm.api.TokenQuery createTokenQuery()
  
  Specified by:
  
  createTokenQuery in interface org.flowable.idm.api.IdmIdentityService
- createNativeTokenQuery
  
  public org.flowable.idm.api.NativeTokenQuery createNativeTokenQuery()
  
  Specified by:
  
  createNativeTokenQuery in interface org.flowable.idm.api.IdmIdentityService
- setUserPicture
  
  public void setUserPicture(java.lang.String userId, org.flowable.idm.api.Picture picture)
  
  Specified by:
  
  setUserPicture in interface org.flowable.idm.api.IdmIdentityService
- getUserPicture
  
  public org.flowable.idm.api.Picture getUserPicture(java.lang.String userId)
  
  Specified by:
  
  getUserPicture in interface org.flowable.idm.api.IdmIdentityService
- getUserInfo
  
  public java.lang.String getUserInfo(java.lang.String userId, java.lang.String key)
  
  Specified by:
  
  getUserInfo in interface org.flowable.idm.api.IdmIdentityService
- getUserInfoKeys
  
  public java.util.List<java.lang.String> getUserInfoKeys(java.lang.String userId)
  
  Specified by:
  
  getUserInfoKeys in interface org.flowable.idm.api.IdmIdentityService
- setUserInfo
  
  public void setUserInfo(java.lang.String userId, java.lang.String key, java.lang.String value)
  
  Specified by:
  
  setUserInfo in interface org.flowable.idm.api.IdmIdentityService
- deleteUserInfo
  
  public void deleteUserInfo(java.lang.String userId, java.lang.String key)
  
  Specified by:
  
  deleteUserInfo in interface org.flowable.idm.api.IdmIdentityService
- createPrivilege
  
  public org.flowable.idm.api.Privilege createPrivilege(java.lang.String name)
  
  Specified by:
  
  createPrivilege in interface org.flowable.idm.api.IdmIdentityService
- addUserPrivilegeMapping
  
  public void addUserPrivilegeMapping(java.lang.String privilegeId, java.lang.String userId)
  
  Specified by:
  
  addUserPrivilegeMapping in interface org.flowable.idm.api.IdmIdentityService
- deleteUserPrivilegeMapping
  
  public void deleteUserPrivilegeMapping(java.lang.String privilegeId, java.lang.String userId)
  
  Specified by:
  
  deleteUserPrivilegeMapping in interface org.flowable.idm.api.IdmIdentityService
- addGroupPrivilegeMapping
  
  public void addGroupPrivilegeMapping(java.lang.String privilegeId, java.lang.String groupId)
  
  Specified by:
  
  addGroupPrivilegeMapping in interface org.flowable.idm.api.IdmIdentityService
- deleteGroupPrivilegeMapping
  
  public void deleteGroupPrivilegeMapping(java.lang.String privilegeId, java.lang.String groupId)
  
  Specified by:
  
  deleteGroupPrivilegeMapping in interface org.flowable.idm.api.IdmIdentityService
- getPrivilegeMappingsByPrivilegeId
  
  public java.util.List<org.flowable.idm.api.PrivilegeMapping> getPrivilegeMappingsByPrivilegeId(java.lang.String privilegeId)
  
  Specified by:
  
  getPrivilegeMappingsByPrivilegeId in interface org.flowable.idm.api.IdmIdentityService
- deletePrivilege
  
  public void deletePrivilege(java.lang.String id)
  
  Specified by:
  
  deletePrivilege in interface org.flowable.idm.api.IdmIdentityService
- createPrivilegeQuery
  
  public org.flowable.idm.api.PrivilegeQuery createPrivilegeQuery()
  
  Specified by:
  
  createPrivilegeQuery in interface org.flowable.idm.api.IdmIdentityService
- findIdentityInfoByUserIdAndName
  
  public PlatformIdentityInfo findIdentityInfoByUserIdAndName(java.lang.String userId, java.lang.String name)
  
  Specified by:
  
  findIdentityInfoByUserIdAndName in interface PlatformIdentityService
- deletePlatformIdentityInfoById
  
  public void deletePlatformIdentityInfoById(java.lang.String id)
  
  Specified by:
  
  deletePlatformIdentityInfoById in interface PlatformIdentityService
- deletePlatformIdentityInfoByUserId
  
  public void deletePlatformIdentityInfoByUserId(java.lang.String userId)
  
  Specified by:
  
  deletePlatformIdentityInfoByUserId in interface PlatformIdentityService
- findPropertyByName
  
  public IdmProperty findPropertyByName(java.lang.String name)
  
  Specified by:
  
  findPropertyByName in interface PlatformIdentityService
- updateProperty
  
  public void updateProperty(IdmProperty idmProperty)
  
  Specified by:
  
  updateProperty in interface PlatformIdentityService
- createProperty
  
  public IdmProperty createProperty(java.lang.String name, java.lang.String value)
  
  Specified by:
  
  createProperty in interface PlatformIdentityService
- deleteProperty
  
  public void deleteProperty(java.lang.String name)
  
  Specified by:
  
  deleteProperty in interface PlatformIdentityService

Class BaseIdmIdentityServiceImpl

Field Summary

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

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

Constructor Summary