com.evolveum.midpoint.wf.impl.processors

Interface ChangeProcessor

All Known Implementing Classes:

BaseChangeProcessor, GeneralChangeProcessor, PrimaryChangeProcessor

public interface ChangeProcessor

A change processor can be viewed as a kind of framework supporting customer-specific workflow code. Individual change processors are specialized in their areas, allowing customer code to focus on business logic with minimal effort. The name "change processor" is derived from the fact that primary purpose of this framework is to process change requests coming from the model. TODO find a better name However, a change processor has many more duties, e.g. (1) recognizes the instance (instances) of given kind of change within model operation context, (2) processes the result of the workflow process instances when they are finished, (3) presents (externalizes) the content of process instances to outside world: to the GUI, auditing, and notifications. Currently, there are the following change processors implemented or planned: - PrimaryChangeProcessor: manages approvals of changes of objects (in model's primary stage) - GeneralChangeProcessor: manages any change, as configured by the system engineer/administrator

Author:

mederly

Method Summary

Methods

Modifier and Type	Method and Description
MiscDataUtil	getMiscDataUtil() Auxiliary method to access autowired Spring beans from within non-spring java objects.
PrismContext	getPrismContext()
void	onProcessEnd(ProcessEvent event, WfTask wfTask, OperationResult result) Handles an event from WfMS that indicates finishing of the workflow process instance.
AuditEventRecord	prepareProcessInstanceAuditRecord(WfTask wfTask, AuditEventStage stage, Map<String,Object> variables, OperationResult result) Prepares a process instance-related audit record.
AuditEventRecord	prepareWorkItemAuditRecord(com.evolveum.midpoint.xml.ns._public.common.common_3.WorkItemType workItem, WfTask wfTask, TaskEvent taskEvent, AuditEventStage stage, OperationResult result) Prepares a work item-related audit record.
HookOperationMode	processModelInvocation(ModelContext context, com.evolveum.midpoint.xml.ns._public.common.common_3.WfConfigurationType wfConfigurationType, Task taskFromModel, OperationResult result) Processes workflow-related aspect of a model operation.

Method Detail

processModelInvocation

HookOperationMode processModelInvocation(ModelContext context,
                                       com.evolveum.midpoint.xml.ns._public.common.common_3.WfConfigurationType wfConfigurationType,
                                       Task taskFromModel,
                                       OperationResult result)
                                         throws SchemaException,
                                                ObjectNotFoundException

Processes workflow-related aspect of a model operation. Namely, tries to find whether user interaction is necessary, and arranges everything to carry out that interaction.

Parameters:

context - Model context of the operation.

wfConfigurationType -

taskFromModel - Task in context of which the operation is carried out.

result - Where to put information on operation execution.

Returns:

non-null value if it processed the request; BACKGROUND = the process was "caught" by the processor, and continues in background, FOREGROUND = nothing was left on background, the model operation should continue in foreground, ERROR = something wrong has happened, there's no point in continuing with this operation. null if the request is not relevant to this processor Actually, the FOREGROUND return value is quite unusual, because the change processor cannot know in advance whether other processors would not want to process the invocation from the model.

Throws:

SchemaException

ObjectNotFoundException

onProcessEnd

void onProcessEnd(ProcessEvent event,
                WfTask wfTask,
                OperationResult result)
                  throws SchemaException,
                         ObjectAlreadyExistsException,
                         ObjectNotFoundException

Handles an event from WfMS that indicates finishing of the workflow process instance. Usually, at this point we see what was approved (and what was not) and continue with model operation(s).

Parameters:

event -

wfTask -

result - Here should be stored information about whether the finalization was successful or not

Throws:

SchemaException

ObjectAlreadyExistsException

ObjectNotFoundException

prepareProcessInstanceAuditRecord

AuditEventRecord prepareProcessInstanceAuditRecord(WfTask wfTask,
                                                 AuditEventStage stage,
                                                 Map<String,Object> variables,
                                                 OperationResult result)

Prepares a process instance-related audit record.

Parameters:

wfTask -

stage -

variables -

result -

Returns:

prepareWorkItemAuditRecord

AuditEventRecord prepareWorkItemAuditRecord(com.evolveum.midpoint.xml.ns._public.common.common_3.WorkItemType workItem,
                                          WfTask wfTask,
                                          TaskEvent taskEvent,
                                          AuditEventStage stage,
                                          OperationResult result)
                                            throws WorkflowException

Prepares a work item-related audit record.

Parameters:

workItem -

wfTask -

taskEvent -

stage -

result -

Returns:

Throws:

WorkflowException

getMiscDataUtil

MiscDataUtil getMiscDataUtil()

Auxiliary method to access autowired Spring beans from within non-spring java objects.

Returns:

getPrismContext

PrismContext getPrismContext()