Uses of Interface
org.camunda.bpm.engine.authorization.Permission
Package
Description
Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
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 Deployment
sRuntimeService
:
For starting and searching ProcessInstance
sTaskService
:
Exposes operations to manage human (standalone) Task
s,
such as claiming, completing and assigning tasksIdentityService
:
Used for managing User
s,
Group
s 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.API implementation classes, which shouldn't directly be used by end-users.
-
Uses of Permission in org.camunda.bpm.cockpit.plugin.resource
Modifier and TypeMethodDescriptionprotected void
AbstractCockpitPluginResource.addPermissionCheck
(QueryParameters query, Resource resource, String queryParam, Permission permission) Add a newPermissionCheck
with the given values.protected boolean
AbstractCockpitPluginResource.isPermissionDisabled
(Permission permission) -
Uses of Permission in org.camunda.bpm.engine
Modifier and TypeMethodDescriptionboolean
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. -
Uses of Permission in org.camunda.bpm.engine.authorization
Modifier and TypeClassDescriptionenum
The set of built-inPermissions
forBatch operations
in Camunda Platform.enum
The set of built-inPermissions
forHistoric Process Instance
in Camunda Platform.enum
The set of built-inPermissions
forHistoric Task
in Camunda Platform.enum
Deprecated.These permissions have no effectenum
The set of built-inPermissions
for Camunda Platform.enum
The set of built-inPermissions
forProcess definition
in Camunda Platform.enum
The set of built-inPermissions
forProcess instances
in Camunda Platform.enum
enum
The set of built-inPermissions
forTask
in Camunda Platform.enum
The set of built-inPermissions
forUser operation log based on categories
in Camunda Platform.Modifier and TypeMethodDescriptionstatic Permission
static Permission
Authorization.getPermissions
(Permission[] permissions) Allows checking whether this authorization grants / revokes a set of permissions.Modifier and TypeMethodDescriptionvoid
Authorization.addPermission
(Permission permission) allows granting a permission.Authorization.getPermissions
(Permission[] permissions) Allows checking whether this authorization grants / revokes a set of permissions.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. -
Uses of Permission in org.camunda.bpm.engine.impl
Modifier and TypeMethodDescriptionAuthorizationQueryImpl.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) -
Uses of Permission in org.camunda.bpm.engine.impl.batch.builder
-
Uses of Permission in org.camunda.bpm.engine.impl.cfg
Modifier and TypeFieldDescriptionprotected Permission
ProcessEngineConfigurationImpl.defaultUserPermissionForTask
Modifier and TypeMethodDescriptionProcessEngineConfigurationImpl.getDefaultUserPermissionForTask()
Modifier and TypeMethodDescriptionvoid
CommandChecker.checkCreateBatch
(Permission permission) Check if it is allowed to create a batchProcessEngineConfigurationImpl.setDefaultUserPermissionForTask
(Permission defaultUserPermissionForTask) -
Uses of Permission in org.camunda.bpm.engine.impl.cfg.auth
Modifier and TypeMethodDescriptionprotected Permission
DefaultAuthorizationProvider.getDefaultUserPermissionForTask()
protected Permission[]
DefaultAuthorizationProvider.getHistoricPermissions
(boolean enforceSpecificVariablePermission) DefaultPermissionProvider.getPermissionForName
(String name, int resourceType) PermissionProvider.getPermissionForName
(String name, int resourceType) Gets the permission related to the name and resource typeDefaultPermissionProvider.getPermissionsForResource
(int resourceType) PermissionProvider.getPermissionsForResource
(int resourceType) Gets all permissions possible for the resource typeprotected Permission[]
DefaultAuthorizationProvider.getRuntimePermissions
(boolean enforceSpecificVariablePermission) Modifier and TypeMethodDescriptionprotected void
DefaultAuthorizationProvider.addPermissions
(AuthorizationEntity authorization, Permission... permissions) void
AuthorizationCommandChecker.checkCreateBatch
(Permission permission) protected void
AuthorizationCommandChecker.checkTaskPermission
(TaskEntity task, Permission processDefinitionPermission, Permission taskPermission) protected AuthorizationEntity
DefaultAuthorizationProvider.createAuthorization
(String userId, String groupId, Resource resource, String resourceId, Permission... permissions) protected AuthorizationEntity
DefaultAuthorizationProvider.createGrantAuthorization
(String userId, String groupId, Resource resource, String resourceId, Permission... permissions) protected AuthorizationEntity
DefaultAuthorizationProvider.createOrUpdateAuthorization
(Task task, String userId, String groupId, Resource resource, boolean isHistoric, Permission... permissions) -
Uses of Permission in org.camunda.bpm.engine.impl.cfg.multitenancy
Modifier and TypeMethodDescriptionvoid
TenantCommandChecker.checkCreateBatch
(Permission permission) -
Uses of Permission in org.camunda.bpm.engine.impl.cmd
Modifier and TypeMethodDescriptionprotected void
AuthorizationCheckCmd.validate
(String userId, List<String> groupIds, Permission permission, Resource resource) ModifierConstructorDescriptionAuthorizationCheckCmd
(String userId, List<String> groupIds, Permission permission, Resource resource, String resourceId) -
Uses of Permission in org.camunda.bpm.engine.impl.db
Modifier and TypeFieldDescriptionprotected Permission
PermissionCheck.permission
the permission to check forModifier and TypeMethodDescriptionPermissionCheckBuilder.atomicCheck
(Resource resource, String queryParam, Permission permission) PermissionCheckBuilder.atomicCheckForResourceId
(Resource resource, String resourceId, Permission permission) boolean
PermissionCheckBuilder.isPermissionDisabled
(Permission permission) void
PermissionCheck.setPermission
(Permission permission) -
Uses of Permission in org.camunda.bpm.engine.impl.identity.db
Modifier and TypeMethodDescriptionprotected void
DbReadOnlyIdentityServiceProvider.checkAuthorization
(Permission permission, Resource resource, String resourceId) -
Uses of Permission in org.camunda.bpm.engine.impl.persistence
Modifier and TypeMethodDescriptionprotected void
AbstractManager.checkAuthorization
(Permission permission, Resource resource, String resourceId) -
Uses of Permission in org.camunda.bpm.engine.impl.persistence.entity
Modifier and TypeMethodDescriptionvoid
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) AuthorizationEntity.getPermissions
(Permission[] permissions) boolean
AuthorizationManager.isAuthorized
(String userId, List<String> groupIds, Permission permission, Resource resource, String resourceId) boolean
AuthorizationManager.isAuthorized
(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) -
Uses of Permission in org.camunda.bpm.engine.impl.persistence.entity.util
Modifier and TypeFieldDescriptionprotected Permission
AuthManagerUtil.VariablePermissions.historicTaskPermission
protected Permission
AuthManagerUtil.VariablePermissions.processDefinitionPermission
Modifier and TypeMethodDescriptionAuthManagerUtil.VariablePermissions.getHistoricTaskPermission()
AuthManagerUtil.VariablePermissions.getProcessDefinitionPermission()
-
Uses of Permission in org.camunda.bpm.engine.impl.util
Modifier and TypeFieldDescriptionprotected static final Map<Integer,
Class<? extends Enum<? extends Permission>>> ResourceTypeUtil.PERMISSION_ENUMS
A map containing allResources
as a key and the respectivePermission
Enum class for this resource.Modifier and TypeMethodDescriptionstatic Permission
ResourceTypeUtil.getPermissionByNameAndResourceType
(String permissionName, int resourceType) Currently used only in the Rest API Returns aPermission
based on the specifiedpermissionName
andresourceType
static Permission[]
ResourceTypeUtil.getPermissionsByResourceType
(int givenResourceType) Retrieves thePermission
array based on the predifinedPERMISSION_ENUMS
static Permission[]
PermissionConverter.getPermissionsForNames
(String[] names, int resourceType, ProcessEngineConfiguration engineConfiguration) Modifier and TypeMethodDescriptionstatic Map<Integer,
Class<? extends Enum<? extends Permission>>> ResourceTypeUtil.getPermissionEnums()
Modifier and TypeMethodDescriptionstatic String[]
PermissionConverter.getNamesForPermissions
(Authorization authorization, Permission[] permissions) -
Uses of Permission in org.camunda.bpm.engine.rest.impl
Modifier and TypeMethodDescriptionprotected boolean
AbstractAuthorizedRestResource.isAuthorized
(Permission permission) protected boolean
AbstractAuthorizedRestResource.isAuthorized
(Permission permission, Resource resource) protected boolean
AbstractAuthorizedRestResource.isAuthorized
(Permission permission, Resource resource, String resourceId) -
Uses of Permission in org.camunda.bpm.qa.performance.engine.junit
Modifier and TypeMethodDescriptionprotected void
AuthorizationPerformanceTestCase.grouptGrant
(String groupId, Resource resource, Permission... perms) protected void
AuthorizationPerformanceTestCase.userGrant
(String userId, Resource resource, Permission... perms) -
Uses of Permission in org.camunda.bpm.qa.rolling.update.scenarios.authorization
Modifier and TypeMethodDescriptionprotected static Authorization
AuthorizationScenario.createAuthorization
(AuthorizationService authorizationService, Permission permission, Resources resource, String userId)