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 Summary

Modifier and Type	Method and Description
IdentityOperationResult	createMembership(String userId, String groupId) Creates a membership relation between a user and a group.
Group	createNewGroup(String groupId) Returns a new (transient) Group object.
Tenant	createNewTenant(String tenantId) Returns a new (transient) Tenant object.
User	createNewUser(String userId) Returns a new (transient) User object.
IdentityOperationResult	createTenantGroupMembership(String tenantId, String groupId) Creates a membership relation between a tenant and a group.
IdentityOperationResult	createTenantUserMembership(String tenantId, String userId) Creates a membership relation between a tenant and a user.
IdentityOperationResult	deleteGroup(String groupId) Allows deleting a persistent Group object.
IdentityOperationResult	deleteMembership(String userId, String groupId) Deletes a membership relation between a user and a group.
IdentityOperationResult	deleteTenant(String tenantId) Allows deleting a persistent Tenant object.
IdentityOperationResult	deleteTenantGroupMembership(String tenantId, String groupId) Deletes a membership relation between a tenant and a group.
IdentityOperationResult	deleteTenantUserMembership(String tenantId, String userId) Deletes a membership relation between a tenant and a user.
IdentityOperationResult	deleteUser(String userId) Allows deleting a persistent User object.
IdentityOperationResult	saveGroup(Group group) Allows saving a Group object which is not yet persistent.
IdentityOperationResult	saveTenant(Tenant tenant) Allows saving a Tenant object which is not yet persistent.
IdentityOperationResult	saveUser(User user) Allows saving or updates a User object
IdentityOperationResult	unlockUser(String userId) Allows unlocking a User object.

Methods inherited from interface org.camunda.bpm.engine.impl.interceptor.Session

close, flush

Method Detail

createNewUser

User createNewUser(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.

saveUser

IdentityOperationResult saveUser(User user)

Allows saving or updates a User object

Parameters:

user - a User object.

Returns:

the operation result object.

Throws:

IdentityProviderException - in case an internal error occurs

deleteUser

IdentityOperationResult deleteUser(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(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(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.

saveGroup

IdentityOperationResult saveGroup(Group group)

Allows saving a Group object which is not yet persistent.

Parameters:

group - a group object.

Returns:

the operation result object.

Throws:

IdentityProviderException - in case an internal error occurs

deleteGroup

IdentityOperationResult deleteGroup(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(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.

saveTenant

IdentityOperationResult saveTenant(Tenant tenant)

Allows saving a Tenant object which is not yet persistent.

Parameters:

tenant - the tenant object to save.

Returns:

the operation result object.

Throws:

IdentityProviderException - in case an internal error occurs

deleteTenant

IdentityOperationResult deleteTenant(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(String userId,
                                         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(String userId,
                                         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(String tenantId,
                                                   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(String tenantId,
                                                    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(String tenantId,
                                                   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(String tenantId,
                                                    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.