com.evolveum.midpoint.wf.impl

Class WfHook

java.lang.Object

com.evolveum.midpoint.wf.impl.WfHook

All Implemented Interfaces:

ChangeHook

@Component
public class WfHook
extends Object
implements ChangeHook

Provides an interface between the model and the workflow engine: catches hook calls and delegates them to change processors.

Author:

mederly

Field Summary

Fields

Modifier and Type	Field and Description
static String	WORKFLOW_HOOK_URI

Constructor Summary

Constructors

Constructor and Description
WfHook()

Method Summary

Methods

Modifier and Type	Method and Description
void	init()
<O extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> HookOperationMode	invoke(ModelContext<O> context, Task task, OperationResult parentResult) Generic method to be implemented by the hook.
void	invokeOnException(ModelContext context, Throwable throwable, Task task, OperationResult result) This method is invoked by the clockwork when an exception occurs.

Methods inherited from class java.lang.Object

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

Field Detail

WORKFLOW_HOOK_URI

public static final String WORKFLOW_HOOK_URI

See Also:

Constant Field Values

Constructor Detail

WfHook

public WfHook()

Method Detail

init

@PostConstruct
public void init()

invoke

public <O extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> HookOperationMode invoke(ModelContext<O> context,
                                                                                                   Task task,
                                                                                                   OperationResult parentResult)

Description copied from interface: ChangeHook

Generic method to be implemented by the hook. It is invoked by the Model Clockwork at these occasions: - after PRIMARY state has been entered, - after SECONDARY state has been entered, and - after each of secondary-state waves has been executed (i.e. with the state of SECONDARY for all except the last one, will have state set to FINAL). TODO: what about EXECUTION and POSTEXECUTION states?

Specified by:

invoke in interface ChangeHook

Returns:

- FOREGROUND, if the processing of model operation should continue on the foreground - BACKGROUND, if the hook switched further processing into background (and, therefore, current execution of model operation should end immediately, in the hope it will eventually be resumed later) - ERROR, if the hook encountered an error which prevents model operation from continuing (this case is currently not defined very well)

invokeOnException

public void invokeOnException(ModelContext context,
                     Throwable throwable,
                     Task task,
                     OperationResult result)

Description copied from interface: ChangeHook

This method is invoked by the clockwork when an exception occurs. It is intended e.g. to implement a notification to the user.

Specified by:

invokeOnException in interface ChangeHook

Parameters:

context - actual model context at the point of processing the exception

throwable - the exception itself

task - actual task, in context of which the operation was carried out

result - actual operation result - the handler should create a subresult here for its operation This method has no return value, as it is not expected that the processing would continue in the background. (This could change in the future.)