Package com.flowable.core.idm.api

Interface PlatformIdentityService

All Superinterfaces:

org.flowable.idm.api.IdmIdentityService

All Known Implementing Classes:

BaseIdmIdentityServiceImpl, IdmIdentityServiceImpl, LdapIdmIdentityService, ReadOnlyIdmIdentityService

public interface PlatformIdentityService
extends org.flowable.idm.api.IdmIdentityService

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method	Description
boolean	checkAccessToken(String tokenId, String tokenValue)	Check if the access token with the given id is valid for the given value
AccessTokenQuery	createAccessTokenQuery()
TokenAuthenticationBuilder	createAuthenticationTokenBuilder()	Deprecated. use createNewAccessTokenBuilder() instead
AccessTokenBuilder	createNewAccessTokenBuilder()
PlatformGroupBuilder	createNewGroupBuilder(String groupId)
PlatformUserBuilder	createNewUserBuilder(String userId)	Create user builder for a new user with id userId.
PlatformGroupQuery	createPlatformGroupQuery()
PlatformIdentityInfoBuilder	createPlatformIdentityInfoBuilder()	Create a builder for updating or creating a platform identity info.
PlatformIdentityInfoQuery	createPlatformIdentityInfoQuery()	Create a query for querying platform identity infos.
PlatformUserQuery	createPlatformUserQuery()
IdmProperty	createProperty(String name, String value)
PlatformGroupBuilder	createUpdateGroupBuilder(String groupId)
PlatformUserBuilder	createUpdateUserBuilder(String userId)
default void	deactivateUser(String userId, String newSubState)	Deprecated. use setUserStateAndSubState(String, String, String) instead with state UserStates.INACTIVE
void	deleteAccessToken(String tokenId)
void	deletePlatformIdentityInfoByGroupId(String groupId)	Delete all platform identity info entries of the group
void	deletePlatformIdentityInfoByGroupIdAndTenantId(String groupId, String tenantId)	Delete all platform identity info entries of the group in the given tenant
void	deletePlatformIdentityInfoById(String id)	Delete the platform identity info entry for the given id
void	deletePlatformIdentityInfoByUserId(String userId)	Delete all platform identity info entries of the user
void	deletePlatformIdentityInfoByUserIdAndTenantId(String userId, String tenantId)	Delete all platform identity info entries of the user in the given tenant
void	deleteProperty(String name)
AccessToken	findAccessToken(String tokenId)
PlatformIdentityInfo	findIdentityInfoByUserIdAndName(String userId, String name)	Deprecated.
PlatformGroup	findPlatformGroupById(String groupId)	Deprecated. user createPlatformGroupQuery() instead
List<PlatformGroup>	findPlatformGroupsForUser(String userId)	Deprecated. use createPlatformGroupQuery() with PlatformGroupQuery.groupMember(String) instead.
PlatformUser	findPlatformUserById(String userId)	Deprecated. use createPlatformUserQuery() instead
IdmProperty	findPropertyByName(String name)
List<String>	findUniqueTenantIds()	Find the unique tenant ids
<T> Optional<T>	getPlatformUserInfo(String userId, String infoName, Class<T> infoClass)	Deprecated.
default void	reactivateUser(String userId, String newSubState)	Deprecated. use setUserStateAndSubState(String, String, String) instead with state UserStates.ACTIVE
void	setPlatformUserInfo(String userId, String infoName, Object value)	Deprecated. use createPlatformIdentityInfoBuilder() instead
void	setUserDefinitionById(String userId, String userDefinitionId)	Update the user definition of the provided user.
void	setUserDefinitionByKey(String userId, String userDefinitionKey, String tenantId)	Update the user definition of the provided user.
default void	setUserState(String userId, String state)	Set the state of this user object.
void	setUserStateAndSubState(String userId, String state, String subState)	Update the state and/or subState of the provided user.
void	setUserStateAndSubState(String userId, String state, String subState, String tenantId)	Update the state and/or subState of the provided user.
default void	setUserSubState(String userId, String subState)	Set the sub state of this user object.
void	updateProperty(IdmProperty idmProperty)
void	updateUserPresence(String userId, String presence)	Deprecated. use updateUserPresence(String, String, String) instead
void	updateUserPresence(String userId, String tenantId, String presence)	Updates the presence status of the user in the given tenant

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

addGroupPrivilegeMapping, addUserPrivilegeMapping, checkPassword, createGroupQuery, createMembership, createNativeGroupQuery, createNativeTokenQuery, createNativeUserQuery, createPrivilege, createPrivilegeQuery, createTokenQuery, createUserQuery, deleteGroup, deleteGroupPrivilegeMapping, deleteMembership, deletePrivilege, deleteToken, deleteUser, deleteUserInfo, deleteUserPrivilegeMapping, getGroupsWithPrivilege, getPrivilegeMappingsByPrivilegeId, getUserInfo, getUserInfoKeys, getUserPicture, getUsersWithPrivilege, newGroup, newToken, newUser, saveGroup, saveToken, saveUser, setAuthenticatedUserId, setUserInfo, setUserPicture, updateUserPassword

Method Details

createNewUserBuilder

PlatformUserBuilder createNewUserBuilder(String userId)

Create user builder for a new user with id userId. The user is transient and must be saved using PlatformUserBuilder.save()

Parameters:

userId - the id of the new user

createUpdateUserBuilder

PlatformUserBuilder createUpdateUserBuilder(String userId)

createNewGroupBuilder

PlatformGroupBuilder createNewGroupBuilder(String groupId)

createUpdateGroupBuilder

PlatformGroupBuilder createUpdateGroupBuilder(String groupId)

findPlatformUserById

@Deprecated
PlatformUser findPlatformUserById(String userId)

Deprecated.

use createPlatformUserQuery() instead

createPlatformUserQuery

PlatformUserQuery createPlatformUserQuery()

createPlatformGroupQuery

PlatformGroupQuery createPlatformGroupQuery()

findPlatformGroupById

@Deprecated
PlatformGroup findPlatformGroupById(String groupId)

Deprecated.

user createPlatformGroupQuery() instead

findPlatformGroupsForUser

@Deprecated
List<PlatformGroup> findPlatformGroupsForUser(String userId)

Deprecated.

use createPlatformGroupQuery() with PlatformGroupQuery.groupMember(String) instead.

createPlatformIdentityInfoBuilder

PlatformIdentityInfoBuilder createPlatformIdentityInfoBuilder()

Create a builder for updating or creating a platform identity info.

createPlatformIdentityInfoQuery

PlatformIdentityInfoQuery createPlatformIdentityInfoQuery()

Create a query for querying platform identity infos.

findUniqueTenantIds

List<String> findUniqueTenantIds()

Find the unique tenant ids

Returns:

a list of the unique tenant ids

setUserStateAndSubState

void setUserStateAndSubState(String userId,
 String state,
 String subState)

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

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

void setUserStateAndSubState(String userId,
 String state,
 String subState,
 String tenantId)

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

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

void setUserDefinitionById(String userId,
 String userDefinitionId)

Update the user definition of the provided user.

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

void setUserDefinitionByKey(String userId,
 String userDefinitionKey,
 String tenantId)

Update the user definition of the provided user.

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

deactivateUser

@Deprecated
default void deactivateUser(String userId,
 String newSubState)

Deprecated.

use setUserStateAndSubState(String, String, String) instead with state UserStates.INACTIVE

Sets the user state to UserStates.INACTIVE. This method should no longer be used as it would be removed.

Parameters:

userId - the id of the user to be deactivated

newSubState - the optional new sub state to set, leave it null to not change it

reactivateUser

@Deprecated
default void reactivateUser(String userId,
 String newSubState)

Deprecated.

use setUserStateAndSubState(String, String, String) instead with state UserStates.ACTIVE

Sets the user state to UserStates.ACTIVE. This method should no longer be used as it would be removed.

Parameters:

userId - the id of the user to be reactivated

newSubState - the optional new sub state to set, leave it null to not change it

setUserState

default void setUserState(String userId,
 String state)

Set the state of this user object. By default this method delegates to setUserStateAndSubState(String, String, String) with subState null

Parameters:

userId - the id of the user to change its state

state - the new state to be set on this user object

See Also:

• for a list of commonly used sub states, although you can create your own ones
• for more information

setUserSubState

default void setUserSubState(String userId,
 String subState)

Set the sub state of this user object. The sub state might be used to more specifically describe the current state of the user. By default this method delegates to setUserStateAndSubState(String, String, String) with state null

Parameters:

userId - the id of the user to change its substate

subState - the new sub state to be set on this user object

See Also:

• for a list of commonly used sub states, although you can create your own ones
• for more information

updateUserPresence

@Deprecated
void updateUserPresence(String userId,
 String presence)

Deprecated.

use updateUserPresence(String, String, String) instead

Updates the presence status of the user

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

void updateUserPresence(String userId,
 String tenantId,
 String presence)

Updates the presence status of the user in the given tenant

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

setPlatformUserInfo

@Deprecated
void setPlatformUserInfo(String userId,
 String infoName,
 Object value)

Deprecated.

use createPlatformIdentityInfoBuilder() instead

getPlatformUserInfo

@Deprecated
<T> Optional<T> getPlatformUserInfo(String userId,
 String infoName,
 Class<T> infoClass)

Deprecated.

findIdentityInfoByUserIdAndName

@Deprecated
PlatformIdentityInfo findIdentityInfoByUserIdAndName(String userId,
 String name)

Deprecated.

deletePlatformIdentityInfoById

void deletePlatformIdentityInfoById(String id)

Delete the platform identity info entry for the given id

Parameters:

id - the id of the identity info entry

deletePlatformIdentityInfoByUserId

void deletePlatformIdentityInfoByUserId(String userId)

Delete all platform identity info entries of the user

Parameters:

userId - the id of the user

deletePlatformIdentityInfoByUserIdAndTenantId

void deletePlatformIdentityInfoByUserIdAndTenantId(String userId,
 String tenantId)

Delete all platform identity info entries of the user in the given tenant

Parameters:

userId - the id of the user

tenantId - the id of the tenant

deletePlatformIdentityInfoByGroupId

void deletePlatformIdentityInfoByGroupId(String groupId)

Delete all platform identity info entries of the group

Parameters:

groupId - the id of the group

deletePlatformIdentityInfoByGroupIdAndTenantId

void deletePlatformIdentityInfoByGroupIdAndTenantId(String groupId,
 String tenantId)

Delete all platform identity info entries of the group in the given tenant

Parameters:

groupId - the id of the group

tenantId - the id of the tenant

createAuthenticationTokenBuilder

@Deprecated
TokenAuthenticationBuilder createAuthenticationTokenBuilder()

Deprecated.

use createNewAccessTokenBuilder() instead

Create a token authentication builder with which authentication tokens can be created.

Returns:

the token authentication builder

findPropertyByName

IdmProperty findPropertyByName(String name)

updateProperty

void updateProperty(IdmProperty idmProperty)

createProperty

IdmProperty createProperty(String name,
 String value)

deleteProperty

void deleteProperty(String name)

createNewAccessTokenBuilder

AccessTokenBuilder createNewAccessTokenBuilder()

createAccessTokenQuery

AccessTokenQuery createAccessTokenQuery()

findAccessToken

AccessToken findAccessToken(String tokenId)

checkAccessToken

boolean checkAccessToken(String tokenId,
 String tokenValue)

Check if the access token with the given id is valid for the given value

Parameters:

tokenId - the id of the token to check

tokenValue - the value that should be checked

deleteAccessToken

void deleteAccessToken(String tokenId)