Top Description Fields Methods
javax.jms

public Interface XAJMSContext

extends JMSContext
Imports
javax.transaction.xa.XAResource

The XAJMSContext interface extends the capability of JMSContext 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 an ordinary JMSContext. Behind the scenes, the application server controls the transaction management of the underlying XAJMSContext.

The XAJMSContext 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.

Since
JMS 2.0
Version
JMS 2.0

Field Summary

Inherited from javax.jms.JMSContext:
AUTO_ACKNOWLEDGECLIENT_ACKNOWLEDGEDUPS_OK_ACKNOWLEDGESESSION_TRANSACTED

Method Summary

Modifier and TypeMethod and Description
public void
commit()

Redeclares javax.jms.JMSContext.commit.

Throws a TransactionInProgressRuntimeException, since it should not be called for an XAJMSContext object.
public JMSContext

Returns:

the JMSContext object associated with this XAJMSContext
getContext
()

Returns the JMSContext object associated with this XAJMSContext.

public boolean

Returns:

true
getTransacted
()

Redeclares javax.jms.JMSContext.getTransacted.

Returns whether the session is in transacted mode; this method always returns true.
public XAResource

Returns:

an XAResource
getXAResource
()

Returns an XAResource to the caller.

public void
rollback()

Redeclares javax.jms.JMSContext.rollback.

Throws a TransactionInProgressRuntimeException, since it should not be called for an XAJMSContext object.
Inherited from javax.jms.JMSContext:
acknowledgeclosecreateBrowsercreateBrowsercreateBytesMessagecreateConsumercreateConsumercreateConsumercreateContextcreateDurableConsumercreateDurableConsumercreateMapMessagecreateMessagecreateObjectMessagecreateObjectMessagecreateProducercreateQueuecreateSharedConsumercreateSharedConsumercreateSharedDurableConsumercreateSharedDurableConsumercreateStreamMessagecreateTemporaryQueuecreateTemporaryTopiccreateTextMessagecreateTextMessagecreateTopicgetAutoStartgetClientIDgetExceptionListenergetMetaDatagetSessionModerecoversetAutoStartsetClientIDsetExceptionListenerstartstopunsubscribe

Method Detail

commitback to summary
public void commit()

Redeclares javax.jms.JMSContext.commit.

Throws a TransactionInProgressRuntimeException, since it should not be called for an XAJMSContext object.

Annotations
@Override
Exceptions
TransactionInProgressRuntimeException:
if the method is called on an XAJMSContext.
getContextback to summary
public JMSContext getContext()

Returns the JMSContext object associated with this XAJMSContext.

Returns:JMSContext

the JMSContext object associated with this XAJMSContext

getTransactedback to summary
public boolean getTransacted()

Redeclares javax.jms.JMSContext.getTransacted.

Returns whether the session is in transacted mode; this method always returns true.

Returns:boolean

true

Annotations
@Override
getXAResourceback to summary
public XAResource getXAResource()

Returns an XAResource to the caller.

Returns:XAResource

an XAResource

rollbackback to summary
public void rollback()

Redeclares javax.jms.JMSContext.rollback.

Throws a TransactionInProgressRuntimeException, since it should not be called for an XAJMSContext object.

Annotations
@Override
Exceptions
TransactionInProgressRuntimeException:
if the method is called on an XAJMSContext.