io.nflow.engine.workflow.definition

Class WorkflowSettings.Builder

java.lang.Object

io.nflow.engine.workflow.definition.WorkflowSettings.Builder

Enclosing class:

WorkflowSettings

public static class WorkflowSettings.Builder
extends Object

Builder for workflow settings.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
WorkflowSettings	build() Create workflow settings object.
static BooleanSupplier	onAverageEveryNthExecution(int n) Returns true randomly every n:th time.
static BooleanSupplier	oncePerDay() Returns true randomly once per day (during the early hours).
WorkflowSettings.Builder	setDefaultPriority(short defaultPriority) Set the default priority for new workflow instances.
WorkflowSettings.Builder	setDeleteHistoryCondition(BooleanSupplier deleteHistoryCondition) Set the condition to be checked to decide if workflow instance history should be deleted.
WorkflowSettings.Builder	setHistoryDeletableAfter(org.joda.time.ReadablePeriod period) Set the delay after which workflow history (actions, states) can be deleted from the database by nFlow.
WorkflowSettings.Builder	setImmediateTransitionDelay(int immediateTransitionDelay) Set immediate transition delay.
WorkflowSettings.Builder	setMaxErrorTransitionDelay(int maxErrorTransitionDelay) Set the maximum delay on execution retry after an error.
WorkflowSettings.Builder	setMaxRetries(int maxRetries) Set maximum retry attempts.
WorkflowSettings.Builder	setMaxSubsequentStateExecutions(int maxSubsequentStateExecutions) Set maximum number of subsequent state executions before forcing a short transition delay.
WorkflowSettings.Builder	setMaxSubsequentStateExecutions(WorkflowState state, int maxSubsequentStateExecutions) Set maximum number of subsequent state executions before forcing a short transition delay for given state.
WorkflowSettings.Builder	setMinErrorTransitionDelay(int minErrorTransitionDelay) Set the minimum delay on execution retry after an error.
WorkflowSettings.Builder	setShortTransitionDelay(int shortTransitionDelay) Set the length of forced delay to break execution of a step that is considered to be busy looping.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

onAverageEveryNthExecution

public static BooleanSupplier onAverageEveryNthExecution(int n)

Returns true randomly every n:th time.

Parameters:

n - The frequency of returning true.

Returns:

Producer of boolean values

oncePerDay

public static BooleanSupplier oncePerDay()

Returns true randomly once per day (during the early hours).

Returns:

Producer of boolean values

setMaxErrorTransitionDelay

public WorkflowSettings.Builder setMaxErrorTransitionDelay(int maxErrorTransitionDelay)

Set the maximum delay on execution retry after an error.

Parameters:

maxErrorTransitionDelay - Delay in milliseconds.

Returns:

this.

setMinErrorTransitionDelay

public WorkflowSettings.Builder setMinErrorTransitionDelay(int minErrorTransitionDelay)

Set the minimum delay on execution retry after an error.

Parameters:

minErrorTransitionDelay - Delay in milliseconds.

Returns:

this.

setShortTransitionDelay

public WorkflowSettings.Builder setShortTransitionDelay(int shortTransitionDelay)

Set the length of forced delay to break execution of a step that is considered to be busy looping.

Parameters:

shortTransitionDelay - Delay in milliseconds.

Returns:

this.

setImmediateTransitionDelay

public WorkflowSettings.Builder setImmediateTransitionDelay(int immediateTransitionDelay)

Set immediate transition delay.

Parameters:

immediateTransitionDelay - Delay in milliseconds.

Returns:

this.

setMaxRetries

public WorkflowSettings.Builder setMaxRetries(int maxRetries)

Set maximum retry attempts.

Parameters:

maxRetries - Maximum number of retries.

Returns:

this.

setMaxSubsequentStateExecutions

public WorkflowSettings.Builder setMaxSubsequentStateExecutions(int maxSubsequentStateExecutions)

Set maximum number of subsequent state executions before forcing a short transition delay.

Parameters:

maxSubsequentStateExecutions - Maximum number of subsequent state executions.

Returns:

this.

setMaxSubsequentStateExecutions

public WorkflowSettings.Builder setMaxSubsequentStateExecutions(WorkflowState state,
                                                                int maxSubsequentStateExecutions)

Set maximum number of subsequent state executions before forcing a short transition delay for given state.

Parameters:

state - The state for which the limit is applied.

maxSubsequentStateExecutions - Maximum number of subsequent state executions.

Returns:

this.

setHistoryDeletableAfter

public WorkflowSettings.Builder setHistoryDeletableAfter(org.joda.time.ReadablePeriod period)

Set the delay after which workflow history (actions, states) can be deleted from the database by nFlow. The default value (null) indicates that history is not deletable.

Parameters:

period - Delay after which history can be deleted.

Returns:

this.

setDeleteHistoryCondition

public WorkflowSettings.Builder setDeleteHistoryCondition(BooleanSupplier deleteHistoryCondition)

Set the condition to be checked to decide if workflow instance history should be deleted.

Parameters:

deleteHistoryCondition - Function to be called.

Returns:

this.

setDefaultPriority

public WorkflowSettings.Builder setDefaultPriority(short defaultPriority)

Set the default priority for new workflow instances.

Parameters:

defaultPriority - Default priority.

Returns:

this.

build

public WorkflowSettings build()

Create workflow settings object.

Returns:

Workflow settings.