FileDocCategorySizeDatePackage
XASession.javaAPI DocGlassfish v2 API5486Fri May 04 22:36:16 BST 2007javax.jms

XASession

public interface XASession implements Session
The XASession interface extends the capability of Session by adding access to a JMS provider's support for the Java Transaction API (JTA) (optional). This support takes the form of a javax.transaction.xa.XAResource object. The functionality of this object closely resembles that defined by the standard X/Open XA Resource interface.

An application server controls the transactional assignment of an XASession by obtaining its XAResource. It uses the XAResource to assign the session to a transaction, prepare and commit work on the transaction, and so on.

An XAResource provides some fairly sophisticated facilities for interleaving work on multiple transactions, recovering a list of transactions in progress, and so on. A JTA aware JMS provider must fully implement this functionality. This could be done by using the services of a database that supports XA, or a JMS provider may choose to implement this functionality from scratch.

A client of the application server is given what it thinks is a regular JMS Session. Behind the scenes, the application server controls the transaction management of the underlying XASession.

The XASession interface is optional. JMS providers are not required to support this interface. This interface is for use by JMS providers to support transactional environments. Client programs are strongly encouraged to use the transactional support available in their environment, rather than use these XA interfaces directly.

version
1.1 February 2, 2002
author
Mark Hapner
author
Rich Burridge
author
Kate Stout
see
javax.jms.Session

Fields Summary
Constructors Summary
Methods Summary
public voidcommit()
Throws a TransactionInProgressException, since it should not be called for an XASession object.

exception
TransactionInProgressException if the method is called on an XASession.

public SessiongetSession()
Gets the session associated with this XASession.

return
the session object
exception
JMSException if an internal error occurs.
since
1.1

public booleangetTransacted()
Indicates whether the session is in transacted mode.

return
true
exception
JMSException if the JMS provider fails to return the transaction mode due to some internal error.

public javax.transaction.xa.XAResourcegetXAResource()
Returns an XA resource to the caller.

return
an XA resource to the caller

public voidrollback()
Throws a TransactionInProgressException, since it should not be called for an XASession object.

exception
TransactionInProgressException if the method is called on an XASession.