Module io.helidon.integrations.jta.jdbc

Package io.helidon.integrations.jta.jdbc

Interface ExceptionConverter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ExceptionConverter

A functional interface whose implementations can convert a kind of Exception encountered in the context of an XA routine to an appropriate XAException, according to the rules in the XA specification as expressed in the documentation for the XAResource interface.

See Also:

• convert(XARoutine, Exception)
• ExceptionConverter.XARoutine
• XAException.errorCode
• XAResource
• The XA Specification

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ExceptionConverter.XARoutine	An enum describing XA routines modeled by an XAResource implementation.

Method Summary

Modifier and Type	Method	Description
static String	codeToString(int code)	Returns a non-null String representation of the supplied code.
XAException	convert(ExceptionConverter.XARoutine xaRoutine, Exception exception)	Converts the supplied Exception encountered in the context of the supplied ExceptionConverter.XARoutine to an XAException with an appropriate error code, idiomatically following the rules of the XA specification.

Method Details

convert

XAException convert(ExceptionConverter.XARoutine xaRoutine,
 Exception exception)

Converts the supplied Exception encountered in the context of the supplied ExceptionConverter.XARoutine to an XAException with an appropriate error code, idiomatically following the rules of the XA specification.

Parameters:

xaRoutine - the ExceptionConverter.XARoutine; must not be null

exception - the Exception to convert; most commonly a variety of SQLException or RuntimeException; if supplied with an XAException this ExceptionConverter must simply return it; if supplied with null a new XAException with a general-purpose error codemust be returned

Returns:

a suitable non-null XAException

Throws:

NullPointerException - if routine is null

See Also:

• XAException
• XAResource

codeToString

static String codeToString(int code)

Returns a non-null String representation of the supplied code.

The format of the returned String is left deliberately undefined and may change between versions of this interface without prior notice.

Parameters:

code - a code; usually the value of a static field in the XAException class

Returns:

a non-null String representation of the supplied code