Package org.camunda.bpm.engine.impl.interceptor

Class ExceptionCodeInterceptor

java.lang.Object

org.camunda.bpm.engine.impl.interceptor.CommandInterceptor

org.camunda.bpm.engine.impl.interceptor.ExceptionCodeInterceptor

All Implemented Interfaces:

CommandExecutor

public class ExceptionCodeInterceptor
extends CommandInterceptor

A command interceptor to catch ProcessEngineException errors and assign error codes.

The interceptor assigns an error code to the ProcessEngineException based on the built-in or custom ExceptionCodeProvider.

Field Summary

Fields

Modifier and Type	Field	Description
protected ExceptionCodeProvider	builtinExceptionCodeProvider
protected ExceptionCodeProvider	customExceptionCodeProvider
protected static CommandLogger	LOG
static int	MAX_CUSTOM_CODE
static int	MIN_CUSTOM_CODE

Fields inherited from class org.camunda.bpm.engine.impl.interceptor.CommandInterceptor

next

Constructor Summary

Constructors

Constructor	Description
ExceptionCodeInterceptor(ExceptionCodeProvider builtinExceptionCodeProvider, ExceptionCodeProvider customExceptionCodeProvider)

Method Summary

Modifier and Type	Method	Description
protected void	assignCodeToException(ProcessEngineException pex)
protected boolean	codeReserved(java.lang.Integer code)
<T> T	execute(Command<T> command)
protected java.lang.Integer	provideCode(ProcessEngineException pex, int initialCode)
protected java.lang.Integer	provideCodeBySupplier(java.util.function.Supplier<java.lang.Integer> builtinSupplier, java.util.function.Supplier<java.lang.Integer> customSupplier, int initialCode)	Built-in code provider has precedence over custom code provider and initial code (assigned via delegation code).
protected java.lang.Integer	tryResetReservedCode(java.lang.Integer code)	Resets codes to the BuiltinExceptionCode.FALLBACK in case they are < MIN_CUSTOM_CODE or > MAX_CUSTOM_CODE.

Methods inherited from class org.camunda.bpm.engine.impl.interceptor.CommandInterceptor

getNext, setNext

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final CommandLogger LOG

MIN_CUSTOM_CODE

public static final int MIN_CUSTOM_CODE

See Also:

Constant Field Values

MAX_CUSTOM_CODE

public static final int MAX_CUSTOM_CODE

See Also:

Constant Field Values

builtinExceptionCodeProvider

protected ExceptionCodeProvider builtinExceptionCodeProvider

customExceptionCodeProvider

protected ExceptionCodeProvider customExceptionCodeProvider

Constructor Detail

ExceptionCodeInterceptor

public ExceptionCodeInterceptor(ExceptionCodeProvider builtinExceptionCodeProvider,
                                ExceptionCodeProvider customExceptionCodeProvider)

Method Detail

execute

public <T> T execute(Command<T> command)

provideCodeBySupplier

protected java.lang.Integer provideCodeBySupplier(java.util.function.Supplier<java.lang.Integer> builtinSupplier,
                                                  java.util.function.Supplier<java.lang.Integer> customSupplier,
                                                  int initialCode)

Built-in code provider has precedence over custom code provider and initial code (assigned via delegation code). Custom and initial code is tried to be reset in case it violates the reserved code range.

When disableBuiltInExceptionCodeProvider flag in ProcessEngineConfigurationImpl is configured to true, custom provider can override reserved codes.

provideCode

protected java.lang.Integer provideCode(ProcessEngineException pex,
                                        int initialCode)

tryResetReservedCode

protected java.lang.Integer tryResetReservedCode(java.lang.Integer code)

Resets codes to the BuiltinExceptionCode.FALLBACK in case they are < MIN_CUSTOM_CODE or > MAX_CUSTOM_CODE. No log is written when code is BuiltinExceptionCode.FALLBACK.

codeReserved

protected boolean codeReserved(java.lang.Integer code)

assignCodeToException

protected void assignCodeToException(ProcessEngineException pex)