Package org.objectweb.joram.client.jms

Class XAResource

java.lang.Object

org.objectweb.joram.client.jms.XAResource

All Implemented Interfaces:

XAResource

public class XAResource
extends Object
implements XAResource

A XAResource instance is used by a XASession instance as a delegate to a Transaction Manager.

Field Summary

Fields

Modifier and Type	Field	Description
private Xid	currentXid	The current transaction identifier.
private boolean	enlisted	true if the resource is enlisted in a transaction.
private static org.objectweb.util.monolog.api.Logger	logger
(package private) XAResourceMngr	rm	The XA connection acting as resource manager.
(package private) Session	sess	The session producing and consuming messages.

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	Description
XAResource(XAResourceMngr rm, Session sess)	Constructs an XA resource representing a given session.

Method Summary

Modifier and Type	Method	Description
void	commit(Xid xid, boolean onePhase)	Commits the resource.
void	end(Xid xid, int flag)	Delists this resource.
void	forget(Xid xid)	Not implemented as transactions are not heuristically completed.
int	getTransactionTimeout()	Returns 0 as timeout feature is not supported.
boolean	isSameRM(XAResource o)	Checks if this resource shares the same resource manager (XAConnection) with an other resource.
int	prepare(Xid xid)	Prepares the resource.
Xid[]	recover(int flag)	Recovers the prepared transactions identifiers.
void	rollback(Xid xid)	Rolls the resource back.
boolean	setTransactionTimeout(int seconds)	Returns false as timeout feature is not supported.
void	start(Xid xid, int flag)	Enlists this resource in a given transaction.

Methods inherited from class java.lang.Object

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

Field Detail

enlisted

private boolean enlisted

true if the resource is enlisted in a transaction.

currentXid

private Xid currentXid

The current transaction identifier.

rm

XAResourceMngr rm

The XA connection acting as resource manager.

sess

Session sess

The session producing and consuming messages.

logger

private static org.objectweb.util.monolog.api.Logger logger

Constructor Detail

XAResource

public XAResource(XAResourceMngr rm,
                  Session sess)

Constructs an XA resource representing a given session.

Method Detail

start

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

Enlists this resource in a given transaction.

Specified by:

start in interface XAResource

Throws:

XAException - If the resource is already enlisted in a transaction, or if the RM fails to enlist the resource.

end

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

Delists this resource.

Specified by:

end in interface XAResource

Throws:

XAException - If the resource is not enlisted in the specified transaction, or if the RM fails to delist the resource.

prepare

public int prepare(Xid xid)
            throws XAException

Prepares the resource.

Specified by:

prepare in interface XAResource

Throws:

XAException - If the RM fails to prepare the resource.

commit

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

Commits the resource.

Specified by:

commit in interface XAResource

Throws:

XAException - If the RM fails to commit the resource.

rollback

public void rollback(Xid xid)
              throws XAException

Rolls the resource back.

Specified by:

rollback in interface XAResource

Throws:

XAException - If the RM fails to roll the resource back.

recover

public Xid[] recover(int flag)
              throws XAException

Recovers the prepared transactions identifiers.

Specified by:

recover in interface XAResource

Throws:

XAException - If the RM fails to recover.

forget

public void forget(Xid xid)
            throws XAException

Not implemented as transactions are not heuristically completed.

Specified by:

forget in interface XAResource

Throws:

XAException - Always thrown.

setTransactionTimeout

public boolean setTransactionTimeout(int seconds)
                              throws XAException

Returns false as timeout feature is not supported.

Specified by:

setTransactionTimeout in interface XAResource

Throws:

XAException - Never thrown.

getTransactionTimeout

public int getTransactionTimeout()
                          throws XAException

Returns 0 as timeout feature is not supported.

Specified by:

getTransactionTimeout in interface XAResource

Throws:

XAException - Never thrown.

isSameRM

public boolean isSameRM(XAResource o)
                 throws XAException

Checks if this resource shares the same resource manager (XAConnection) with an other resource.

Specified by:

isSameRM in interface XAResource

Throws:

XAException - Never thrown.