org.camunda.bpm.engine.impl.util

Class ExceptionUtil

java.lang.Object

org.camunda.bpm.engine.impl.util.ExceptionUtil

public class ExceptionUtil
extends Object

Author:

Roman Smirnov, Askar Akhmerov

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERSISTENCE_EXCEPTION_MESSAGE

Constructor Summary

Constructors

Constructor and Description
ExceptionUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	checkConstraintViolationException(ProcessEngineException exception)
static boolean	checkForeignKeyConstraintViolation(Throwable cause)
static boolean	checkValueTooLongException(ProcessEngineException exception)
static boolean	checkVariableIntegrityViolation(Throwable cause)
static String	collectExceptionMessages(Throwable cause)
static ByteArrayEntity	createExceptionByteArray(String name, byte[] byteArray, ResourceType type) create ByteArrayEntity with specified name and payload and make sure it's persisted used in Jobs and ExternalTasks
static ByteArrayEntity	createJobExceptionByteArray(byte[] byteArray, ResourceType type)
static <T> T	doWithExceptionWrapper(java.util.function.Supplier<T> supplier) Pass logic, which directly calls MyBatis API.
static org.apache.ibatis.executor.BatchExecutorException	findBatchExecutorException(Throwable exception)
static List<SQLException>	findRelatedSqlExceptions(Throwable exception)
static String	getExceptionStacktrace(ByteArrayEntity byteArray)
static String	getExceptionStacktrace(Throwable exception)
static ProcessEngineException	wrapPersistenceException(Exception ex)

Methods inherited from class java.lang.Object

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

Field Detail

PERSISTENCE_EXCEPTION_MESSAGE

public static final String PERSISTENCE_EXCEPTION_MESSAGE

See Also:

Constant Field Values

Constructor Detail

ExceptionUtil

public ExceptionUtil()

Method Detail

getExceptionStacktrace

public static String getExceptionStacktrace(Throwable exception)

getExceptionStacktrace

public static String getExceptionStacktrace(ByteArrayEntity byteArray)

createJobExceptionByteArray

public static ByteArrayEntity createJobExceptionByteArray(byte[] byteArray,
                                                          ResourceType type)

createExceptionByteArray

public static ByteArrayEntity createExceptionByteArray(String name,
                                                       byte[] byteArray,
                                                       ResourceType type)

create ByteArrayEntity with specified name and payload and make sure it's persisted used in Jobs and ExternalTasks

Parameters:

name - - type\source of the exception

byteArray - - payload of the exception

type - - resource type of the exception

Returns:

persisted entity

checkValueTooLongException

public static boolean checkValueTooLongException(ProcessEngineException exception)

checkConstraintViolationException

public static boolean checkConstraintViolationException(ProcessEngineException exception)

findRelatedSqlExceptions

public static List<SQLException> findRelatedSqlExceptions(Throwable exception)

checkForeignKeyConstraintViolation

public static boolean checkForeignKeyConstraintViolation(Throwable cause)

checkVariableIntegrityViolation

public static boolean checkVariableIntegrityViolation(Throwable cause)

findBatchExecutorException

public static org.apache.ibatis.executor.BatchExecutorException findBatchExecutorException(Throwable exception)

collectExceptionMessages

public static String collectExceptionMessages(Throwable cause)

doWithExceptionWrapper

public static <T> T doWithExceptionWrapper(java.util.function.Supplier<T> supplier)

Pass logic, which directly calls MyBatis API. In case a MyBatis exception is thrown, it is wrapped into a ProcessEngineException and never propagated directly to an Engine API call. In some cases, the top-level exception and its message are shown as a response body in the REST API. Wrapping all MyBatis API calls in our codebase makes sure that the top-level exception is always a ProcessEngineException with a generic message. Like this, SQL details are never disclosed to potential attackers.

Type Parameters:

T - is the type of the return value

Parameters:

supplier - which calls MyBatis API

Returns:

the value returned by the supplier

Throws:

ProcessEngineException - which wraps the actual exception

wrapPersistenceException

public static ProcessEngineException wrapPersistenceException(Exception ex)