javax::jms::XAConnectionFactory Class Reference

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

#include <javax_jms_XAConnectionFactory.h>

Inheritance diagram for javax::jms::XAConnectionFactory:

[legend]Collaboration diagram for javax::jms::XAConnectionFactory:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::javax::jms::XAConnectionFactory >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::XAConnectionFactory > >	array2D
Public Member Functions
virtual ::javax::jms::XAConnection	createXAConnection (const ::java::lang::String &userName, const ::java::lang::String &password,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates an XA connection with the specified user identity.
virtual ::javax::jms::XAConnection	createXAConnection (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates an XAConnection with the default user identity.

---

Detailed Description

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.

Author:

Mark Hapner

Rich Burridge

Kate Stout

---

Member Function Documentation

virtual ::javax::jms::XAConnection javax::jms::XAConnectionFactory::createXAConnection (  const ::java::lang::String &  userName, const ::java::lang::String &  password, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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. Parameters: userName  the caller's user name password  the caller's password p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a newly created XA connection

virtual ::javax::jms::XAConnection javax::jms::XAConnectionFactory::createXAConnection (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a newly created XAConnection

---

The documentation for this class was generated from the following file:

• javax_jms_XAConnectionFactory.h

---