Package org.synchronoss.cpo.core.jta

Enum Class CpoXaError

java.lang.Object

java.lang.Enum<CpoXaError>

org.synchronoss.cpo.core.jta.CpoXaError

All Implemented Interfaces:

Serializable, Comparable<CpoXaError>, Constable

public enum CpoXaError
extends Enum<CpoXaError>

The XA error codes used by Cpo, mirroring the int constants declared on XAException so error codes can be passed around as a type-safe enum instead of a bare int.

Author:

dberry

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
XA_HEURCOM	Mirrors XAException.XA_HEURCOM: the transaction branch has been heuristically committed.
XA_HEURHAZ	Mirrors XAException.XA_HEURHAZ: the transaction branch may have been heuristically completed.
XA_HEURMIX	Mirrors XAException.XA_HEURMIX: the transaction branch has been heuristically committed and rolled back.
XA_HEURRB	Mirrors XAException.XA_HEURRB: the transaction branch has been heuristically rolled back.
XA_NOMIGRATE	Mirrors XAException.XA_NOMIGRATE: resumption must occur where the suspension occurred.
XA_RBBASE	Mirrors XAException.XA_RBBASE: the inclusive lower bound of the rollback codes.
XA_RBCOMMFAIL	Mirrors XAException.XA_RBCOMMFAIL: the rollback was caused by a communication failure.
XA_RBDEADLOCK	Mirrors XAException.XA_RBDEADLOCK: a deadlock was detected.
XA_RBEND	Mirrors XAException.XA_RBEND: the inclusive upper bound of the rollback codes.
XA_RBINTEGRITY	Mirrors XAException.XA_RBINTEGRITY: a condition that violates the integrity of the resource was detected.
XA_RBOTHER	Mirrors XAException.XA_RBOTHER: the resource manager rolled back for a reason not on this list.
XA_RBPROTO	Mirrors XAException.XA_RBPROTO: a protocol error occurred in the resource manager.
XA_RBROLLBACK	Mirrors XAException.XA_RBROLLBACK: the rollback was caused by an unspecified reason.
XA_RBTIMEOUT	Mirrors XAException.XA_RBTIMEOUT: a transaction branch took too long.
XA_RBTRANSIENT	Mirrors XAException.XA_RBTRANSIENT: may retry the transaction branch.
XA_RDONLY	Mirrors XAException.XA_RDONLY: the transaction branch was read-only and has been committed.
XA_RETRY	Mirrors XAException.XA_RETRY: routine returned with no effect and may be reissued.
XAER_ASYNC	Mirrors XAException.XAER_ASYNC: an asynchronous operation is already outstanding.
XAER_DUPID	Mirrors XAException.XAER_DUPID: the Xid already exists.
XAER_INVAL	Mirrors XAException.XAER_INVAL: invalid arguments were given.
XAER_NOTA	Mirrors XAException.XAER_NOTA: the Xid is not valid.
XAER_OUTSIDE	Mirrors XAException.XAER_OUTSIDE: the resource manager is doing work outside a global transaction.
XAER_PROTO	Mirrors XAException.XAER_PROTO: the routine was invoked in an improper context.
XAER_RMERR	Mirrors XAException.XAER_RMERR: a resource manager error occurred.
XAER_RMFAIL	Mirrors XAException.XAER_RMFAIL: the resource manager has failed and is unavailable.

Method Summary

Modifier and Type	Method	Description
static XAException	createXAException(CpoXaError errCode, String errString)	Builds an XAException carrying a message that embeds this error code's name and numeric value alongside the caller-supplied detail text.
static CpoXaError	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CpoXaError[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

XA_RBBASE

public static final CpoXaError XA_RBBASE

Mirrors XAException.XA_RBBASE: the inclusive lower bound of the rollback codes.

XA_RBROLLBACK

public static final CpoXaError XA_RBROLLBACK

Mirrors XAException.XA_RBROLLBACK: the rollback was caused by an unspecified reason.

XA_RBCOMMFAIL

public static final CpoXaError XA_RBCOMMFAIL

Mirrors XAException.XA_RBCOMMFAIL: the rollback was caused by a communication failure.

XA_RBDEADLOCK

public static final CpoXaError XA_RBDEADLOCK

Mirrors XAException.XA_RBDEADLOCK: a deadlock was detected.

XA_RBINTEGRITY

public static final CpoXaError XA_RBINTEGRITY

Mirrors XAException.XA_RBINTEGRITY: a condition that violates the integrity of the resource was detected.

XA_RBOTHER

public static final CpoXaError XA_RBOTHER

Mirrors XAException.XA_RBOTHER: the resource manager rolled back for a reason not on this list.

XA_RBPROTO

public static final CpoXaError XA_RBPROTO

Mirrors XAException.XA_RBPROTO: a protocol error occurred in the resource manager.

XA_RBTIMEOUT

public static final CpoXaError XA_RBTIMEOUT

Mirrors XAException.XA_RBTIMEOUT: a transaction branch took too long.

XA_RBTRANSIENT

public static final CpoXaError XA_RBTRANSIENT

Mirrors XAException.XA_RBTRANSIENT: may retry the transaction branch.

XA_RBEND

public static final CpoXaError XA_RBEND

Mirrors XAException.XA_RBEND: the inclusive upper bound of the rollback codes.

XA_NOMIGRATE

public static final CpoXaError XA_NOMIGRATE

Mirrors XAException.XA_NOMIGRATE: resumption must occur where the suspension occurred.

XA_HEURHAZ

public static final CpoXaError XA_HEURHAZ

Mirrors XAException.XA_HEURHAZ: the transaction branch may have been heuristically completed.

XA_HEURCOM

public static final CpoXaError XA_HEURCOM

Mirrors XAException.XA_HEURCOM: the transaction branch has been heuristically committed.

XA_HEURRB

public static final CpoXaError XA_HEURRB

Mirrors XAException.XA_HEURRB: the transaction branch has been heuristically rolled back.

XA_HEURMIX

public static final CpoXaError XA_HEURMIX

Mirrors XAException.XA_HEURMIX: the transaction branch has been heuristically committed and rolled back.

XA_RETRY

public static final CpoXaError XA_RETRY

Mirrors XAException.XA_RETRY: routine returned with no effect and may be reissued.

XA_RDONLY

public static final CpoXaError XA_RDONLY

Mirrors XAException.XA_RDONLY: the transaction branch was read-only and has been committed.

XAER_ASYNC

public static final CpoXaError XAER_ASYNC

Mirrors XAException.XAER_ASYNC: an asynchronous operation is already outstanding.

XAER_RMERR

public static final CpoXaError XAER_RMERR

Mirrors XAException.XAER_RMERR: a resource manager error occurred.

XAER_NOTA

public static final CpoXaError XAER_NOTA

Mirrors XAException.XAER_NOTA: the Xid is not valid.

XAER_INVAL

public static final CpoXaError XAER_INVAL

Mirrors XAException.XAER_INVAL: invalid arguments were given.

XAER_PROTO

public static final CpoXaError XAER_PROTO

Mirrors XAException.XAER_PROTO: the routine was invoked in an improper context.

XAER_RMFAIL

public static final CpoXaError XAER_RMFAIL

Mirrors XAException.XAER_RMFAIL: the resource manager has failed and is unavailable.

XAER_DUPID

public static final CpoXaError XAER_DUPID

Mirrors XAException.XAER_DUPID: the Xid already exists.

XAER_OUTSIDE

public static final CpoXaError XAER_OUTSIDE

Mirrors XAException.XAER_OUTSIDE: the resource manager is doing work outside a global transaction.

Method Details

values

public static CpoXaError[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CpoXaError valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

createXAException

public static XAException createXAException(CpoXaError errCode,
 String errString)

Builds an XAException carrying a message that embeds this error code's name and numeric value alongside the caller-supplied detail text.

Parameters:

errCode - The error code for the XAException

errString - The message for the XAException

Returns:

The XAException