javax.transaction.xa
接口 XAResource

public interface XAResource

XAResource 接口是基于 X/Open CAE 规范（分布式事务处理：XA 规范）的工业标准 XA 接口的 Java 映射。

在分布式事务处理 (DTP) 环境中，XA 接口定义资源管理器和事务管理器之间的协定。JDBC 驱动程序或 JMS 提供者实现此接口，以支持全局事务与数据库或消息服务连接之间的关联。

可由应用程序在外部事务管理器控制事务的环境中使用的任何事务资源均可支持 XAResource 接口。数据库管理系统就属于此类资源。应用程序可以通过多个数据库连接访问数据。通过事务管理器将每个数据库连接作为事务资源添加到列表中。事务管理器为参与全局事务的每个连接获取 XAResource。事务管理器使用 start 方法建立全局事务与资源之间的关联，而使用 end 方法取消事务与资源之间的关联。资源管理器负责将全局事务关联到在 start 与 end 方法调用之间对其数据执行的所有工作。

在事务提交时，事务管理器通知资源管理器根据二阶段提交协议准备、提交或回滚事务。

字段摘要

static int	TMENDRSCAN 终止恢复扫描。
static int	TMFAIL 取消关联调用者，并将事务分支标记为只回滚。
static int	TMJOIN 调用者正连接现有事务分支。
static int	TMNOFLAGS 使用 TMNOFLAGS 指示不选择任何标志值。
static int	TMONEPHASE 调用者正在使用一阶段优化。
static int	TMRESUME 调用者正在恢复与挂起的事务分支的关联。
static int	TMSTARTRSCAN 启动恢复扫描。
static int	TMSUCCESS 取消调用者与事务分支的关联。
static int	TMSUSPEND 调用者正挂起（不是终止）其与事务分支的关联。
static int	XA_OK 事务工作正常准备就绪。
static int	XA_RDONLY 事务分支是只读的，并且已提交。

方法摘要

void	commit(Xid xid, boolean onePhase) 提交 xid 指定的全局事务。
void	end(Xid xid, int flags) 终止代表事务分支所执行的工作。
void	forget(Xid xid) 告知资源管理器忽略以启发式完成的事务分支。
int	getTransactionTimeout() 获取为此 XAResource 实例设置的当前事务超时值。
boolean	isSameRM(XAResource xares) 调用此方法，以确定目标对象表示的资源管理器实例是否与参数 xares 表示的资源管理器实例相同。
int	prepare(Xid xid) 请求资源管理器准备好 xid 中指定的事务的事务提交工作。
Xid[]	recover(int flag) 从资源管理器获取准备的事务分支的列表。
void	rollback(Xid xid) 通知资源管理器回滚代表事务分支执行的工作。
boolean	setTransactionTimeout(int seconds) 为此 XAResource 实例设置当前事务超时值。
void	start(Xid xid, int flags) 代表 xid 中指定的事务分支开始工作。

字段详细信息

TMENDRSCAN

static final int TMENDRSCAN

终止恢复扫描。

另请参见：

常量字段值

TMFAIL

static final int TMFAIL

取消关联调用者，并将事务分支标记为只回滚。

另请参见：

常量字段值

TMJOIN

static final int TMJOIN

调用者正连接现有事务分支。

另请参见：

常量字段值

TMNOFLAGS

static final int TMNOFLAGS

使用 TMNOFLAGS 指示不选择任何标志值。

另请参见：

常量字段值

TMONEPHASE

static final int TMONEPHASE

调用者正在使用一阶段优化。

另请参见：

常量字段值

TMRESUME

static final int TMRESUME

调用者正在恢复与挂起的事务分支的关联。

另请参见：

常量字段值

TMSTARTRSCAN

static final int TMSTARTRSCAN

启动恢复扫描。

另请参见：

常量字段值

TMSUCCESS

static final int TMSUCCESS

取消调用者与事务分支的关联。

另请参见：

常量字段值

TMSUSPEND

static final int TMSUSPEND

调用者正挂起（不是终止）其与事务分支的关联。

另请参见：

常量字段值

XA_RDONLY

static final int XA_RDONLY

事务分支是只读的，并且已提交。

另请参见：

常量字段值

XA_OK

static final int XA_OK

事务工作正常准备就绪。

另请参见：

常量字段值

方法详细信息

commit

void commit(Xid xid,
            boolean onePhase)
            throws XAException

提交 xid 指定的全局事务。

参数：

xid - 全局事务标识符

onePhase - 如果为 true，则资源管理器应使用单阶段提交协议提交代表 xid 执行的工作。

抛出：

XAException - 发生错误。可能的 XAExceptions 为 XA_HEURHAZ、XA_HEURCOM、XA_HEURRB、XA_HEURMIX、XAER_RMERR、XAER_RMFAIL、XAER_NOTA、XAER_INVAL 或 XAER_PROTO。

如果资源管理器不提交事务，并且将参数 onePhase 设置为 true，则资源管理器可能抛出 XA_RB* 异常之一。返回时，资源管理器已经回滚分支的工作，并且已经释放所有占用的资源。

end

void end(Xid xid,
         int flags)
         throws XAException

终止代表事务分支所执行的工作。资源管理器取消 XA 资源与指定的事务分支的关联，并使事务完成。

如果在标志中指定 TMSUSPEND，则事务分支将以未完成状态中暂时挂起。事务上下文处于挂起状态，必须通过 start 方法且将标志指定为 TMRESUME 来恢复。

如果指定 TMFAIL，则部分工作将失败。资源管理器可以将事务标记为只回滚

如果指定 TMSUCCESS，则将完成部分工作。

参数：

xid - 全局事务标识符，它与以前在 start 方法中使用的标识符相同。

flags - TMSUCCESS、TMFAIL 或 TMSUSPEND 之一。

抛出：

XAException - 发生错误。可能的 XAException 值为 XAER_RMERR、XAER_RMFAILED、XAER_NOTA、XAER_INVAL、XAER_PROTO 或 XA_RB*。

forget

void forget(Xid xid)
            throws XAException

告知资源管理器忽略以启发式完成的事务分支。

参数：

xid - 全局事务标识符

抛出：

XAException - 发生错误。可能的异常值为 XAER_RMERR、XAER_RMFAIL、XAER_NOTA、XAER_INVAL 或 XAER_PROTO。

getTransactionTimeout

int getTransactionTimeout()
                          throws XAException

获取为此 XAResource 实例设置的当前事务超时值。如果在调用此方法之前不使用 XAResource.setTransactionTimeout，则返回值是资源管理器的默认超时集；否则，返回在以前 setTransactionTimeout 调用中使用的值。

返回：

以秒为单位的事务超时值。

抛出：

XAException - 发生错误。可能的异常值为 XAER_RMERR 和 XAER_RMFAIL。

isSameRM

boolean isSameRM(XAResource xares)
                 throws XAException

调用此方法，以确定目标对象表示的资源管理器实例是否与参数 xares 表示的资源管理器实例相同。

参数：

xares - 其资源管理器实例将与目标对象的资源管理器实例进行比较的 XAResource 对象。

返回：

如果是相同的 RM 实例，则返回 true；否则返回 false。

抛出：

XAException - 发生错误。可能的异常值为 XAER_RMERR 和 XAER_RMFAIL。

prepare

int prepare(Xid xid)
            throws XAException

请求资源管理器准备好 xid 中指定的事务的事务提交工作。

参数：

xid - 全局事务标识符

返回：

一个值，它指示资源管理器对事务结果的表决。可能的值为：XA_RDONLY 或 XA_OK。如果资源管理器要回滚事务，则应通过 prepare 方法中引发相应的 XAException 来实现此操作。

抛出：

XAException - 发生错误。可能的异常值为：XA_RB*、XAER_RMERR、XAER_RMFAIL、XAER_NOTA、XAER_INVAL 或 XAER_PROTO。

recover

Xid[] recover(int flag)
              throws XAException

从资源管理器获取准备的事务分支的列表。恢复过程中，事务管理器调用此方法以获取当前处于准备或以启发式完成的状态的事务分支列表。

参数：

flag - TMSTARTRSCAN、MENDRSCAN、MNOFLAGS 之一。参数中没有设置任何其他标志时，必须使用 MNOFLAGS。

返回：

资源管理器返回当前处于准备或以启发式完成的状态的事务分支的零或多个 XID。如果在操作过程中发生错误，则资源管理器应抛出适当的 XAException。

抛出：

XAException - 发生错误。可能的值为 XAER_RMERR、XAER_RMFAIL、XAER_INVAL 和 XAER_PROTO。

rollback

void rollback(Xid xid)
              throws XAException

通知资源管理器回滚代表事务分支执行的工作。

参数：

xid - 全局事务标识符

抛出：

XAException - 发生错误。

setTransactionTimeout

boolean setTransactionTimeout(int seconds)
                              throws XAException

为此 XAResource 实例设置当前事务超时值。设置后，在使用其他值再次调用 setTransactionTimeout 之前，此超时值是有效的。要将超时值重设为资源管理器使用的默认值，请将该值设置为零。 如果执行超时操作成功，则方法返回 true；否则返回 false。如果资源管理器不支持显式设置事务超时值，则此方法返回 false。

参数：

seconds - 以秒为单位的事务超时值。

返回：

如果成功设置事务超时值，则返回 true；否则返回 false。

抛出：

XAException - 发生错误。可能的异常值为 XAER_RMERR、XAER_RMFAIL 或 XAER_INVAL。

start

void start(Xid xid,
           int flags)
           throws XAException

代表 xid 中指定的事务分支开始工作。 如果指定 TMJOIN，则该启动适用于连接资源管理器以前看到的事务。如果指定 TMRESUME，该启动适用于恢复参数 xid 中指定的挂起事务。 如果 TMJOIN 和 TMRESUME 都没有指定，并且资源管理器以前查看到 xid 指定的事务，则资源管理器抛出带有 XAER_DUPID 错误代码的 XAException 异常。

参数：

xid - 与资源关联的全局事务标识符。

flags - TMNOFLAGS、TMJOIN 或 TMRESUME 之一。

抛出：

XAException - 发生错误。可能的异常为 XA_RB*、XAER_RMERR、XAER_RMFAIL、XAER_DUPID、XAER_OUTSIDE、XAER_NOTA、XAER_INVAL 或 XAER_PROTO。