Package org.camunda.bpm.engine.impl.identity

Interface WritableIdentityProvider

  • All Superinterfaces:
    Session
    All Known Implementing Classes:
    DbIdentityServiceProvider
    public interface WritableIdentityProvider
extends Session

    SPI Interface for identity service implementations which offer read / write access to the user database.

    Author:
    Daniel Meyer

    • Method Detail

      • createNewUser

        User createNewUser​(java.lang.String userId)

        Returns a new (transient) User object. The Object is not yet persistent and must be saved using the saveUser(User) method.

        NOTE: the implementation does not validate the uniqueness of the userId parameter at this time.

        Parameters:
        userId -
        Returns:
        an non-persistent user object.

      • deleteUser

        IdentityOperationResult deleteUser​(java.lang.String userId)
        Allows deleting a persistent User object.
        Parameters:
        UserId - the id of the User object to delete.
        Returns:
        the operation result object.
        Throws:
        IdentityProviderException - in case an internal error occurs

      • unlockUser

        IdentityOperationResult unlockUser​(java.lang.String userId)
        Allows unlocking a User object.
        Parameters:
        userId - the id of the User object to delete.
        Returns:
        the operation result object.
        Throws:
        AuthorizationException - if the user is not CAMUNDA_ADMIN

      • createNewGroup

        Group createNewGroup​(java.lang.String groupId)

        Returns a new (transient) Group object. The Object is not yet persistent and must be saved using the saveGroup(Group) method.

        NOTE: the implementation does not validate the uniqueness of the groupId parameter at this time.

        Parameters:
        groupId -
        Returns:
        an non-persistent group object.

      • deleteGroup

        IdentityOperationResult deleteGroup​(java.lang.String groupId)
        Allows deleting a persistent Group object.
        Parameters:
        groupId - the id of the group object to delete.
        Returns:
        the operation result object.
        Throws:
        IdentityProviderException - in case an internal error occurs

      • createNewTenant

        Tenant createNewTenant​(java.lang.String tenantId)

        Returns a new (transient) Tenant object. The Object is not yet persistent and must be saved using the saveTenant(Tenant) method.

        NOTE: the implementation does not validate the uniqueness of the tenantId parameter at this time.

        Parameters:
        tenantId - the id of the new tenant
        Returns:
        an non-persistent tenant object.

      • deleteTenant

        IdentityOperationResult deleteTenant​(java.lang.String tenantId)
        Allows deleting a persistent Tenant object.
        Parameters:
        tenantId - the id of the tenant object to delete.
        Returns:
        the operation result object.
        Throws:
        IdentityProviderException - in case an internal error occurs

      • createMembership

        IdentityOperationResult createMembership​(java.lang.String userId,
                                         java.lang.String groupId)
        Creates a membership relation between a user and a group. If the user is already part of that group, IdentityProviderException is thrown.
        Parameters:
        userId - the id of the user
        groupId - id of the group
        Returns:
        the operation result object.
        Throws:
        IdentityProviderException

      • deleteMembership

        IdentityOperationResult deleteMembership​(java.lang.String userId,
                                         java.lang.String groupId)
        Deletes a membership relation between a user and a group.
        Parameters:
        userId - the id of the user
        groupId - id of the group
        Returns:
        the operation result object.
        Throws:
        IdentityProviderException

      • createTenantUserMembership

        IdentityOperationResult createTenantUserMembership​(java.lang.String tenantId,
                                                   java.lang.String userId)
        Creates a membership relation between a tenant and a user.
        Parameters:
        tenantId - the id of the tenant
        userId - the id of the user
        Returns:
        the operation result object.

      • createTenantGroupMembership

        IdentityOperationResult createTenantGroupMembership​(java.lang.String tenantId,
                                                    java.lang.String groupId)
        Creates a membership relation between a tenant and a group.
        Parameters:
        tenantId - the id of the tenant
        groupId - the id of the group
        Returns:
        the operation result object.

      • deleteTenantUserMembership

        IdentityOperationResult deleteTenantUserMembership​(java.lang.String tenantId,
                                                   java.lang.String userId)
        Deletes a membership relation between a tenant and a user.
        Parameters:
        tenantId - the id of the tenant
        userId - the id of the user
        Returns:
        the operation result object

      • deleteTenantGroupMembership

        IdentityOperationResult deleteTenantGroupMembership​(java.lang.String tenantId,
                                                    java.lang.String groupId)
        Deletes a membership relation between a tenant and a group.
        Parameters:
        tenantId - the id of the tenant
        groupId - the id of the group
        Returns:
        the operation result object.