Package com.flowable.platform.service.process

Class PlatformProcessInstanceService

java.lang.Object

com.flowable.platform.security.service.AbstractPlatformSecurityService

com.flowable.platform.service.process.PlatformProcessInstanceService

All Implemented Interfaces:

PermissionServiceRegistryAware, Aware

@Transactional
public class PlatformProcessInstanceService
extends AbstractPlatformSecurityService

Author:

Yvo Swillens

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditService	auditService
protected org.flowable.cmmn.api.CmmnHistoryService	cmmnHistoryService
protected CoreContentService	contentService
protected CoreRestDataInterceptor	coreRestDataInterceptor
protected DataObjectRuntimeService	dataObjectRuntimeService
protected DocumentMetadataHandler	documentMetadataHandler
protected DocumentRepositoryService	documentRepositoryService
protected final boolean	enableAuditLog
protected org.flowable.spring.SpringProcessEngineConfiguration	engineConfiguration
protected org.flowable.form.api.FormService	formService
protected FormServiceInvoker	formServiceInvoker
protected org.flowable.engine.HistoryService	historyService
protected PlatformIdentityService	identityService
protected ObjectProvider<InspectProcessInstanceInterceptor>	inspectProcessInstanceInterceptor
protected MetadataService	metadataService
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected String	participantCandidateGroups
protected PlatformCommentService	platformCommentService
protected PlatformContentItemPermissionHandler	platformContentItemPermissionHandler
protected PlatformContentItemService	platformContentItemService
protected PlatformEngineConfiguration	platformEngineConfiguration
protected PlatformTranslationService	platformTranslationService
protected ProcessPermissionService	processPermissionService
protected org.flowable.rest.service.api.RestResponseFactory	restResponseFactory
protected ScopedFormProvider	scopedFormProvider
protected PlatformRestVariableTransformer	variableTransformer

Fields inherited from class com.flowable.platform.security.service.AbstractPlatformSecurityService

additionalAdminUsers, CASE_PREFIX, cmmnRepositoryService, cmmnRuntimeService, cmmnTaskService, defaultSecurityPolicyKey, defaultSecurityPolicyModel, EXTERNAL_WORKER_PREFIX, inspectEnabled, permissionServiceRegistry, platformSecurityInterceptor, policyRepositoryService, PROCESS_PREFIX, repositoryService, runtimeService, SECURITY_POLICY_MODEL, TASK_PREFIX, taskService

Constructor Summary

Constructors

Constructor	Description
PlatformProcessInstanceService(boolean enableAuditLog, String participantCandidateGroups)

Method Summary

Modifier and Type	Method	Description
protected void	addTranslations(ProcessInstanceRepresentation processInstanceRepresentation, org.flowable.engine.repository.ProcessDefinition processDefinition)
void	assign(String processInstanceId, String userId)
protected PlatformUserQuery	createPlatformUserQuery(PlatformUserQueryRequest request)
CommentInstanceRepresentation	createProcessInstanceComment(String processInstanceId, String commentContent)
PlatformUserQuery	createProcessParticipantCandidateUsersQuery(String processInstanceId, PlatformUserQueryRequest request)
void	deleteProcessInstanceComment(String processInstanceId, String commentId)
protected org.flowable.engine.runtime.ProcessInstance	fetchProcessInstance(String processInstanceId)
protected ProcessInstanceInfo	fetchProcessInstanceWithHistory(String processInstanceId)
org.flowable.content.api.ContentItem	getContentItem(String processInstanceId, String contentItemId)
protected Map<String,Object>	getHistoricVariables(String processInstanceId)
org.flowable.content.api.ContentItem	getLatestContentItem(String processInstanceId, String contentItemId)
ProcessInstanceRepresentation	getProcessInstance(String processInstanceId, boolean includeTranslations)
org.flowable.common.rest.api.DataResponse<CommentInstanceRepresentation>	getProcessInstanceComments(CommentQueryRequest request)
StatusOptionsRepresentation	getProcessInstanceStatusOptions(String processInstanceId)
protected Map<String,Object>	getProcessVariables(String processInstanceId)
Map<String,Object>	getScopedVariablesByProcessInstanceId(String processInstanceId, String subScopeId)
org.flowable.form.api.FormInfo	getStartFormForProcessInstanceId(String processInstanceId)
Map<String,Object>	getStartFormVariablesByProcessInstanceId(String processInstanceId)
protected Map<String,Object>	getStartFormVariablesByProcessInstanceIdWithoutPermissionCheck(String processInstanceId)
protected org.flowable.rest.service.api.engine.variable.RestVariable	getUpdatedVariableWithoutAccessCheck(org.flowable.engine.runtime.Execution execution, String variableName, org.flowable.rest.service.api.engine.variable.RestVariable.RestVariableScope variableScope)
Map<String,Object>	getVariablesByProcessInstanceId(String processInstanceId, String subScopeId)
Map<String,Object>	getVariablesByProcessInstanceIdWithPermissionCheck(String processInstanceId, String subScopeId)
org.flowable.form.api.FormInfo	getWorkFormForProcessInstanceId(String processInstanceId)
protected String	getWorkFormValidationExpression(String processDefinitionId)
protected boolean	hasVariableOnScope(org.flowable.engine.runtime.Execution execution, String variableName, org.flowable.rest.service.api.engine.variable.RestVariable.RestVariableScope scope)
ServiceInvocationResultResponseResponse	invokeFormFieldService(String instanceId, String fieldId, String operationType, Map<String,Object> serviceInvocationInput)
ServiceInvocationResultResponseResponse	invokeFormFieldService(String instanceId, String fieldId, Map<String,Object> serviceInvocationInput)
protected boolean	isFormFieldValidationEnabled(org.flowable.common.engine.api.variable.VariableContainer variableContainer, String workFormValidationExpression)
protected void	logSaveProcessEvent(org.flowable.engine.runtime.ProcessInstance processInstance)
void	saveDocuments(String processInstanceId, Map<String,Object> variables)
void	saveWorkForm(String processInstanceId, Map<String,Object> variables)
ProcessInstanceRepresentation	startNewProcessInstance(CreateProcessInstanceRepresentation startRequest, boolean includeTranslations, boolean includeNextTaskInfo, boolean createTestDefinition)
protected void	transformVariables(Map<String,Object> variables)
org.flowable.rest.service.api.engine.variable.RestVariable	updateExecutionVariable(String executionId, String variableName, jakarta.servlet.http.HttpServletRequest request)
CommentInstanceRepresentation	updateProcessInstanceComment(String processInstanceId, String commentId, String commentContent)
void	updateProcessInstanceStatus(String processInstanceId, String status)

Methods inherited from class com.flowable.platform.security.service.AbstractPlatformSecurityService

addAdditionalPermissions, currentUserHasAdminRights, currentUserIsSuperAdmin, fetchCasePermissionMappings, fetchCasePermissionMappings, fetchCaseSecurityPolicyModel, fetchPermissions, fetchPermissionsForTask, fetchProcessPermissionMappings, fetchProcessPermissionMappings, fetchProcessSecurityPolicyModel, fetchSecurityPolicyModel, fetchSecurityPolicyModel, fetchSecurityPolicyModelForCaseInstance, fetchSecurityPolicyModelForProcessInstance, fetchSecurityPolicyModelForTask, fetchSecurityPolicyModelForTask, fetchTaskPermissionMappings, fetchTaskPermissionMappings, fetchTaskPermissionMappings, fetchTaskPermissionMappingsForCase, fetchTaskPermissionMappingsForProcess, fetchTaskSecurityPolicyModelForCase, fetchTaskSecurityPolicyModelForProcess, filterPermissionsForRole, getCmmnExtensionElementValue, getCurrentGroupKeys, getCurrentSecurityScope, getCurrentTenantId, getCurrentUserId, getDefaultSecurityPolicyModel, getExtensionElementValue, getSecurityPolicyModelByKey, groupOrUserMatches, groupOrUserMatches, hasAnyMatchingIdentityLink, hasAssigneeOrOwnerIdentityLink, hasPermissionForEntityLinks, hasPermissionForHistoricEntityLinks, setPermissionServiceRegistry, translatePermissionForScope

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

enableAuditLog

protected final boolean enableAuditLog

processPermissionService

@Autowired
protected ProcessPermissionService processPermissionService

historyService

@Autowired
protected org.flowable.engine.HistoryService historyService

cmmnHistoryService

@Autowired
protected org.flowable.cmmn.api.CmmnHistoryService cmmnHistoryService

formService

@Autowired
protected org.flowable.form.api.FormService formService

platformTranslationService

@Autowired(required=false)
protected PlatformTranslationService platformTranslationService

platformCommentService

@Autowired(required=false)
protected PlatformCommentService platformCommentService

auditService

@Autowired(required=false)
protected AuditService auditService

platformContentItemService

@Autowired(required=false)
protected PlatformContentItemService platformContentItemService

contentService

@Autowired(required=false)
protected CoreContentService contentService

metadataService

@Autowired(required=false)
protected MetadataService metadataService

dataObjectRuntimeService

@Autowired(required=false)
protected DataObjectRuntimeService dataObjectRuntimeService

platformEngineConfiguration

@Autowired(required=false)
protected PlatformEngineConfiguration platformEngineConfiguration

documentRepositoryService

@Autowired(required=false)
protected DocumentRepositoryService documentRepositoryService

documentMetadataHandler

@Autowired(required=false)
protected DocumentMetadataHandler documentMetadataHandler

platformContentItemPermissionHandler

@Autowired(required=false)
protected PlatformContentItemPermissionHandler platformContentItemPermissionHandler

inspectProcessInstanceInterceptor

@Autowired
protected ObjectProvider<InspectProcessInstanceInterceptor> inspectProcessInstanceInterceptor

variableTransformer

@Autowired
protected PlatformRestVariableTransformer variableTransformer

engineConfiguration

@Autowired
protected org.flowable.spring.SpringProcessEngineConfiguration engineConfiguration

objectMapper

@Autowired
protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

scopedFormProvider

@Autowired
protected ScopedFormProvider scopedFormProvider

coreRestDataInterceptor

@Autowired(required=false)
protected CoreRestDataInterceptor coreRestDataInterceptor

formServiceInvoker

@Autowired
protected FormServiceInvoker formServiceInvoker

identityService

@Autowired
protected PlatformIdentityService identityService

restResponseFactory

@Autowired(required=false)
protected org.flowable.rest.service.api.RestResponseFactory restResponseFactory

participantCandidateGroups

protected String participantCandidateGroups

Constructor Details

PlatformProcessInstanceService

public PlatformProcessInstanceService(boolean enableAuditLog,
 String participantCandidateGroups)

Method Details

createProcessParticipantCandidateUsersQuery

public PlatformUserQuery createProcessParticipantCandidateUsersQuery(String processInstanceId,
 PlatformUserQueryRequest request)

getProcessInstance

public ProcessInstanceRepresentation getProcessInstance(String processInstanceId,
 boolean includeTranslations)

getProcessInstanceStatusOptions

public StatusOptionsRepresentation getProcessInstanceStatusOptions(String processInstanceId)

updateProcessInstanceStatus

public void updateProcessInstanceStatus(String processInstanceId,
 String status)

addTranslations

protected void addTranslations(ProcessInstanceRepresentation processInstanceRepresentation,
 org.flowable.engine.repository.ProcessDefinition processDefinition)

getStartFormVariablesByProcessInstanceId

public Map<String,Object> getStartFormVariablesByProcessInstanceId(String processInstanceId)

getStartFormVariablesByProcessInstanceIdWithoutPermissionCheck

protected Map<String,Object> getStartFormVariablesByProcessInstanceIdWithoutPermissionCheck(String processInstanceId)

getStartFormForProcessInstanceId

public org.flowable.form.api.FormInfo getStartFormForProcessInstanceId(String processInstanceId)

startNewProcessInstance

public ProcessInstanceRepresentation startNewProcessInstance(CreateProcessInstanceRepresentation startRequest,
 boolean includeTranslations,
 boolean includeNextTaskInfo,
 boolean createTestDefinition)

getWorkFormForProcessInstanceId

public org.flowable.form.api.FormInfo getWorkFormForProcessInstanceId(String processInstanceId)

invokeFormFieldService

public ServiceInvocationResultResponseResponse invokeFormFieldService(String instanceId,
 String fieldId,
 Map<String,Object> serviceInvocationInput)

invokeFormFieldService

public ServiceInvocationResultResponseResponse invokeFormFieldService(String instanceId,
 String fieldId,
 String operationType,
 Map<String,Object> serviceInvocationInput)

saveWorkForm

public void saveWorkForm(String processInstanceId,
 Map<String,Object> variables)

saveDocuments

public void saveDocuments(String processInstanceId,
 Map<String,Object> variables)

getVariablesByProcessInstanceIdWithPermissionCheck

public Map<String,Object> getVariablesByProcessInstanceIdWithPermissionCheck(String processInstanceId,
 String subScopeId)

getVariablesByProcessInstanceId

public Map<String,Object> getVariablesByProcessInstanceId(String processInstanceId,
 String subScopeId)

getScopedVariablesByProcessInstanceId

public Map<String,Object> getScopedVariablesByProcessInstanceId(String processInstanceId,
 String subScopeId)

assign

@Transactional
public void assign(String processInstanceId,
 String userId)

updateExecutionVariable

public org.flowable.rest.service.api.engine.variable.RestVariable updateExecutionVariable(String executionId,
 String variableName,
 jakarta.servlet.http.HttpServletRequest request)

getProcessVariables

protected Map<String,Object> getProcessVariables(String processInstanceId)

getHistoricVariables

protected Map<String,Object> getHistoricVariables(String processInstanceId)

fetchProcessInstance

protected org.flowable.engine.runtime.ProcessInstance fetchProcessInstance(String processInstanceId)

fetchProcessInstanceWithHistory

protected ProcessInstanceInfo fetchProcessInstanceWithHistory(String processInstanceId)

transformVariables

protected void transformVariables(Map<String,Object> variables)

isFormFieldValidationEnabled

protected boolean isFormFieldValidationEnabled(org.flowable.common.engine.api.variable.VariableContainer variableContainer,
 String workFormValidationExpression)

getWorkFormValidationExpression

protected String getWorkFormValidationExpression(String processDefinitionId)

logSaveProcessEvent

protected void logSaveProcessEvent(org.flowable.engine.runtime.ProcessInstance processInstance)

getProcessInstanceComments

public org.flowable.common.rest.api.DataResponse<CommentInstanceRepresentation> getProcessInstanceComments(CommentQueryRequest request)

createProcessInstanceComment

public CommentInstanceRepresentation createProcessInstanceComment(String processInstanceId,
 String commentContent)

updateProcessInstanceComment

public CommentInstanceRepresentation updateProcessInstanceComment(String processInstanceId,
 String commentId,
 String commentContent)

deleteProcessInstanceComment

public void deleteProcessInstanceComment(String processInstanceId,
 String commentId)

getContentItem

public org.flowable.content.api.ContentItem getContentItem(String processInstanceId,
 String contentItemId)

getLatestContentItem

public org.flowable.content.api.ContentItem getLatestContentItem(String processInstanceId,
 String contentItemId)

getUpdatedVariableWithoutAccessCheck

protected org.flowable.rest.service.api.engine.variable.RestVariable getUpdatedVariableWithoutAccessCheck(org.flowable.engine.runtime.Execution execution,
 String variableName,
 org.flowable.rest.service.api.engine.variable.RestVariable.RestVariableScope variableScope)

hasVariableOnScope

protected boolean hasVariableOnScope(org.flowable.engine.runtime.Execution execution,
 String variableName,
 org.flowable.rest.service.api.engine.variable.RestVariable.RestVariableScope scope)

createPlatformUserQuery

protected PlatformUserQuery createPlatformUserQuery(PlatformUserQueryRequest request)