org.apache.syncope.core.flowable.impl

Class FlowableUserRequestHandler

java.lang.Object

org.apache.syncope.core.flowable.impl.FlowableUserRequestHandler

All Implemented Interfaces:

UserRequestHandler

@Transactional(propagation=REQUIRES_NEW,
               rollbackFor=java.lang.Throwable.class)
public class FlowableUserRequestHandler
extends Object
implements UserRequestHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected String	adminUser
protected org.apache.syncope.core.provisioning.api.data.UserDataBinder	dataBinder
protected DomainProcessEngine	engine
protected org.apache.syncope.core.persistence.api.entity.EntityFactory	entityFactory
protected static org.slf4j.Logger	LOG
protected org.apache.syncope.core.persistence.api.dao.UserDAO	userDAO
protected WorkflowTaskManager	wfTaskManager

Constructor Summary

Constructors

Constructor and Description
FlowableUserRequestHandler()

Method Summary

Modifier and Type	Method and Description
void	cancel(org.flowable.engine.runtime.ProcessInstance procInst, String reason) Cancel a running user request.
void	cancelByProcessDefinition(String processDefinitionId) Cancel all running user requests for the given process definition id.
void	cancelByUser(org.apache.syncope.core.provisioning.api.event.AnyDeletedEvent event) Cancel all running user requests for the user in the given delete event.
UserRequestForm	claimForm(String taskId) Claim a form for a given object.
protected int	countProcessInstances(StringBuilder processInstanceQuery)
protected StringBuilder	createProcessInstanceQuery(String userKey)
protected UserRequestFormPropertyType	fromFlowableFormType(org.flowable.engine.form.FormType flowableFormType)
protected UserRequestForm	getForm(org.flowable.task.api.history.HistoricTaskInstance task)
UserRequestForm	getForm(String userKey, String taskId) Get the form matching the provided task id.
protected UserRequestForm	getForm(String procInstId, String taskId, String formKey, List<org.flowable.engine.form.FormProperty> props)
protected UserRequestForm	getForm(org.flowable.task.api.Task task)
protected UserRequestForm	getForm(org.flowable.task.api.Task task, org.flowable.engine.form.TaskFormData fd)
org.apache.commons.lang3.tuple.Pair<Integer,List<UserRequestForm>>	getForms(String userKey, int page, int size, List<org.apache.syncope.core.persistence.api.dao.search.OrderByClause> orderByClauses) Get the forms matching the provided parameters.
protected org.apache.commons.lang3.tuple.Pair<Integer,List<UserRequestForm>>	getForms(org.flowable.task.api.TaskQuery query, int page, int size, List<org.apache.syncope.core.persistence.api.dao.search.OrderByClause> orderByClauses)
protected UserRequestForm	getHistoricFormTO(String procInstId, String taskId, String formKey, List<org.flowable.engine.impl.persistence.entity.HistoricFormPropertyEntity> props)
protected <T> T	getHistoricVariable(List<org.flowable.variable.api.history.HistoricVariableInstance> historicVariables, String name, Class<T> valueRef)
protected Map<String,String>	getPropertiesForSubmit(UserRequestForm form)
protected org.flowable.task.api.Task	getTask(String taskId)
protected String	getUserKey(String procInstId)
protected UserRequest	getUserRequest(org.flowable.engine.runtime.ProcessInstance procInst)
org.apache.commons.lang3.tuple.Pair<Integer,List<UserRequest>>	getUserRequests(String userKey, int page, int size, List<org.apache.syncope.core.persistence.api.dao.search.OrderByClause> orderByClauses) Get the running user requests matching the provided parameters.
protected org.apache.syncope.core.persistence.api.entity.user.User	lazyLoad(org.apache.syncope.core.persistence.api.entity.user.User user)
org.apache.commons.lang3.tuple.Pair<org.flowable.engine.runtime.ProcessInstance,String>	parse(String executionId) Parses the given execution id to find matching user request and owner.
protected org.apache.commons.lang3.tuple.Pair<org.flowable.task.api.Task,org.flowable.engine.form.TaskFormData>	parseTask(String taskId)
UserRequest	start(String bpmnProcess, org.apache.syncope.core.persistence.api.entity.user.User user, WorkflowTaskExecInput inputVariables) Starts a new user request, for the given BPMN process and user.
org.apache.syncope.core.provisioning.api.UserWorkflowResult<org.apache.syncope.common.lib.patch.UserPatch>	submitForm(UserRequestForm form) Submit a form.
UserRequestForm	unclaimForm(String taskId) Unclaim a form for a given object.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

wfTaskManager

@Autowired
protected WorkflowTaskManager wfTaskManager

dataBinder

@Autowired
protected org.apache.syncope.core.provisioning.api.data.UserDataBinder dataBinder

adminUser

protected String adminUser

engine

@Autowired
protected DomainProcessEngine engine

userDAO

@Autowired
protected org.apache.syncope.core.persistence.api.dao.UserDAO userDAO

entityFactory

@Autowired
protected org.apache.syncope.core.persistence.api.entity.EntityFactory entityFactory

Constructor Detail

FlowableUserRequestHandler

public FlowableUserRequestHandler()

Method Detail

createProcessInstanceQuery

protected StringBuilder createProcessInstanceQuery(String userKey)

countProcessInstances

protected int countProcessInstances(StringBuilder processInstanceQuery)

getUserRequest

protected UserRequest getUserRequest(org.flowable.engine.runtime.ProcessInstance procInst)

getUserRequests

@Transactional(readOnly=true)
public org.apache.commons.lang3.tuple.Pair<Integer,List<UserRequest>> getUserRequests(String userKey,
                                                                                                                    int page,
                                                                                                                    int size,
                                                                                                                    List<org.apache.syncope.core.persistence.api.dao.search.OrderByClause> orderByClauses)

Description copied from interface: UserRequestHandler

Get the running user requests matching the provided parameters.

Specified by:

getUserRequests in interface UserRequestHandler

Parameters:

userKey - user key (optional)

page - result page

size - items per page

orderByClauses - sort conditions

Returns:

total number of user requests, list of user requests matching the provided parameters

lazyLoad

protected org.apache.syncope.core.persistence.api.entity.user.User lazyLoad(org.apache.syncope.core.persistence.api.entity.user.User user)

start

public UserRequest start(String bpmnProcess,
                         org.apache.syncope.core.persistence.api.entity.user.User user,
                         WorkflowTaskExecInput inputVariables)

Description copied from interface: UserRequestHandler

Starts a new user request, for the given BPMN process and user.

Specified by:

start in interface UserRequestHandler

Parameters:

bpmnProcess - BPMN process

user - user

inputVariables - variables

Returns:

data about the started request service, including execution id

parse

public org.apache.commons.lang3.tuple.Pair<org.flowable.engine.runtime.ProcessInstance,String> parse(String executionId)

Description copied from interface: UserRequestHandler

Parses the given execution id to find matching user request and owner.

Specified by:

parse in interface UserRequestHandler

Parameters:

executionId - execution id

Returns:

matching user request and owner

cancel

public void cancel(org.flowable.engine.runtime.ProcessInstance procInst,
                   String reason)

Description copied from interface: UserRequestHandler

Cancel a running user request.

Specified by:

cancel in interface UserRequestHandler

Parameters:

procInst - process instance for user request

reason - reason to cancel the user request

cancelByProcessDefinition

public void cancelByProcessDefinition(String processDefinitionId)

Description copied from interface: UserRequestHandler

Cancel all running user requests for the given process definition id.

Specified by:

cancelByProcessDefinition in interface UserRequestHandler

Parameters:

processDefinitionId - process definition id

cancelByUser

public void cancelByUser(org.apache.syncope.core.provisioning.api.event.AnyDeletedEvent event)

Description copied from interface: UserRequestHandler

Cancel all running user requests for the user in the given delete event.

Specified by:

cancelByUser in interface UserRequestHandler

Parameters:

event - delete event

fromFlowableFormType

protected UserRequestFormPropertyType fromFlowableFormType(org.flowable.engine.form.FormType flowableFormType)

getForm

protected UserRequestForm getForm(org.flowable.task.api.Task task)

getForm

protected UserRequestForm getForm(org.flowable.task.api.Task task,
                                  org.flowable.engine.form.TaskFormData fd)

getForm

protected UserRequestForm getForm(org.flowable.task.api.history.HistoricTaskInstance task)

getUserKey

protected String getUserKey(String procInstId)

getHistoricFormTO

protected UserRequestForm getHistoricFormTO(String procInstId,
                                            String taskId,
                                            String formKey,
                                            List<org.flowable.engine.impl.persistence.entity.HistoricFormPropertyEntity> props)

getForm

protected UserRequestForm getForm(String procInstId,
                                  String taskId,
                                  String formKey,
                                  List<org.flowable.engine.form.FormProperty> props)

getForm

public UserRequestForm getForm(String userKey,
                               String taskId)

Description copied from interface: UserRequestHandler

Get the form matching the provided task id.

Specified by:

getForm in interface UserRequestHandler

Parameters:

userKey - user key

taskId - task id

Returns:

the form for the given task id

getForms

@Transactional(readOnly=true)
public org.apache.commons.lang3.tuple.Pair<Integer,List<UserRequestForm>> getForms(String userKey,
                                                                                                                 int page,
                                                                                                                 int size,
                                                                                                                 List<org.apache.syncope.core.persistence.api.dao.search.OrderByClause> orderByClauses)

Description copied from interface: UserRequestHandler

Get the forms matching the provided parameters.

Specified by:

getForms in interface UserRequestHandler

Parameters:

userKey - user key (optional)

page - result page

size - items per page

orderByClauses - sort conditions

Returns:

total number of forms, list of forms matching the provided parameters

getForms

protected org.apache.commons.lang3.tuple.Pair<Integer,List<UserRequestForm>> getForms(org.flowable.task.api.TaskQuery query,
                                                                                      int page,
                                                                                      int size,
                                                                                      List<org.apache.syncope.core.persistence.api.dao.search.OrderByClause> orderByClauses)

parseTask

protected org.apache.commons.lang3.tuple.Pair<org.flowable.task.api.Task,org.flowable.engine.form.TaskFormData> parseTask(String taskId)

getTask

protected org.flowable.task.api.Task getTask(String taskId)
                                      throws org.apache.syncope.core.persistence.api.dao.NotFoundException

Throws:

org.apache.syncope.core.persistence.api.dao.NotFoundException

claimForm

public UserRequestForm claimForm(String taskId)

Description copied from interface: UserRequestHandler

Claim a form for a given object.

Specified by:

claimForm in interface UserRequestHandler

Parameters:

taskId - Workflow task to which the form is associated

Returns:

updated form

unclaimForm

public UserRequestForm unclaimForm(String taskId)

Description copied from interface: UserRequestHandler

Unclaim a form for a given object.

Specified by:

unclaimForm in interface UserRequestHandler

Parameters:

taskId - Workflow task to which the form is associated

Returns:

updated form

getPropertiesForSubmit

protected Map<String,String> getPropertiesForSubmit(UserRequestForm form)

getHistoricVariable

protected <T> T getHistoricVariable(List<org.flowable.variable.api.history.HistoricVariableInstance> historicVariables,
                                    String name,
                                    Class<T> valueRef)

submitForm

public org.apache.syncope.core.provisioning.api.UserWorkflowResult<org.apache.syncope.common.lib.patch.UserPatch> submitForm(UserRequestForm form)

Description copied from interface: UserRequestHandler

Submit a form.

Specified by:

submitForm in interface UserRequestHandler

Parameters:

form - to be submitted

Returns:

user updated by this form submit