Package com.broadleafcommerce.workflow.service

Class ExecutionProperties

java.lang.Object
com.broadleafcommerce.workflow.service.ExecutionProperties
@ConfigurationProperties(prefix="broadleaf.workflow.service") public class ExecutionProperties extends Object
Properties related to the configuration of the service environment for runtime execution of workflows.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExecutionProperties()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    String
    getBinderType()
    The type of binder used for messaging.
    long
    getMaxPollInterval()
    Maximum interval between polling attempts for workflows.
    int
    getMaxSideEffectCount()
    Side effects store state for the workflow.
    long
    getMinPollInterval()
    Minimum interval between polling attempts for workflows.
    long
    getNackDelay()
    Amount of time to wait before polling again when a message is nacked because there are currently no processing threads available.
    long
    getNonActiveWorkflowTimeout()
    Timeout for a workflow that appears to be non-active.
    long
    getProcessorAcquireTimeout()
    Maximum amount of time (in milliseconds) that the system will wait to acquire a processor before giving up and rejecting the initiating message.
    int
    getProcessorCount()
    The number of concurrent threads processing workflows on a given replica of WorkflowServices.
    long
    getRetentionPeriod()
    The retention period (in milliseconds) for completed or failed workflows.
    int
    hashCode()
     
    void
    setBinderType(String binderType)
    The type of binder used for messaging.
    void
    setMaxPollInterval(long maxPollInterval)
    Maximum interval between polling attempts for workflows.
    void
    setMaxSideEffectCount(int maxSideEffectCount)
    Side effects store state for the workflow.
    void
    setMinPollInterval(long minPollInterval)
    Minimum interval between polling attempts for workflows.
    void
    setNackDelay(long nackDelay)
    Amount of time to wait before polling again when a message is nacked because there are currently no processing threads available.
    void
    setNonActiveWorkflowTimeout(long nonActiveWorkflowTimeout)
    Timeout for a workflow that appears to be non-active.
    void
    setProcessorAcquireTimeout(long processorAcquireTimeout)
    Maximum amount of time (in milliseconds) that the system will wait to acquire a processor before giving up and rejecting the initiating message.
    void
    setProcessorCount(int processorCount)
    The number of concurrent threads processing workflows on a given replica of WorkflowServices.
    void
    setRetentionPeriod(long retentionPeriod)
    The retention period (in milliseconds) for completed or failed workflows.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ExecutionProperties

      public ExecutionProperties()

  • Method Details

    • getProcessorCount

      public int getProcessorCount()
      The number of concurrent threads processing workflows on a given replica of WorkflowServices. The default is 5.

    • getProcessorAcquireTimeout

      public long getProcessorAcquireTimeout()
      Maximum amount of time (in milliseconds) that the system will wait to acquire a processor before giving up and rejecting the initiating message. The default is 10000 ms (10 seconds).

    • getMaxSideEffectCount

      public int getMaxSideEffectCount()
      Side effects store state for the workflow. Side effects store a range of values that include history elements and initial configuration. When a workflow exceeds this count, it results in workflow failure. The default is 10000.

    • getNackDelay

      public long getNackDelay()
      Amount of time to wait before polling again when a message is nacked because there are currently no processing threads available. See getProcessorCount(). The default is 5000 ms (5 seconds).

    • getMaxPollInterval

      public long getMaxPollInterval()
      Maximum interval between polling attempts for workflows. The default is 180000 ms (180 seconds).

    • getMinPollInterval

      public long getMinPollInterval()
      Minimum interval between polling attempts for workflows. The default is 120000 ms (120 seconds).

    • getNonActiveWorkflowTimeout

      public long getNonActiveWorkflowTimeout()
      Timeout for a workflow that appears to be non-active. A non-active workflow is one that is in PROCESSING status, but has not registered a lastStepTimeout (i.e. is null). The default is 180000 ms (180 seconds).

    • getRetentionPeriod

      public long getRetentionPeriod()
      The retention period (in milliseconds) for completed or failed workflows. The default is 90 days.

    • getBinderType

      public String getBinderType()
      The type of binder used for messaging. Default is `kafka`.

    • setProcessorCount

      public void setProcessorCount(int processorCount)
      The number of concurrent threads processing workflows on a given replica of WorkflowServices. The default is 5.

    • setProcessorAcquireTimeout

      public void setProcessorAcquireTimeout(long processorAcquireTimeout)
      Maximum amount of time (in milliseconds) that the system will wait to acquire a processor before giving up and rejecting the initiating message. The default is 10000 ms (10 seconds).

    • setMaxSideEffectCount

      public void setMaxSideEffectCount(int maxSideEffectCount)
      Side effects store state for the workflow. Side effects store a range of values that include history elements and initial configuration. When a workflow exceeds this count, it results in workflow failure. The default is 10000.

    • setNackDelay

      public void setNackDelay(long nackDelay)
      Amount of time to wait before polling again when a message is nacked because there are currently no processing threads available. See getProcessorCount(). The default is 5000 ms (5 seconds).

    • setMaxPollInterval

      public void setMaxPollInterval(long maxPollInterval)
      Maximum interval between polling attempts for workflows. The default is 180000 ms (180 seconds).

    • setMinPollInterval

      public void setMinPollInterval(long minPollInterval)
      Minimum interval between polling attempts for workflows. The default is 120000 ms (120 seconds).

    • setNonActiveWorkflowTimeout

      public void setNonActiveWorkflowTimeout(long nonActiveWorkflowTimeout)
      Timeout for a workflow that appears to be non-active. A non-active workflow is one that is in PROCESSING status, but has not registered a lastStepTimeout (i.e. is null). The default is 180000 ms (180 seconds).

    • setRetentionPeriod

      public void setRetentionPeriod(long retentionPeriod)
      The retention period (in milliseconds) for completed or failed workflows. The default is 90 days.

    • setBinderType

      public void setBinderType(String binderType)
      The type of binder used for messaging. Default is `kafka`.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object