JavaEE API 8.0.1 · javax.resource.spi.XATerminator

Method Summary

Modifier and Type	Method and Description
public void	commit(Xid A global transaction identifier xid, boolean If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid. onePhase) Commits the global transaction specified by xid.
public void	forget(Xid A global transaction identifier. xid) Tells the resource manager to forget about a heuristically completed transaction branch.
public int	Returns: A value indicating the resource manager's vote on the outcome of the transaction. The possible values are: XA_RDONLY or XA_OK. These constants are defined in `javax.transaction.xa.XAResource` interface. If the resource manager wants to roll back the transaction, it should do so by raising an appropriate XAException in the prepare method. prepare(Xid A global transaction identifier. xid) Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.
public Xid[]	Returns: The resource manager returns zero or more XIDs of the transaction branches that are currently in a prepared or heuristically completed state. If an error occurs during the operation, the resource manager should throw the appropriate XAException. recover(int One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in the parameter. These constants are defined in `javax.transaction.xa.XAResource` interface. flag) Obtains a list of prepared transaction branches from a resource manager.
public void	rollback(Xid A global transaction identifier. xid) Informs the resource manager to roll back work done on behalf of a transaction branch.

Method Detail

commit	back to summary
public void commit(Xid xid, boolean onePhase) throws XAException Commits the global transaction specified by xid. Parameters xid:Xid A global transaction identifier onePhase:boolean If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid. Exceptions XAException: An error has occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO. If the resource manager did not commit the transaction and the parameter onePhase is set to true, the resource manager may throw one of the XA_RB* exceptions. Upon return, the resource manager has rolled back the branch's work and has released all held resources.

commit

back to summary

public void commit(Xid xid, boolean onePhase) throws XAException

Commits the global transaction specified by xid.

Parameters

xid:Xid: A global transaction identifier
onePhase:boolean: If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid.

Exceptions

XAException:: An error has occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.
If the resource manager did not commit the transaction and the parameter onePhase is set to true, the resource manager may throw one of the XA_RB* exceptions. Upon return, the resource manager has rolled back the branch's work and has released all held resources.

forget	back to summary
public void forget(Xid xid) throws XAException Tells the resource manager to forget about a heuristically completed transaction branch. Parameters xid:Xid A global transaction identifier. Exceptions XAException: An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

forget

back to summary

public void forget(Xid xid) throws XAException

Tells the resource manager to forget about a heuristically completed transaction branch.

Parameters

xid:Xid: A global transaction identifier.

Exceptions

XAException:: An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

prepare back to summary

prepare	back to summary
public int prepare(Xid xid) throws XAException Ask the resource manager to prepare for a transaction commit of the transaction specified in xid. Parameters xid:Xid A global transaction identifier. Returns:int A value indicating the resource manager's vote on the outcome of the transaction. The possible values are: XA_RDONLY or XA_OK. These constants are defined in `javax.transaction.xa.XAResource` interface. If the resource manager wants to roll back the transaction, it should do so by raising an appropriate XAException in the prepare method. Exceptions XAException: An error has occurred. Possible exception values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

public int prepare(Xid xid) throws XAException

Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.

Parameters

xid:Xid: A global transaction identifier.

Returns:int

A value indicating the resource manager's vote on the outcome of the transaction. The possible values are: XA_RDONLY or XA_OK. These constants are defined in javax.transaction.xa.XAResource interface. If the resource manager wants to roll back the transaction, it should do so by raising an appropriate XAException in the prepare method.

Exceptions

XAException:: An error has occurred. Possible exception values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

recover back to summary

recover	back to summary
public Xid[] recover(int flag) throws XAException Obtains a list of prepared transaction branches from a resource manager. The transaction manager calls this method during recovery to obtain the list of transaction branches that are currently in prepared or heuristically completed states. Parameters flag:int One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in the parameter. These constants are defined in `javax.transaction.xa.XAResource` interface. Returns:Xid[] The resource manager returns zero or more XIDs of the transaction branches that are currently in a prepared or heuristically completed state. If an error occurs during the operation, the resource manager should throw the appropriate XAException. Exceptions XAException: An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.

public Xid[] recover(int flag) throws XAException

Obtains a list of prepared transaction branches from a resource manager. The transaction manager calls this method during recovery to obtain the list of transaction branches that are currently in prepared or heuristically completed states.

Parameters

flag:int: One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in the parameter. These constants are defined in javax.transaction.xa.XAResource interface.

Returns:Xid[]

The resource manager returns zero or more XIDs of the transaction branches that are currently in a prepared or heuristically completed state. If an error occurs during the operation, the resource manager should throw the appropriate XAException.

Exceptions

XAException:: An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.

rollback	back to summary
public void rollback(Xid xid) throws XAException Informs the resource manager to roll back work done on behalf of a transaction branch. Parameters xid:Xid A global transaction identifier. Exceptions XAException: An error has occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO. If the transaction branch is already marked rollback-only the resource manager may throw one of the XA_RB* exceptions. Upon return, the resource manager has rolled back the branch's work and has released all held resources.

rollback

back to summary

public void rollback(Xid xid) throws XAException

Informs the resource manager to roll back work done on behalf of a transaction branch.

Parameters

xid:Xid: A global transaction identifier.

Exceptions

XAException:: An error has occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.
If the transaction branch is already marked rollback-only the resource manager may throw one of the XA_RB* exceptions. Upon return, the resource manager has rolled back the branch's work and has released all held resources.

public Interface XATerminator

Method Summary

Method Detail