org.camunda.bpm.engine.impl.identity
Interface ReadOnlyIdentityProvider

All Superinterfaces:

Session

All Known Implementing Classes:

DbIdentityServiceProvider, DbReadOnlyIdentityServiceProvider

public interface ReadOnlyIdentityProvider
extends Session

SPI interface for read-only identity Service Providers.

This interface provides access to a read-only user / group repository

Author:

Daniel Meyer

Method Summary

boolean	checkPassword(String userId, String password)
GroupQuery	createGroupQuery()
GroupQuery	createGroupQuery(CommandContext commandContext)
NativeUserQuery	createNativeUserQuery() Creates a NativeUserQuery that allows to select users with native queries.
TenantQuery	createTenantQuery()
TenantQuery	createTenantQuery(CommandContext commandContext)
UserQuery	createUserQuery()
UserQuery	createUserQuery(CommandContext commandContext)
Group	findGroupById(String groupId)
Tenant	findTenantById(String tenantId)
User	findUserById(String userId)

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

close, flush

Method Detail

findUserById

User findUserById(String userId)

Returns:

a User object for the given user id or null if no such user exists.

Throws:

IdentityProviderException - in case an error occurs

createUserQuery

UserQuery createUserQuery()

Returns:

a UserQuery object which can be used for querying for users.

Throws:

IdentityProviderException - in case an error occurs

createUserQuery

UserQuery createUserQuery(CommandContext commandContext)

Returns:

a UserQuery object which can be used in the current command context

Throws:

IdentityProviderException - in case an error occurs

createNativeUserQuery

NativeUserQuery createNativeUserQuery()

Creates a NativeUserQuery that allows to select users with native queries.

Returns:

NativeUserQuery

checkPassword

boolean checkPassword(String userId,
                      String password)

Returns:

'true' if the password matches the

Throws:

IdentityProviderException - in case an error occurs

findGroupById

Group findGroupById(String groupId)

Returns:

a Group object for the given group id or null if no such group exists.

Throws:

IdentityProviderException - in case an error occurs

createGroupQuery

GroupQuery createGroupQuery()

Returns:

a GroupQuery object which can be used for querying for groups.

Throws:

IdentityProviderException - in case an error occurs

createGroupQuery

GroupQuery createGroupQuery(CommandContext commandContext)

Returns:

a GroupQuery object which can be used for querying for groups and can be reused in the current command context.

Throws:

IdentityProviderException - in case an error occurs

findTenantById

Tenant findTenantById(String tenantId)

Returns:

a Tenant object for the given id or null if no such tenant exists.

Throws:

IdentityProviderException - in case an error occurs

createTenantQuery

TenantQuery createTenantQuery()

Returns:

a TenantQuery object which can be used for querying for tenants.

Throws:

IdentityProviderException - in case an error occurs

createTenantQuery

TenantQuery createTenantQuery(CommandContext commandContext)

Returns:

a TenantQuery object which can be used for querying for tenants and can be reused in the current command context.

Throws:

IdentityProviderException - in case an error occurs