org.apache.geronimo.transaction.manager

Class WrapperNamedXAResource

java.lang.Object

org.apache.geronimo.transaction.manager.WrapperNamedXAResource

All Implemented Interfaces:

XAResource, NamedXAResource

public class WrapperNamedXAResource
extends Object
implements NamedXAResource

Field Summary

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

Constructors

Constructor and Description
WrapperNamedXAResource(XAResource xaResource, String name)

Method Summary

Modifier and Type	Method and Description
void	commit(Xid xid, boolean onePhase) Commits the global transaction specified by xid.
void	end(Xid xid, int flags) Ends the work performed on behalf of a transaction branch.
void	forget(Xid xid) Tells the resource manager to forget about a heuristically completed transaction branch.
String	getName()
int	getTransactionTimeout() Obtains the current transaction timeout value set for this XAResource instance.
boolean	isSameRM(XAResource other) This method is called to determine if the resource manager instance represented by the target object is the same as the resouce manager instance represented by the parameter xares.
int	prepare(Xid xid) Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.
Xid[]	recover(int flag) Obtains a list of prepared transaction branches from a resource manager.
void	rollback(Xid xid) Informs the resource manager to roll back work done on behalf of a transaction branch.
boolean	setTransactionTimeout(int seconds) Sets the current transaction timeout value for this XAResource instance.
void	start(Xid xid, int flags) Starts work on behalf of a transaction branch specified in xid.

Methods inherited from class java.lang.Object

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

Constructor Detail

WrapperNamedXAResource

public WrapperNamedXAResource(XAResource xaResource,
                              String name)

Method Detail

getName

public String getName()

Specified by:

getName in interface NamedXAResource

commit

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

Description copied from interface: javax.transaction.xa.XAResource

Commits the global transaction specified by xid.

Specified by:

commit in interface XAResource

Parameters:

xid - A global transaction identifier

onePhase - If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid.

Throws:

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.

end

public void end(Xid xid,
                int flags)
         throws XAException

Description copied from interface: javax.transaction.xa.XAResource

Ends the work performed on behalf of a transaction branch. The resource manager disassociates the XA resource from the transaction branch specified and lets the transaction complete.

If TMSUSPEND is specified in the flags, the transaction branch is temporarily suspended in an incomplete state. The transaction context is in a suspended state and must be resumed via the start method with TMRESUME specified.

If TMFAIL is specified, the portion of work has failed. The resource manager may mark the transaction as rollback-only

If TMSUCCESS is specified, the portion of work has completed successfully.

Specified by:

end in interface XAResource

Parameters:

xid - A global transaction identifier that is the same as the identifier used previously in the start method.

flags - One of TMSUCCESS, TMFAIL, or TMSUSPEND.

Throws:

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

forget

public void forget(Xid xid)
            throws XAException

Description copied from interface: javax.transaction.xa.XAResource

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

Specified by:

forget in interface XAResource

Parameters:

xid - A global transaction identifier.

Throws:

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

getTransactionTimeout

public int getTransactionTimeout()
                          throws XAException

Description copied from interface: javax.transaction.xa.XAResource

Obtains the current transaction timeout value set for this XAResource instance. If XAResource.setTransactionTimeout was not used prior to invoking this method, the return value is the default timeout set for the resource manager; otherwise, the value used in the previous setTransactionTimeout call is returned.

Specified by:

getTransactionTimeout in interface XAResource

Returns:

the transaction timeout value in seconds.

Throws:

XAException - An error has occurred. Possible exception values are XAER_RMERR and XAER_RMFAIL.

isSameRM

public boolean isSameRM(XAResource other)
                 throws XAException

Description copied from interface: javax.transaction.xa.XAResource

This method is called to determine if the resource manager instance represented by the target object is the same as the resouce manager instance represented by the parameter xares.

Specified by:

isSameRM in interface XAResource

Parameters:

other - An XAResource object whose resource manager instance is to be compared with the resource manager instance of the target object.

Returns:

true if it's the same RM instance; otherwise false.

Throws:

XAException - An error has occurred. Possible exception values are XAER_RMERR and XAER_RMFAIL.

prepare

public int prepare(Xid xid)
            throws XAException

Description copied from interface: javax.transaction.xa.XAResource

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

Specified by:

prepare in interface XAResource

Parameters:

xid - A global transaction identifier.

Returns:

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

Throws:

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

recover

public Xid[] recover(int flag)
              throws XAException

Description copied from interface: javax.transaction.xa.XAResource

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.

Specified by:

recover in interface XAResource

Parameters:

flag - One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in the parameter.

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.

Throws:

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

rollback

public void rollback(Xid xid)
              throws XAException

Description copied from interface: javax.transaction.xa.XAResource

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

Specified by:

rollback in interface XAResource

Parameters:

xid - A global transaction identifier.

Throws:

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.

setTransactionTimeout

public boolean setTransactionTimeout(int seconds)
                              throws XAException

Description copied from interface: javax.transaction.xa.XAResource

Sets the current transaction timeout value for this XAResource instance. Once set, this timeout value is effective until setTransactionTimeout is invoked again with a different value. To reset the timeout value to the default value used by the resource manager, set the value to zero. If the timeout operation is performed successfully, the method returns true; otherwise false. If a resource manager does not support explicitly setting the transaction timeout value, this method returns false.

Specified by:

setTransactionTimeout in interface XAResource

Parameters:

seconds - The transaction timeout value in seconds.

Returns:

true if the transaction timeout value is set successfully; otherwise false.

Throws:

XAException - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.

start

public void start(Xid xid,
                  int flags)
           throws XAException

Description copied from interface: javax.transaction.xa.XAResource

Starts work on behalf of a transaction branch specified in xid. If TMJOIN is specified, the start applies to joining a transaction previously seen by the resource manager. If TMRESUME is specified, the start applies to resuming a suspended transaction specified in the parameter xid. If neither TMJOIN nor TMRESUME is specified and the transaction specified by xid has previously been seen by the resource manager, the resource manager throws the XAException exception with XAER_DUPID error code.

Specified by:

start in interface XAResource

Parameters:

xid - A global transaction identifier to be associated with the resource.

flags - One of TMNOFLAGS, TMJOIN, or TMRESUME.

Throws:

XAException - An error has occurred. Possible exceptions are XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_DUPID, XAER_OUTSIDE, XAER_NOTA, XAER_INVAL, or XAER_PROTO.