Package org.flowable.cmmn.api.delegate

Interface FlowablePlanItemFutureJavaDelegate<Input,Output>

Type Parameters:

Input - the input of the execution

Output - the output of the execution

All Superinterfaces:

PlanItemFutureJavaDelegate<Output>

All Known Subinterfaces:

MapBasedFlowablePlanItemFutureJavaDelegate

public interface FlowablePlanItemFutureJavaDelegate<Input,Output>
extends PlanItemFutureJavaDelegate<Output>

Convenience class which always uses the AsyncTaskInvoker to execute the async data. Provides intermediate methods to prepare the execution data before executing and do the actual execution without the need to work with futures.

Author:

Filip Hrisafov

See Also:

MapBasedFlowablePlanItemFutureJavaDelegate, PlanItemFutureJavaDelegate

Method Summary

Modifier and Type	Method	Description
void	afterExecution(DelegatePlanItemInstance planItemInstance, Output executionData)	Method invoked with the result from execute(Object).
Output	execute(Input inputData)	Perform the actual execution of the delegate in another thread.
default CompletableFuture<Output>	execute(DelegatePlanItemInstance planItemInstance, org.flowable.common.engine.api.async.AsyncTaskInvoker taskInvoker)	Perform the execution of the delegate, potentially on another thread.
Input	prepareExecutionData(DelegatePlanItemInstance planItemInstance)	Method invoked before doing the execution to extract needed that from the planItemInstance on the main thread.

Method Detail

execute

default CompletableFuture<Output> execute(DelegatePlanItemInstance planItemInstance,
                                          org.flowable.common.engine.api.async.AsyncTaskInvoker taskInvoker)

Description copied from interface: PlanItemFutureJavaDelegate

Perform the execution of the delegate, potentially on another thread. The result of the future is passed in the PlanItemFutureJavaDelegate.afterExecution(DelegatePlanItemInstance, Object) in order to store the data on the planItemInstance on the same thread as the caller of this method. IMPORTANT: the planItemInstance should only be used to read data before creating the future. The planItemInstance should not be used in the task that will be executed on a new thread.

The AsyncTaskInvoker is in order to schedule an execution on a different thread. However, it is also possible to use a different scheduler, or return a future not created by the given taskInvoker.

Specified by:

execute in interface PlanItemFutureJavaDelegate<Input>

Parameters:

planItemInstance - the planItemInstance that can be used to extract data

taskInvoker - the task invoker that can be used to execute expensive operation on another thread

Returns:

the output data of the execution

prepareExecutionData

Input prepareExecutionData(DelegatePlanItemInstance planItemInstance)

Method invoked before doing the execution to extract needed that from the planItemInstance on the main thread. This should be used to prepare and extract data from the planItemInstance before doing the execution in a different thread.

Parameters:

planItemInstance - the planItemInstance from which to extract data

Returns:

the data for the delegate

execute

Output execute(Input inputData)

Perform the actual execution of the delegate in another thread. This uses prepareExecutionData(DelegatePlanItemInstance) to get the needed data from the DelegatePlanItemInstance and returns the output data that can is passed to afterExecution(DelegatePlanItemInstance, Object). IMPORTANT: This is a completely new thread which does not participate in the transaction of the case.

Parameters:

inputData - the input data for the execution created via prepareExecutionData(DelegatePlanItemInstance)

Returns:

the output data of the execution

See Also:

execute(DelegatePlanItemInstance, AsyncTaskInvoker)

afterExecution

void afterExecution(DelegatePlanItemInstance planItemInstance,
                    Output executionData)

Method invoked with the result from execute(Object). This should be used to set data on the DelegatePlanItemInstance. This is on the same thread as prepareExecutionData(DelegatePlanItemInstance) and participates in the case transaction.

Specified by:

afterExecution in interface PlanItemFutureJavaDelegate<Input>

Parameters:

planItemInstance - the planItemInstance to which data can be set

executionData - the execution data