Class FlowableGuardrailViolationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.flowable.common.engine.api.FlowableException

org.flowable.common.engine.api.delegate.BusinessError

com.flowable.agent.engine.impl.guardrail.FlowableGuardrailViolationException

All Implemented Interfaces:

Serializable

public class FlowableGuardrailViolationException
extends org.flowable.common.engine.api.delegate.BusinessError

A business error thrown when a guardrail violation occurs with onFailure = "error".

Extends BusinessError so it can be caught by:

• BPMN error boundary events (matching on BusinessError.getErrorCode())
• CMMN fault sentries (via fault propagation)

The violation details are available as additional data on the error, accessible as variables in the error handler scope.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	GUARDRAIL_EXCHANGES_KEY	Additional-data key under which the recorded guardrail exchanges are surfaced on the error (accessed via getGuardrailExchanges() / setGuardrailExchanges(java.util.List)), so they can be rebuilt even though the business error bypasses the normal audit path.
protected final List<GuardrailViolation>	violations

Fields inherited from class org.flowable.common.engine.api.delegate.BusinessError

additionalDataContainer, errorCode

Fields inherited from class org.flowable.common.engine.api.FlowableException

isLogged, reduceLogLevel

Constructor Summary

Constructors

Constructor	Description
FlowableGuardrailViolationException(String errorCode, String message, List<GuardrailViolation> violations)

Method Summary

Modifier and Type	Method	Description
void	addAdditionalData(String name, Object value)
List<AgentInvocationResultResponse.Exchange>	getGuardrailExchanges()
List<GuardrailViolation>	getViolations()
void	setGuardrailExchanges(List<AgentInvocationResultResponse.Exchange> guardrailExchanges)

Methods inherited from class org.flowable.common.engine.api.delegate.BusinessError

getAdditionalDataContainer, getErrorCode, setAdditionalDataContainer, setErrorCode

Methods inherited from class org.flowable.common.engine.api.FlowableException

isLogged, isReduceLogLevel, setLogged, setReduceLogLevel

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

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

Field Details

GUARDRAIL_EXCHANGES_KEY

protected static final String GUARDRAIL_EXCHANGES_KEY

Additional-data key under which the recorded guardrail exchanges are surfaced on the error (accessed via getGuardrailExchanges() / setGuardrailExchanges(java.util.List)), so they can be rebuilt even though the business error bypasses the normal audit path.

See Also:

• Constant Field Values

violations

protected final List<GuardrailViolation> violations

Constructor Details

FlowableGuardrailViolationException

public FlowableGuardrailViolationException(String errorCode,
 String message,
 List<GuardrailViolation> violations)

Method Details

getViolations

public List<GuardrailViolation> getViolations()

setGuardrailExchanges

public void setGuardrailExchanges(List<AgentInvocationResultResponse.Exchange> guardrailExchanges)

getGuardrailExchanges

public List<AgentInvocationResultResponse.Exchange> getGuardrailExchanges()

addAdditionalData

public void addAdditionalData(String name,
 Object value)

Specified by:

addAdditionalData in class org.flowable.common.engine.api.delegate.BusinessError