XASession

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.jms
Interface XASession

All Superinterfaces:: java.lang.Runnable, Session (src)

All Known Subinterfaces:: XAQueueSession (src) , XATopicSession (src)

All Known Implementing Classes:: JBossSession (src) , SpyQueueSession (src) , SpySession (src) , SpyTopicSession (src)

public interface XASession
extends Session (src)

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.

See Also:: Session (src)

Field Summary

Fields inherited from interface javax.jms.Session (src)

AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED

Method Summary
`void`	`commit()` Throws a `TransactionInProgressException`, since it should not be called for an `XASession` object.
`Session (src)`	`getSession()` Gets the session associated with this `XASession`.
`boolean`	`getTransacted()` Indicates whether the session is in transacted mode.
`XAResource (src)`	`getXAResource()` Returns an XA resource to the caller.
`void`	`rollback()` Throws a `TransactionInProgressException`, since it should not be called for an `XASession` object.

Methods inherited from interface javax.jms.Session (src)

close, createBrowser, createBrowser, createBytesMessage, createConsumer, createConsumer, createConsumer, createDurableSubscriber, createDurableSubscriber, createMapMessage, createMessage, createObjectMessage, createObjectMessage, createProducer, createQueue, createStreamMessage, createTemporaryQueue, createTemporaryTopic, createTextMessage, createTextMessage, createTopic, getAcknowledgeMode, getMessageListener, recover, run, setMessageListener, unsubscribe

Method Detail

getSession

public Session (src)  getSession()
                   throws JMSException (src)

Gets the session associated with this XASession.

Returns:: the session object
Throws:: JMSException (src) - if an internal error occurs.
Since:: 1.1

getXAResource

public XAResource (src)  getXAResource()

Returns an XA resource to the caller.

Returns:: an XA resource to the caller

getTransacted

public boolean getTransacted()
                      throws JMSException (src)

Indicates whether the session is in transacted mode.

Specified by:: getTransacted in interface Session (src)

Returns:: true
Throws:: JMSException (src) - if the JMS provider fails to return the transaction mode due to some internal error.

commit

public void commit()
            throws JMSException (src)

Throws a TransactionInProgressException, since it should not be called for an XASession object.

Specified by:: commit in interface Session (src)

Throws:: TransactionInProgressException (src) - if the method is called on an XASession.; JMSException (src) - if the JMS provider fails to commit the transaction due to some internal error.

rollback

public void rollback()
              throws JMSException (src)