Package com.flowable.core.idm.api

Interface UserPermissionService

All Known Implementing Classes:
GrantingUserPermissionService
public interface UserPermissionService
The permission service that can used to check permissions on actions to be executed in the context of a user like deactivation, reactivation, etc.
Author:
Micha Kiener

  • Method Summary

    Modifier and Type Method Description
    java.util.Optional<java.lang.String> checkUserCreation​(java.lang.String userId, java.lang.String userToCreateId)
    Deprecated.
    use checkUserCreation(String, Collection, String, String) instead
    java.util.Optional<java.lang.String> checkUserCreation​(java.lang.String userId, java.util.Collection<java.lang.String> userGroupKeys, java.lang.String userTenantId, java.lang.String userToCreateId)
    Evaluates the permissions for the given user when creating a new user.
    java.util.Optional<java.lang.String> checkUserDeactivation​(java.lang.String userId, java.lang.String userToDeactivateId)
    Deprecated.
    use checkUserDeactivation(String, Collection, String, String) instead
    java.util.Optional<java.lang.String> checkUserDeactivation​(java.lang.String userId, java.util.Collection<java.lang.String> userGroupKeys, java.lang.String userTenantId, java.lang.String userToDeactivateId)
    Evaluates the permissions for the given user when deactivating a user.
    java.util.Optional<java.lang.String> checkUserReactivation​(java.lang.String userId, java.lang.String userToReactivateId)
    Deprecated.
    use checkUserReactivation(String, Collection, String, String) instead
    java.util.Optional<java.lang.String> checkUserReactivation​(java.lang.String userId, java.util.Collection<java.lang.String> userGroupKeys, java.lang.String userTenantId, java.lang.String userToReactivateId)  

  • Method Details

    • checkUserCreation

      @Deprecated java.util.Optional<java.lang.String> checkUserCreation​(java.lang.String userId, java.lang.String userToCreateId)
      Deprecated.
      use checkUserCreation(String, Collection, String, String) instead
      Evaluates the permissions for the given user when creating a new user.
      Parameters:
      userId - the id of the user to check the permissions for (not the one being deactivated)
      userToCreateId - the id of the new user to be created
      Returns:
      the permission error message, if permission is denied to create the user or no message, if permission is granted

    • checkUserCreation

      java.util.Optional<java.lang.String> checkUserCreation​(java.lang.String userId, java.util.Collection<java.lang.String> userGroupKeys, java.lang.String userTenantId, java.lang.String userToCreateId)
      Evaluates the permissions for the given user when creating a new user.
      Parameters:
      userId - the id of the user to check the permissions for (not the one being deactivated)
      userGroupKeys - the group keys of the user to check the permissions
      userTenantId - the tenant id of the user to check the permissions
      userToCreateId - the id of the new user to be created
      Returns:
      the permission error message, if permission is denied to create the user or no message, if permission is granted

    • checkUserDeactivation

      @Deprecated java.util.Optional<java.lang.String> checkUserDeactivation​(java.lang.String userId, java.lang.String userToDeactivateId)
      Deprecated.
      use checkUserDeactivation(String, Collection, String, String) instead
      Evaluates the permissions for the given user when deactivating a user.
      Parameters:
      userId - the id of the user to check the permissions for (not the one being deactivated)
      userToDeactivateId - the id of the user to be deactivated
      Returns:
      the permission error message, if permission is denied to deactivate the user or no message, if permission is granted

    • checkUserDeactivation

      java.util.Optional<java.lang.String> checkUserDeactivation​(java.lang.String userId, java.util.Collection<java.lang.String> userGroupKeys, java.lang.String userTenantId, java.lang.String userToDeactivateId)
      Evaluates the permissions for the given user when deactivating a user.
      Parameters:
      userId - the id of the user to check the permissions for (not the one being deactivated)
      userGroupKeys - the group keys of the user to check the permissions
      userTenantId - the tenant id of the user to check the permissions
      userToDeactivateId - the id of the user to be deactivated
      Returns:
      the permission error message, if permission is denied to deactivate the user or no message, if permission is granted

    • checkUserReactivation

      @Deprecated java.util.Optional<java.lang.String> checkUserReactivation​(java.lang.String userId, java.lang.String userToReactivateId)
      Deprecated.
      use checkUserReactivation(String, Collection, String, String) instead
      Evaluates the permissions for the given user when reactivating a user.
      Parameters:
      userId - the id of the user to check the permissions for (not the one being reactivated)
      userToReactivateId - the id of the user to be reactivated
      Returns:
      the permission error message, if permission is denied to reactivate the user or no message, if permission is granted

    • checkUserReactivation

      java.util.Optional<java.lang.String> checkUserReactivation​(java.lang.String userId, java.util.Collection<java.lang.String> userGroupKeys, java.lang.String userTenantId, java.lang.String userToReactivateId)