File Doc Category Size Date Package
XAConnectionFactory.java API Doc Glassfish v2 API 5065 Fri May 04 22:36:16 BST 2007 javax.jms

XAConnectionFactory

public interface XAConnectionFactory

The XAConnectionFactory interface is a base interface for the XAQueueConnectionFactory and XATopicConnectionFactory interfaces.

Some application servers provide support for grouping JTS capable resource use into a distributed transaction (optional). To include JMS API transactions in a JTS transaction, an application server requires a JTS aware JMS provider. A JMS provider exposes its JTS support using an XAConnectionFactory object, which an application server uses to create XAConnection objects.

XAConnectionFactory objects are JMS administered objects, just like ConnectionFactory objects. It is expected that application servers will find them using the Java Naming and Directory Interface (JNDI) API.

The XAConnectionFactory 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 April 4, 2002
author: Mark Hapner
author: Rich Burridge
author: Kate Stout
see: javax.jms.XAQueueConnectionFactory
see: javax.jms.XATopicConnectionFactory

Fields Summary
Constructors Summary
Methods Summary
public XAConnection createXAConnection()
Creates an XAConnection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
return
a newly created XAConnection
exception
JMSException if the JMS provider fails to create an XA connection due to some internal error.
exception
JMSSecurityException if client authentication fails due to an invalid user name or password.
since
1.1
public XAConnection createXAConnection(java.lang.String userName, java.lang.String password)
Creates an XA connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.
param
userName the caller's user name
param
password the caller's password
return
a newly created XA connection
exception
JMSException if the JMS provider fails to create an XA connection due to some internal error.
exception
JMSSecurityException if client authentication fails due to an invalid user name or password.
since
1.1