org.exolab.jms.client
Class JmsXAConnectionFactory

java.lang.Object
  |
  +--org.exolab.jms.client.JmsConnectionFactory
        |
        +--org.exolab.jms.client.JmsXAConnectionFactory

All Implemented Interfaces:

javax.jms.ConnectionFactory, javax.jms.ExceptionListener, java.io.Externalizable, javax.jms.QueueConnectionFactory, javax.naming.Referenceable, java.io.Serializable, javax.jms.TopicConnectionFactory, javax.jms.XAConnectionFactory, javax.jms.XAQueueConnectionFactory, javax.jms.XATopicConnectionFactory

public class JmsXAConnectionFactory

extends JmsConnectionFactory

implements javax.jms.XAConnectionFactory, javax.jms.XAQueueConnectionFactory, javax.jms.XATopicConnectionFactory

Client implementation of the javax.jms.XAConnectionFactory interface.

Version:

$Revision: 1.1 $ $Date: 2005/03/18 03:36:37 $

Author:

Jim Alateras, Tim Anderson

See Also:

Serialized Form

Constructor Summary

JmsXAConnectionFactory()
Default constructor required for serialization.

JmsXAConnectionFactory(java.lang.String className, java.util.Map properties)
Construct a new JmsXAConnectionFactory.

JmsXAConnectionFactory(java.lang.String className, java.util.Map properties, java.util.Map environment)
Construct a new JmsXAConnectionFactory.

Method Summary

javax.jms.XAConnection	createXAConnection() Creates an XA connection with the default user identity.
javax.jms.XAConnection	createXAConnection(java.lang.String userName, java.lang.String password) Creates an XA connection with the specified user identity.
javax.jms.XAQueueConnection	createXAQueueConnection() Creates an XA queue connection with the default user identity.
javax.jms.XAQueueConnection	createXAQueueConnection(java.lang.String userName, java.lang.String password) Creates an XA queue connection with the specified user identity.
javax.jms.XATopicConnection	createXATopicConnection() Creates an XA topic connection with the default user identity.
javax.jms.XATopicConnection	createXATopicConnection(java.lang.String userName, java.lang.String password) Creates an XA topic connection with the specified user identity.

Methods inherited from class org.exolab.jms.client.JmsConnectionFactory

addConnection, createConnection, createConnection, createQueueConnection, createQueueConnection, createTopicConnection, createTopicConnection, getConnections, getProxy, getReference, onException, readExternal, removeConnection, writeExternal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.jms.QueueConnectionFactory

createQueueConnection, createQueueConnection

Methods inherited from interface javax.jms.ConnectionFactory

createConnection, createConnection

Methods inherited from interface javax.jms.TopicConnectionFactory

createTopicConnection, createTopicConnection

Constructor Detail

JmsXAConnectionFactory

public JmsXAConnectionFactory()

Default constructor required for serialization.

JmsXAConnectionFactory

public JmsXAConnectionFactory(java.lang.String className,
                              java.util.Map properties)

Construct a new JmsXAConnectionFactory.

Parameters:

className - the server proxy class name

properties - properties to initialise the server proxy with proxy. May be null

JmsXAConnectionFactory

public JmsXAConnectionFactory(java.lang.String className,
                              java.util.Map properties,
                              java.util.Map environment)

Construct a new JmsXAConnectionFactory.

Parameters:

className - the server proxy class name

properties - properties to initialise the server proxy with

environment - the environment used in creating the server proxy. May be null

Method Detail

createXAConnection

public javax.jms.XAConnection createXAConnection()
                                          throws javax.jms.JMSException

Creates an XA connection 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.

Specified by:

createXAConnection in interface javax.jms.XAConnectionFactory

Returns:

a newly created XAConnection

Throws:

javax.jms.JMSException - if the JMS provider fails to create an XA connection due to some internal error.

javax.jms.JMSSecurityException - if client authentication fails due to an invalid user name or password.

createXAConnection

public javax.jms.XAConnection createXAConnection(java.lang.String userName,
                                                 java.lang.String password)
                                          throws javax.jms.JMSException

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.

Specified by:

createXAConnection in interface javax.jms.XAConnectionFactory

Parameters:

userName - the caller's user name

password - the caller's password

Returns:

a newly created XA connection

Throws:

javax.jms.JMSException - if the JMS provider fails to create an XA connection due to some internal error.

javax.jms.JMSSecurityException - if client authentication fails due to an invalid user name or password.

createXAQueueConnection

public javax.jms.XAQueueConnection createXAQueueConnection()
                                                    throws javax.jms.JMSException

Creates an XA queue connection 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.

Specified by:

createXAQueueConnection in interface javax.jms.XAQueueConnectionFactory

Returns:

a newly created XA queue connection

Throws:

javax.jms.JMSException - if the JMS provider fails to create an XA queue connection due to some internal error.

javax.jms.JMSSecurityException - if client authentication fails due to an invalid user name or password.

createXAQueueConnection

public javax.jms.XAQueueConnection createXAQueueConnection(java.lang.String userName,
                                                           java.lang.String password)
                                                    throws javax.jms.JMSException

Creates an XA queue 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.

Specified by:

createXAQueueConnection in interface javax.jms.XAQueueConnectionFactory

Parameters:

userName - the caller's user name

password - the caller's password

Returns:

a newly created XA queue connection

Throws:

javax.jms.JMSException - if the JMS provider fails to create an XA queue connection due to some internal error.

javax.jms.JMSSecurityException - if client authentication fails due to an invalid user name or password.

createXATopicConnection

public javax.jms.XATopicConnection createXATopicConnection()
                                                    throws javax.jms.JMSException

Creates an XA topic connection 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.

Specified by:

createXATopicConnection in interface javax.jms.XATopicConnectionFactory

Returns:

a newly created XA topic connection

Throws:

javax.jms.JMSException - if the JMS provider fails to create an XA topic connection due to some internal error.

javax.jms.JMSSecurityException - if client authentication fails due to an invalid user name or password.

createXATopicConnection

public javax.jms.XATopicConnection createXATopicConnection(java.lang.String userName,
                                                           java.lang.String password)
                                                    throws javax.jms.JMSException

Creates an XA topic 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.

Specified by:

createXATopicConnection in interface javax.jms.XATopicConnectionFactory

Parameters:

userName - the caller's user name

password - the caller's password

Returns:

a newly created XA topic connection

Throws:

javax.jms.JMSException - if the JMS provider fails to create an XA topic connection due to some internal error.

javax.jms.JMSSecurityException - if client authentication fails due to an invalid user name or password.