Package org.camunda.bpm.client.task.impl
Class ExternalTaskServiceImpl
java.lang.Object
org.camunda.bpm.client.task.impl.ExternalTaskServiceImpl
- All Implemented Interfaces:
ExternalTaskService
- Author:
- Tassilo Weidner
-
Field Summary
Modifier and TypeFieldDescriptionprotected EngineClient
protected static final ExternalTaskClientLogger
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Completes a task.void
complete
(ExternalTask externalTask) Completes a task.void
complete
(ExternalTask externalTask, Map<String, Object> variables) Completes a task.void
complete
(ExternalTask externalTask, Map<String, Object> variables, Map<String, Object> localVariables) Completes a task.void
extendLock
(String externalTaskId, long newDuration) Extends the timeout of the lock by a given amount of time.void
extendLock
(ExternalTask externalTask, long newDuration) Extends the timeout of the lock by a given amount of time.void
handleBpmnError
(String externalTaskId, String errorCode, String errorMessage, Map<String, Object> variables) Reports a business error in the context of a running task.void
handleBpmnError
(ExternalTask externalTask, String errorCode) Reports a business error in the context of a running task.void
handleBpmnError
(ExternalTask externalTask, String errorCode, String errorMessage) Reports a business error in the context of a running task.void
handleBpmnError
(ExternalTask externalTask, String errorCode, String errorMessage, Map<String, Object> variables) Reports a business error in the context of a running task.void
handleFailure
(String externalTaskId, String errorMessage, String errorDetails, int retries, long retryTimeout) Reports a failure to execute a task.void
handleFailure
(String externalTaskId, String errorMessage, String errorDetails, int retries, long retryTimeout, Map<String, Object> variables, Map<String, Object> locaclVariables) Reports a failure to execute a task.void
handleFailure
(ExternalTask externalTask, String errorMessage, String errorDetails, int retries, long retryTimeout) Reports a failure to execute a task.void
Locks a task by a given amount of time.void
lock
(ExternalTask externalTask, long lockDuration) Locks a task by a given amount of time.void
setVariables
(String processInstanceId, Map<String, Object> variables) Set variablesvoid
setVariables
(ExternalTask externalTask, Map<String, Object> variables) Set variablesvoid
unlock
(ExternalTask externalTask) Unlocks a task and clears the tasks lock expiration time and worker id.
-
Field Details
-
LOG
-
engineClient
-
-
Constructor Details
-
ExternalTaskServiceImpl
-
-
Method Details
-
lock
Description copied from interface:ExternalTaskService
Locks a task by a given amount of time. Note: This method should be used to lock external tasks that have been obtained without using the fetch & lock API.- Specified by:
lock
in interfaceExternalTaskService
- Parameters:
externalTask
- which lock will be extendedlockDuration
- specifies the lock duration in milliseconds
-
lock
Description copied from interface:ExternalTaskService
Locks a task by a given amount of time. Note: This method should be used to lock external tasks that have been obtained without using the fetch & lock API.- Specified by:
lock
in interfaceExternalTaskService
- Parameters:
externalTaskId
- the id of the external task whose lock will be extendedlockDuration
- specifies the lock duration in milliseconds
-
unlock
Description copied from interface:ExternalTaskService
Unlocks a task and clears the tasks lock expiration time and worker id.- Specified by:
unlock
in interfaceExternalTaskService
- Parameters:
externalTask
- which will be unlocked
-
complete
Description copied from interface:ExternalTaskService
Completes a task.- Specified by:
complete
in interfaceExternalTaskService
- Parameters:
externalTask
- which will be completed
-
setVariables
Description copied from interface:ExternalTaskService
Set variables- Specified by:
setVariables
in interfaceExternalTaskService
variables
- are set in the tasks ancestor execution hierarchy. The key and the value represent the variable name and its value. Map can consist of both typed and untyped variables.
-
setVariables
Description copied from interface:ExternalTaskService
Set variables- Specified by:
setVariables
in interfaceExternalTaskService
variables
- are set in the tasks ancestor execution hierarchy. The key and the value represent the variable name and its value. Map can consist of both typed and untyped variables.
-
complete
Description copied from interface:ExternalTaskService
Completes a task.- Specified by:
complete
in interfaceExternalTaskService
- Parameters:
externalTask
- which will be completedvariables
- are set in the tasks ancestor execution hierarchy The key and the value represent the variable name and its value. Map can consist of both typed and untyped variables.
-
complete
public void complete(ExternalTask externalTask, Map<String, Object> variables, Map<String, Object> localVariables) Description copied from interface:ExternalTaskService
Completes a task.- Specified by:
complete
in interfaceExternalTaskService
- Parameters:
externalTask
- which will be completedvariables
- are set in the tasks ancestor execution hierarchy. The key and the value represent the variable name and its value. Map can consist of both typed and untyped variables.localVariables
- are set in the execution of the external task instance. The key and the value represent the variable name and its value. Map can consist of both typed and untyped variables.
-
complete
public void complete(String externalTaskId, Map<String, Object> variables, Map<String, Object> localVariables) Description copied from interface:ExternalTaskService
Completes a task.- Specified by:
complete
in interfaceExternalTaskService
- Parameters:
externalTaskId
- the id of the external task which will be completedvariables
- are set in the tasks ancestor execution hierarchy. The key and the value represent the variable name and its value. Map can consist of both typed and untyped variables.localVariables
- are set in the execution of the external task instance. The key and the value represent the variable name and its value. Map can consist of both typed and untyped variables.
-
handleFailure
public void handleFailure(ExternalTask externalTask, String errorMessage, String errorDetails, int retries, long retryTimeout) Description copied from interface:ExternalTaskService
Reports a failure to execute a task. A number of retries and a timeout until the task can be specified. If the retries are set to 0, an incident for this task is created.- Specified by:
handleFailure
in interfaceExternalTaskService
- Parameters:
externalTask
- external task for which a failure will be reportederrorMessage
- indicates the reason of the failure.errorDetails
- provides a detailed error description.retries
- specifies how often the task should be retried. Must be >= 0. If 0, an incident is created and the task cannot be fetched anymore unless the retries are increased again. The incident's message is set to the errorMessage parameter.retryTimeout
- specifies a timeout in milliseconds before the external task becomes available again for fetching. Must be >= 0.
-
handleFailure
public void handleFailure(String externalTaskId, String errorMessage, String errorDetails, int retries, long retryTimeout) Description copied from interface:ExternalTaskService
Reports a failure to execute a task. A number of retries and a timeout until the task can be specified. If the retries are set to 0, an incident for this task is created.- Specified by:
handleFailure
in interfaceExternalTaskService
- Parameters:
externalTaskId
- the id of the external task for which a failure will be reportederrorMessage
- indicates the reason of the failure.errorDetails
- provides a detailed error description.retries
- specifies how often the task should be retried. Must be >= 0. If 0, an incident is created and the task cannot be fetched anymore unless the retries are increased again. The incident's message is set to the errorMessage parameter.retryTimeout
- specifies a timeout in milliseconds before the external task becomes available again for fetching. Must be >= 0.
-
handleFailure
public void handleFailure(String externalTaskId, String errorMessage, String errorDetails, int retries, long retryTimeout, Map<String, Object> variables, Map<String, Object> locaclVariables) Description copied from interface:ExternalTaskService
Reports a failure to execute a task. A number of retries and a timeout until the task can be specified. If the retries are set to 0, an incident for this task is created.- Specified by:
handleFailure
in interfaceExternalTaskService
- Parameters:
externalTaskId
- the id of the external task for which a failure will be reportederrorMessage
- indicates the reason of the failure.errorDetails
- provides a detailed error description.retries
- specifies how often the task should be retried. Must be >= 0. If 0, an incident is created and the task cannot be fetched anymore unless the retries are increased again. The incident's message is set to the errorMessage parameter.retryTimeout
- specifies a timeout in milliseconds before the external task becomes available again for fetching. Must be >= 0.variables
- a map of variables to set on the execution the external task is assigned tolocaclVariables
- a map of variables to set on the execution locally
-
handleBpmnError
Description copied from interface:ExternalTaskService
Reports a business error in the context of a running task. The error code must be specified to identify the BPMN error handler.- Specified by:
handleBpmnError
in interfaceExternalTaskService
- Parameters:
externalTask
- external task for which a BPMN error will be reportederrorCode
- that indicates the predefined error. The error code is used to identify the BPMN error handler.
-
handleBpmnError
Description copied from interface:ExternalTaskService
Reports a business error in the context of a running task. The error code must be specified to identify the BPMN error handler.- Specified by:
handleBpmnError
in interfaceExternalTaskService
- Parameters:
externalTask
- external task for which a BPMN error will be reportederrorCode
- that indicates the predefined error. The error code is used to identify the BPMN error handler.errorMessage
- which will be passed when the BPMN error is caught
-
handleBpmnError
public void handleBpmnError(ExternalTask externalTask, String errorCode, String errorMessage, Map<String, Object> variables) Description copied from interface:ExternalTaskService
Reports a business error in the context of a running task. The error code must be specified to identify the BPMN error handler.- Specified by:
handleBpmnError
in interfaceExternalTaskService
- Parameters:
externalTask
- external task for which a BPMN error will be reportederrorCode
- that indicates the predefined error. The error code is used to identify the BPMN error handler.errorMessage
- which will be passed when the BPMN error is caughtvariables
- which will be passed to the execution when the BPMN error is caught
-
handleBpmnError
public void handleBpmnError(String externalTaskId, String errorCode, String errorMessage, Map<String, Object> variables) Description copied from interface:ExternalTaskService
Reports a business error in the context of a running task. The error code must be specified to identify the BPMN error handler.- Specified by:
handleBpmnError
in interfaceExternalTaskService
- Parameters:
externalTaskId
- the id of the external task for which a BPMN error will be reportederrorCode
- that indicates the predefined error. The error code is used to identify the BPMN error handler.errorMessage
- which will be passed when the BPMN error is caughtvariables
- which will be passed to the execution when the BPMN error is caught
-
extendLock
Description copied from interface:ExternalTaskService
Extends the timeout of the lock by a given amount of time.- Specified by:
extendLock
in interfaceExternalTaskService
- Parameters:
externalTask
- which lock will be extendednewDuration
- specifies the new lock duration in milliseconds
-
extendLock
Description copied from interface:ExternalTaskService
Extends the timeout of the lock by a given amount of time.- Specified by:
extendLock
in interfaceExternalTaskService
- Parameters:
externalTaskId
- the id of the external task which lock will be extendednewDuration
- specifies the new lock duration in milliseconds
-