org.camunda.community.bpmndt.api

Class ExternalTaskHandler

java.lang.Object

org.camunda.community.bpmndt.api.ExternalTaskHandler

public class ExternalTaskHandler
extends Object

Fluent API to handle external tasks.

Constructor Summary

Constructors

Constructor and Description
ExternalTaskHandler(org.camunda.bpm.engine.ProcessEngine processEngine, String activityId, String topicName)

Method Summary

Modifier and Type	Method and Description
protected void	apply(org.camunda.bpm.engine.runtime.ProcessInstance pi)
void	complete() Completes the external task with an action that fetches/locks the task and calls complete.
protected void	complete(String topicName)
ExternalTaskHandler	customize(Consumer<ExternalTaskHandler> customizer) Customizes the handler, using the given Consumer function.
void	execute(Consumer<String> action) Executes a custom action that handles the external task.
protected void	handleBpmnError(String topicName)
void	handleBpmnError(String errorCode, String errorMessage) Continues the execution with an action that calls handleBpmnError using the given error code and message.
boolean	isWaitingForBoundaryEvent() Determines if the external task is waiting for a boundary message, signal or timer event.
ExternalTaskHandler	verify(BiConsumer<org.camunda.bpm.engine.test.assertions.bpmn.ProcessInstanceAssert,String> verifier) Verifies the external task's waiting state.
void	waitForBoundaryEvent() Applies no action at the external task's wait state.
ExternalTaskHandler	withErrorMessage(String errorMessage) Sets the error message, which is used when the next activity is an error boundary event - in this case the handler's default action is handleBpmnError.
ExternalTaskHandler	withLocalVariable(String name, Object value) Sets a local variable, which is passed to the execution when the default action is used.
ExternalTaskHandler	withLocalVariableTyped(String name, org.camunda.bpm.engine.variable.value.TypedValue value) Sets a typed local variable, which is passed to the execution when the default action is used.
ExternalTaskHandler	withVariable(String name, Object value) Sets a variable, which is passed to the execution when the default action is used.
ExternalTaskHandler	withVariableTyped(String name, org.camunda.bpm.engine.variable.value.TypedValue value) Sets a typed variable, which is passed to the execution when the default action is used.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalTaskHandler

public ExternalTaskHandler(org.camunda.bpm.engine.ProcessEngine processEngine,
                           String activityId,
                           String topicName)

Method Detail

apply

protected void apply(org.camunda.bpm.engine.runtime.ProcessInstance pi)

complete

public void complete()

Completes the external task with an action that fetches/locks the task and calls complete.

See Also:

ExternalTaskService.complete(String, String, java.util.Map, java.util.Map)

complete

protected void complete(String topicName)

customize

public ExternalTaskHandler customize(Consumer<ExternalTaskHandler> customizer)

Customizes the handler, using the given Consumer function. This method can be used to apply a common customization needed for different test cases.

 tc.handleExternalTask().customize(this::prepareExternalTask);
 

Parameters:

customizer - A function that accepts a ExternalTaskHandler.

Returns:

The handler.

execute

public void execute(Consumer<String> action)

Executes a custom action that handles the external task.

Parameters:

action - A specific action that accepts the related topic name (String).

handleBpmnError

public void handleBpmnError(String errorCode,
                            String errorMessage)

Continues the execution with an action that calls handleBpmnError using the given error code and message.

Parameters:

errorCode - The error code of the attached boundary error event.

errorMessage - An error message or null.

See Also:

ExternalTaskService.handleBpmnError(String, String, String, String, java.util.Map)

handleBpmnError

protected void handleBpmnError(String topicName)

isWaitingForBoundaryEvent

public boolean isWaitingForBoundaryEvent()

Determines if the external task is waiting for a boundary message, signal or timer event.

Returns:

true, if it is waiting for a boundary event. false, if not.

verify

public ExternalTaskHandler verify(BiConsumer<org.camunda.bpm.engine.test.assertions.bpmn.ProcessInstanceAssert,String> verifier)

Verifies the external task's waiting state.

Parameters:

verifier - Verifier that accepts an ProcessInstanceAssert instance and the related topic name (String).

Returns:

The handler.

waitForBoundaryEvent

public void waitForBoundaryEvent()

Applies no action at the external task's wait state. This is required to wait for events (e.g. message, signal or timer events) that are attached as boundary events on the activity itself or on the surrounding scope (e.g. embedded subprocess).

withErrorMessage

public ExternalTaskHandler withErrorMessage(String errorMessage)

Sets the error message, which is used when the next activity is an error boundary event - in this case the handler's default action is handleBpmnError.

Parameters:

errorMessage - An error message or null.

Returns:

The handler.

withLocalVariable

public ExternalTaskHandler withLocalVariable(String name,
                                             Object value)

Sets a local variable, which is passed to the execution when the default action is used.

Parameters:

name - The name of the local variable.

value - The local variable's value.

Returns:

The handler.

withLocalVariableTyped

public ExternalTaskHandler withLocalVariableTyped(String name,
                                                  org.camunda.bpm.engine.variable.value.TypedValue value)

Sets a typed local variable, which is passed to the execution when the default action is used.

Parameters:

name - The name of the local variable.

value - The local variable's typed value.

Returns:

The handler.

withVariable

public ExternalTaskHandler withVariable(String name,
                                        Object value)

Sets a variable, which is passed to the execution when the default action is used.

Parameters:

name - The name of the variable.

value - The variable's value.

Returns:

The handler.

withVariableTyped

public ExternalTaskHandler withVariableTyped(String name,
                                             org.camunda.bpm.engine.variable.value.TypedValue value)

Sets a typed variable, which is passed to the execution when the default action is used.

Parameters:

name - The name of the variable.

value - The variable's typed value.

Returns:

The handler.