Package org.flowable.external.client.impl

Class RestExternalWorkerCompletionBuilder

java.lang.Object

org.flowable.external.client.impl.RestExternalWorkerCompletionBuilder

All Implemented Interfaces:

ExternalWorkerJobCompletionBuilder

public class RestExternalWorkerCompletionBuilder
extends Object
implements ExternalWorkerJobCompletionBuilder

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected final com.fasterxml.jackson.databind.node.ObjectNode	request
protected final RestInvoker	restInvoker
protected final AcquiredExternalWorkerJob	workerJob

Constructor Summary

Constructors

Constructor	Description
RestExternalWorkerCompletionBuilder(AcquiredExternalWorkerJob workerJob, RestInvoker restInvoker, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
protected <V> ExternalWorkerJobCompletionBuilder	addVariableToRequest(String name, String type, V value, Function<V,com.fasterxml.jackson.databind.JsonNode> valueMapper)
void	bpmnError()	Execute the completion of the job using a BPMN error without an error code.
void	bpmnError(String errorCode)	Execute the completion of the job using a BPMN error using the given error code.
void	cmmnTerminate()	Execute the completion of the job using a CMMN termination.
void	complete()	Execute the completion of the job.
ExternalWorkerJobCompletionBuilder	convertAndAddJsonVariable(String name, Object value)	Provide a variable value of any type that would be converted to a json variable and passed to the Flowable application when completing the job.
protected com.fasterxml.jackson.databind.JsonNode	convertToJson(Object value)
protected void	sendRequest(String action)
ExternalWorkerJobCompletionBuilder	variable(String name, com.fasterxml.jackson.databind.JsonNode value)	Provide a JsonNode that would be passed as a json variable to the Flowable application when completing the job.
ExternalWorkerJobCompletionBuilder	variable(String name, Boolean value)	Provide a Boolean variable that would be passed to the Flowable application when completing the job.
ExternalWorkerJobCompletionBuilder	variable(String name, Double value)	Provide a Double variable that would be passed to the Flowable application when completing the job.
ExternalWorkerJobCompletionBuilder	variable(String name, Integer value)	Provide an Integer variable that would be passed to the Flowable application when completing the job.
ExternalWorkerJobCompletionBuilder	variable(String name, Long value)	Provide a Long variable that would be passed to the Flowable application when completing the job.
ExternalWorkerJobCompletionBuilder	variable(String name, Short value)	Provide a Short variable that would be passed to the Flowable application when completing the job.
ExternalWorkerJobCompletionBuilder	variable(String name, String value)	Provide a String variable that would be passed to the Flowable application when completing the job.
ExternalWorkerJobCompletionBuilder	variable(String name, Instant value)	Provide an Instant variable that would be passed to the Flowable application when completing the job.
ExternalWorkerJobCompletionBuilder	variable(String name, LocalDate value)	Provide a LocalDate variable that would be passed to the Flowable application when completing the job.
ExternalWorkerJobCompletionBuilder	variable(String name, LocalDateTime value)	Provide a LocalDateTime variable that would be passed to the Flowable application when completing the job.
ExternalWorkerJobCompletionBuilder	variable(String name, Date value)	Provide a Date variable that would be passed to the Flowable application when completing the job.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.slf4j.Logger logger

workerJob

protected final AcquiredExternalWorkerJob workerJob

restInvoker

protected final RestInvoker restInvoker

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

request

protected final com.fasterxml.jackson.databind.node.ObjectNode request

Constructor Details

RestExternalWorkerCompletionBuilder

public RestExternalWorkerCompletionBuilder(AcquiredExternalWorkerJob workerJob,
 RestInvoker restInvoker,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Details

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 String value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide a String variable that would be passed to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 Short value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide a Short variable that would be passed to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 Integer value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide an Integer variable that would be passed to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 Long value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide a Long variable that would be passed to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 Double value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide a Double variable that would be passed to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 Boolean value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide a Boolean variable that would be passed to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 Date value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide a Date variable that would be passed to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 Instant value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide an Instant variable that would be passed to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 LocalDate value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide a LocalDate variable that would be passed to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 LocalDateTime value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide a LocalDateTime variable that would be passed to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

variable

public ExternalWorkerJobCompletionBuilder variable(String name,
 com.fasterxml.jackson.databind.JsonNode value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide a JsonNode that would be passed as a json variable to the Flowable application when completing the job.

Specified by:

variable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

convertAndAddJsonVariable

public ExternalWorkerJobCompletionBuilder convertAndAddJsonVariable(String name,
 Object value)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Provide a variable value of any type that would be converted to a json variable and passed to the Flowable application when completing the job.

Specified by:

convertAndAddJsonVariable in interface ExternalWorkerJobCompletionBuilder

Parameters:

name - the name of the variable

value - the value of the variable

addVariableToRequest

protected <V> ExternalWorkerJobCompletionBuilder addVariableToRequest(String name,
 String type,
 V value,
 Function<V,com.fasterxml.jackson.databind.JsonNode> valueMapper)

convertToJson

protected com.fasterxml.jackson.databind.JsonNode convertToJson(Object value)

complete

public void complete()

Description copied from interface: ExternalWorkerJobCompletionBuilder

Execute the completion of the job.

Specified by:

complete in interface ExternalWorkerJobCompletionBuilder

bpmnError

public void bpmnError()

Description copied from interface: ExternalWorkerJobCompletionBuilder

Execute the completion of the job using a BPMN error without an error code.

Specified by:

bpmnError in interface ExternalWorkerJobCompletionBuilder

See Also:

• ExternalWorkerJobCompletionBuilder.bpmnError(String)

bpmnError

public void bpmnError(String errorCode)

Description copied from interface: ExternalWorkerJobCompletionBuilder

Execute the completion of the job using a BPMN error using the given error code.

Specified by:

bpmnError in interface ExternalWorkerJobCompletionBuilder

See Also:

• ExternalWorkerJobCompletionBuilder.bpmnError()

cmmnTerminate

public void cmmnTerminate()

Description copied from interface: ExternalWorkerJobCompletionBuilder

Execute the completion of the job using a CMMN termination.

Specified by:

cmmnTerminate in interface ExternalWorkerJobCompletionBuilder

sendRequest

protected void sendRequest(String action)