Package org.flowable.external.client.impl

Class RestExternalWorkerFailureBuilder

java.lang.Object

org.flowable.external.client.impl.RestExternalWorkerFailureBuilder

All Implemented Interfaces:

ExternalWorkerJobFailureBuilder

public class RestExternalWorkerFailureBuilder
extends Object
implements ExternalWorkerJobFailureBuilder

Author:

Filip Hrisafov

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ExternalWorkerJobFailureBuilder	details(String details)	The failure details that should be passed to the Flowable application.
ExternalWorkerJobFailureBuilder	error(Exception exception)	Provide fail information based on the exception.
void	fail()	Execute the failure of the job.
ExternalWorkerJobFailureBuilder	message(String message)	The failure message that should be passed to the Flowable application.
ExternalWorkerJobFailureBuilder	retries(int retries)	How many times should the job be retried.
ExternalWorkerJobFailureBuilder	retryTimeout(Duration retryTimeout)	How long should the Flowable application wait before making this job available for execution.
protected void	sendRequest()

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

request

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

Constructor Details

RestExternalWorkerFailureBuilder

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

Method Details

error

public ExternalWorkerJobFailureBuilder error(Exception exception)

Description copied from interface: ExternalWorkerJobFailureBuilder

Provide fail information based on the exception. The Throwable.getMessage() will be used as the failure message and the exception stacktrace will be used as the details.

Specified by:

error in interface ExternalWorkerJobFailureBuilder

Parameters:

exception - the exception that should be used to provide the message and details

See Also:

• ExternalWorkerJobFailureBuilder.message(String)
• ExternalWorkerJobFailureBuilder.details(String)

message

public ExternalWorkerJobFailureBuilder message(String message)

Description copied from interface: ExternalWorkerJobFailureBuilder

The failure message that should be passed to the Flowable application.

Specified by:

message in interface ExternalWorkerJobFailureBuilder

Parameters:

message - the failure message

details

public ExternalWorkerJobFailureBuilder details(String details)

Description copied from interface: ExternalWorkerJobFailureBuilder

The failure details that should be passed to the Flowable application.

Specified by:

details in interface ExternalWorkerJobFailureBuilder

Parameters:

details - the failure details

retries

public ExternalWorkerJobFailureBuilder retries(int retries)

Description copied from interface: ExternalWorkerJobFailureBuilder

How many times should the job be retried. This can be used to increase / decrease the existing retries of a job. When nothing is set then the Flowable application is going to decrease the retries by 1.

Specified by:

retries in interface ExternalWorkerJobFailureBuilder

Parameters:

retries - the new retry count for the job

retryTimeout

public ExternalWorkerJobFailureBuilder retryTimeout(Duration retryTimeout)

Description copied from interface: ExternalWorkerJobFailureBuilder

How long should the Flowable application wait before making this job available for execution. This can be used to set a specific period after which the execution of a job would be successful.

Specified by:

retryTimeout in interface ExternalWorkerJobFailureBuilder

Parameters:

retryTimeout - the period that the Flowable application should wait before making this job available

fail

public void fail()

Description copied from interface: ExternalWorkerJobFailureBuilder

Execute the failure of the job.

Specified by:

fail in interface ExternalWorkerJobFailureBuilder

sendRequest

protected void sendRequest()