javax.jms.XAConnection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jboss-jms-api_1.1_spec Show documentation

The Java Messaging Service 1.1 API classes

The newest version!

package javax.jms;

/** The XAConnection interface extends the capability of 
 * Connection by providing an XASession (optional).
 *
 *The XAConnection 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. 
 *
 * @see         javax.jms.XAQueueConnection
 * @see         javax.jms.XATopicConnection
 */

public interface XAConnection extends Connection
{

   /** Creates an XASession object.
    *  
    * @return a newly created XASession
    *  
    * @exception JMSException if the XAConnection object 
    *                         fails to create an XASession due to
    *                         some internal error.
    *
    * @since 1.1
    */
   public XASession createXASession() throws JMSException;

   /** Creates an Session object.
    *
    * @param transacted       usage undefined
    * @param acknowledgeMode  usage undefined
    *  
    * @return a Session object
    *  
    * @exception JMSException if the XAConnection object 
    *                         fails to create an Session due to
    *                         some internal error.
    *
    * @since 1.1
    */
   public Session createSession(boolean transacted, int acknowledgeMode) throws JMSException;
}