Package jakarta.jms

Interface XAConnection

All Superinterfaces:

AutoCloseable, Connection

All Known Subinterfaces:

XAQueueConnection, XATopicConnection

public interface XAConnection
extends Connection

The XAConnection interface extends the capability of Connection by providing an XASession (optional).

The XAConnection interface is optional. Jakarta Messaging providers are not required to support this interface. This interface is for use by Jakarta Messaging 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 1.0

Version:

Jakarta Messaging 2.0

See Also:

• XAQueueConnection
• XATopicConnection

Method Summary

Modifier and Type	Method	Description
Session	createSession(boolean transacted, int acknowledgeMode)	Creates an Session object.
XASession	createXASession()	Creates an XASession object.

Methods inherited from interface jakarta.jms.Connection

close, createConnectionConsumer, createDurableConnectionConsumer, createSession, createSession, createSharedConnectionConsumer, createSharedDurableConnectionConsumer, getClientID, getExceptionListener, getMetaData, setClientID, setExceptionListener, start, stop

Method Details

createXASession

XASession createXASession()
                   throws JMSException

Creates an XASession object.

Returns:

a newly created XASession

Throws:

JMSException - if the XAConnection object fails to create an XASession due to some internal error.

Since:

JMS 1.1

createSession

Session createSession(boolean transacted,
 int acknowledgeMode)
               throws JMSException

Creates an Session object.

Specified by:

createSession in interface Connection

Parameters:

transacted - usage undefined

acknowledgeMode - usage undefined

Returns:

a newly created Session

Throws:

JMSException - if the XAConnection object fails to create a Session due to some internal error.

Since:

JMS 1.1

See Also:

• Session.AUTO_ACKNOWLEDGE
• Session.CLIENT_ACKNOWLEDGE
• Session.DUPS_OK_ACKNOWLEDGE
• Connection.createSession(int)
• Connection.createSession()