| Package | Description |
|---|---|
| org.camunda.bpm.engine |
Public API of the camunda BPM engine.
Typical usage of the API starts by the creation of a ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine can be obtained.Through the services obtained from such a ProcessEngine, BPM and workflow operation
can be executed:RepositoryService:
Manages DeploymentsRuntimeService:
For starting and searching ProcessInstancesTaskService:
Exposes operations to manage human (standalone) Tasks,
such as claiming, completing and assigning tasksIdentityService:
Used for managing Users,
Groups and the relations between themManagementService:
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution of business processesHistoryService:
Exposes information about ongoing and past process instances.FormService:
Access to form data and rendered forms for starting new process instances and completing tasks. |
| org.camunda.bpm.engine.identity |
classes related to the
IdentityService. |
| org.camunda.bpm.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.camunda.bpm.engine.impl.cmd | |
| org.camunda.bpm.engine.impl.identity | |
| org.camunda.bpm.engine.impl.identity.db | |
| org.camunda.bpm.engine.rest.dto.identity | |
| org.camunda.bpm.engine.rest.impl | |
| org.camunda.bpm.identity.impl.ldap |
| Modifier and Type | Method and Description |
|---|---|
UserQuery |
IdentityService.createUserQuery()
Creates a
UserQuery that allows to programmatically query the users. |
| Modifier and Type | Method and Description |
|---|---|
UserQuery |
UserQuery.memberOfGroup(String groupId)
Only select
Users that belong to the given group. |
UserQuery |
UserQuery.orderByUserEmail()
Order by user email (needs to be followed by
Query.asc() or Query.desc()). |
UserQuery |
UserQuery.orderByUserFirstName()
Order by user first name (needs to be followed by
Query.asc() or Query.desc()). |
UserQuery |
UserQuery.orderByUserId()
Order by user id (needs to be followed by
Query.asc() or Query.desc()). |
UserQuery |
UserQuery.orderByUserLastName()
Order by user last name (needs to be followed by
Query.asc() or Query.desc()). |
UserQuery |
UserQuery.potentialStarter(String procDefId)
Only select
UserS that are potential starter for the given process definition. |
UserQuery |
UserQuery.userEmail(String email)
Only those
Users with the given email addres. |
UserQuery |
UserQuery.userEmailLike(String emailLike)
Only select
Users where the email matches the given parameter. |
UserQuery |
UserQuery.userFirstName(String firstName)
Only select
Users with the given firstName. |
UserQuery |
UserQuery.userFirstNameLike(String firstNameLike)
Only select
Users where the first name matches the given parameter. |
UserQuery |
UserQuery.userId(String id)
Only select
Users with the given id/ |
UserQuery |
UserQuery.userIdIn(String... ids)
Only select
Users with the given ids |
UserQuery |
UserQuery.userLastName(String lastName)
Only select
Users with the given lastName. |
UserQuery |
UserQuery.userLastNameLike(String lastNameLike)
Only select
Users where the last name matches the given parameter. |
| Modifier and Type | Class and Description |
|---|---|
class |
UserQueryImpl |
| Modifier and Type | Method and Description |
|---|---|
UserQuery |
IdentityServiceImpl.createUserQuery() |
UserQuery |
UserQueryImpl.memberOfGroup(String groupId) |
UserQuery |
UserQueryImpl.orderByUserEmail() |
UserQuery |
UserQueryImpl.orderByUserFirstName() |
UserQuery |
UserQueryImpl.orderByUserId() |
UserQuery |
UserQueryImpl.orderByUserLastName() |
UserQuery |
UserQueryImpl.potentialStarter(String procDefId) |
UserQuery |
UserQueryImpl.userEmail(String email) |
UserQuery |
UserQueryImpl.userEmailLike(String emailLike) |
UserQuery |
UserQueryImpl.userFirstName(String firstName) |
UserQuery |
UserQueryImpl.userFirstNameLike(String firstNameLike) |
UserQuery |
UserQueryImpl.userId(String id) |
UserQuery |
UserQueryImpl.userIdIn(String... ids) |
UserQuery |
UserQueryImpl.userLastName(String lastName) |
UserQuery |
UserQueryImpl.userLastNameLike(String lastNameLike) |
| Modifier and Type | Method and Description |
|---|---|
UserQuery |
CreateUserQueryCmd.execute(CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
UserQuery |
ReadOnlyIdentityProvider.createUserQuery() |
UserQuery |
ReadOnlyIdentityProvider.createUserQuery(CommandContext commandContext) |
| Modifier and Type | Class and Description |
|---|---|
class |
DbUserQueryImpl |
| Modifier and Type | Method and Description |
|---|---|
UserQuery |
DbReadOnlyIdentityServiceProvider.createUserQuery() |
| Modifier and Type | Method and Description |
|---|---|
protected UserQuery |
UserQueryDto.createNewQuery(ProcessEngine engine) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
UserQueryDto.applyFilters(UserQuery query) |
protected void |
UserQueryDto.applySortBy(UserQuery query,
String sortBy,
Map<String,Object> parameters,
ProcessEngine engine) |
| Modifier and Type | Method and Description |
|---|---|
protected List<User> |
UserRestServiceImpl.executePaginatedQuery(UserQuery query,
Integer firstResult,
Integer maxResults) |
| Modifier and Type | Class and Description |
|---|---|
class |
LdapUserQueryImpl |
| Modifier and Type | Method and Description |
|---|---|
UserQuery |
LdapIdentityProviderSession.createUserQuery() |
UserQuery |
LdapUserQueryImpl.desc() |
Copyright © 2018. All rights reserved.