| Package | Description |
|---|---|
| org.camunda.bpm.cockpit.plugin.resource | |
| 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.authorization | |
| org.camunda.bpm.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.camunda.bpm.engine.impl.cfg | |
| org.camunda.bpm.engine.impl.cfg.auth | |
| org.camunda.bpm.engine.impl.cfg.multitenancy | |
| org.camunda.bpm.engine.impl.cmd | |
| org.camunda.bpm.engine.impl.cmd.batch | |
| org.camunda.bpm.engine.impl.db | |
| org.camunda.bpm.engine.impl.identity.db | |
| org.camunda.bpm.engine.impl.persistence | |
| org.camunda.bpm.engine.impl.persistence.entity | |
| org.camunda.bpm.engine.impl.util | |
| org.camunda.bpm.engine.rest.impl | |
| org.camunda.bpm.identity.impl.ldap | |
| org.camunda.bpm.qa.performance.engine.junit | |
| org.camunda.bpm.qa.rolling.update.scenarios.authorization |
| Modifier and Type | Method and Description |
|---|---|
protected void |
AbstractCockpitPluginResource.addPermissionCheck(QueryParameters<?> query,
Resource resource,
String queryParam,
Permission permission)
Add a new
PermissionCheck with the given values. |
protected boolean |
AbstractCockpitPluginResource.isPermissionDisabled(Permission permission) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
AuthorizationService.isUserAuthorized(String userId,
List<String> groupIds,
Permission permission,
Resource resource)
Allows performing an authorization check.
|
boolean |
AuthorizationService.isUserAuthorized(String userId,
List<String> groupIds,
Permission permission,
Resource resource,
String resourceId)
Allows performing an authorization check.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BatchPermissions
The set of built-in
Permissions for Batch operations in Camunda BPM. |
class |
OptimizePermissions
The set of built-in
Permissions for
Optimize resource in Camunda BPM. |
class |
Permissions
The set of built-in
Permissions for camunda BPM. |
class |
ProcessDefinitionPermissions
The set of built-in
Permissions for Process definition in Camunda BPM. |
class |
ProcessInstancePermissions
The set of built-in
Permissions for Process instances in Camunda BPM. |
class |
TaskPermissions
The set of built-in
Permissions for Task in Camunda BPM. |
class |
UserOperationLogCategoryPermissions
The set of built-in
Permissions for User operation log based on categories in Camunda BPM. |
| Modifier and Type | Method and Description |
|---|---|
static Permission |
Permissions.forName(String name) |
static Permission |
BatchPermissions.forName(String name) |
Permission[] |
Authorization.getPermissions(Permission[] permissions)
Allows checking whether this authorization grants / revokes a set of permissions.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Authorization.addPermission(Permission permission)
allows granting a permission.
|
Permission[] |
Authorization.getPermissions(Permission[] permissions)
Allows checking whether this authorization grants / revokes a set of permissions.
|
AuthorizationQuery |
AuthorizationQuery.hasPermission(Permission permission)
only selects authorizations which grant the permissions represented by the parameter.
|
boolean |
Authorization.isPermissionGranted(Permission permission)
Allows checking whether this authorization grants a specific permission.
|
boolean |
Authorization.isPermissionRevoked(Permission permission)
Allows checking whether this authorization revokes a specific permission.
|
void |
Authorization.removePermission(Permission permission)
allows removing a permission.
|
void |
Authorization.setPermissions(Permission[] permissions)
Sets the permissions to the provided value.
|
| Modifier and Type | Method and Description |
|---|---|
AuthorizationQuery |
AuthorizationQueryImpl.hasPermission(Permission p) |
boolean |
AuthorizationServiceImpl.isUserAuthorized(String userId,
List<String> groupIds,
Permission permission,
Resource resource) |
boolean |
AuthorizationServiceImpl.isUserAuthorized(String userId,
List<String> groupIds,
Permission permission,
Resource resource,
String resourceId) |
| Modifier and Type | Field and Description |
|---|---|
protected Permission |
ProcessEngineConfigurationImpl.defaultUserPermissionForTask |
| Modifier and Type | Method and Description |
|---|---|
Permission |
ProcessEngineConfigurationImpl.getDefaultUserPermissionForTask() |
| Modifier and Type | Method and Description |
|---|---|
void |
CommandChecker.checkCreateBatch(Permission permission)
Check if it is allowed to create a batch
|
ProcessEngineConfigurationImpl |
ProcessEngineConfigurationImpl.setDefaultUserPermissionForTask(Permission defaultUserPermissionForTask) |
| Modifier and Type | Method and Description |
|---|---|
protected Permission |
DefaultAuthorizationProvider.getDefaultUserPermissionForTask() |
Permission |
PermissionProvider.getPermissionForName(String name,
int resourceType)
Gets the permission related to the name and resource type
|
Permission |
DefaultPermissionProvider.getPermissionForName(String name,
int resourceType) |
Permission[] |
PermissionProvider.getPermissionsForResource(int resourceType)
Gets all permissions possible for the resource type
|
Permission[] |
DefaultPermissionProvider.getPermissionsForResource(int resourceType) |
protected Permission |
DefaultAuthorizationProvider.getSpecificReadVariablePermission() |
| Modifier and Type | Method and Description |
|---|---|
void |
AuthorizationCommandChecker.checkCreateBatch(Permission permission) |
protected void |
AuthorizationCommandChecker.checkTaskPermission(TaskEntity task,
Permission processDefinitionPermission,
Permission taskPermission) |
protected AuthorizationEntity |
DefaultAuthorizationProvider.createGrantAuthorization(String userId,
String groupId,
Resource resource,
String resourceId,
Permission... permissions) |
protected AuthorizationEntity |
DefaultAuthorizationProvider.updateAuthorization(AuthorizationEntity authorization,
String userId,
String groupId,
Resource resource,
String resourceId,
Permission... permissions) |
| Modifier and Type | Method and Description |
|---|---|
void |
TenantCommandChecker.checkCreateBatch(Permission permission) |
| Modifier and Type | Field and Description |
|---|---|
protected Permission |
AuthorizationCheckCmd.permission |
| Modifier and Type | Method and Description |
|---|---|
protected void |
AuthorizationCheckCmd.validate(String userId,
List<String> groupIds,
Permission permission,
Resource resource) |
| Constructor and Description |
|---|
AuthorizationCheckCmd(String userId,
List<String> groupIds,
Permission permission,
Resource resource,
String resourceId) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
AbstractBatchCmd.checkAuthorizations(CommandContext commandContext,
Permission permission) |
| Modifier and Type | Field and Description |
|---|---|
protected Permission |
PermissionCheck.permission
the permission to check for
|
| Modifier and Type | Method and Description |
|---|---|
Permission |
PermissionCheck.getPermission() |
| Modifier and Type | Method and Description |
|---|---|
PermissionCheckBuilder |
PermissionCheckBuilder.atomicCheck(Resource resource,
String queryParam,
Permission permission) |
PermissionCheckBuilder |
PermissionCheckBuilder.atomicCheckForResourceId(Resource resource,
String resourceId,
Permission permission) |
boolean |
PermissionCheckBuilder.isPermissionDisabled(Permission permission) |
void |
PermissionCheck.setPermission(Permission permission) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
DbReadOnlyIdentityServiceProvider.checkAuthorization(Permission permission,
Resource resource,
String resourceId) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
AbstractManager.checkAuthorization(Permission permission,
Resource resource,
String resourceId) |
| Modifier and Type | Method and Description |
|---|---|
Permission[] |
AuthorizationEntity.getPermissions(Permission[] permissions) |
| Modifier and Type | Method and Description |
|---|---|
Set<Permission> |
AuthorizationEntity.getCachedPermissions() |
| Modifier and Type | Method and Description |
|---|---|
void |
AuthorizationEntity.addPermission(Permission p) |
void |
AuthorizationManager.checkAuthorization(Permission permission,
Resource resource) |
void |
AuthorizationManager.checkAuthorization(Permission permission,
Resource resource,
String resourceId) |
void |
AuthorizationManager.configureQuery(AbstractQuery query,
Resource resource,
String queryParam,
Permission permission) |
Permission[] |
AuthorizationEntity.getPermissions(Permission[] permissions) |
boolean |
AuthorizationManager.isAuthorized(Permission permission,
Resource resource,
String resourceId) |
boolean |
AuthorizationManager.isAuthorized(String userId,
List<String> groupIds,
Permission permission,
Resource resource,
String resourceId) |
boolean |
AuthorizationManager.isPermissionDisabled(Permission permission) |
boolean |
AuthorizationEntity.isPermissionGranted(Permission p) |
boolean |
AuthorizationEntity.isPermissionRevoked(Permission p) |
void |
AuthorizationEntity.removePermission(Permission p) |
void |
AuthorizationEntity.setPermissions(Permission[] permissions) |
| Modifier and Type | Method and Description |
|---|---|
static Permission |
ResourceTypeUtil.getPermissionByNameAndResourceType(String permissionName,
int resourceType)
Currently used only in the Rest API
Returns a
Permission based on the specified permissionName and resourceType |
static Permission[] |
ResourceTypeUtil.getPermissionsByResourceType(int givenResourceType)
Retrieves the
Permission array based on the predifined PERMISSION_ENUMS |
static Permission[] |
PermissionConverter.getPermissionsForNames(String[] names,
int resourceType,
ProcessEngineConfiguration engineConfiguration) |
| Modifier and Type | Method and Description |
|---|---|
static Map<Integer,Class<? extends Enum<? extends Permission>>> |
ResourceTypeUtil.getPermissionEnums() |
| Modifier and Type | Method and Description |
|---|---|
static String[] |
PermissionConverter.getNamesForPermissions(Authorization authorization,
Permission[] permissions) |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
AbstractAuthorizedRestResource.isAuthorized(Permission permission) |
protected boolean |
AbstractAuthorizedRestResource.isAuthorized(Permission permission,
Resource resource) |
protected boolean |
AbstractAuthorizedRestResource.isAuthorized(Permission permission,
Resource resource,
String resourceId) |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
LdapIdentityProviderSession.isAuthorized(Permission permission,
Resource resource,
String resourceId) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
AuthorizationPerformanceTestCase.grouptGrant(String groupId,
Resource resource,
Permission... perms) |
protected void |
AuthorizationPerformanceTestCase.userGrant(String userId,
Resource resource,
Permission... perms) |
| Modifier and Type | Method and Description |
|---|---|
protected static Authorization |
AuthorizationScenario.createAuthorization(AuthorizationService authorizationService,
Permission permission,
Resources resource,
String userId) |
Copyright © 2022. All rights reserved.