javax.jms.XAConnection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ow2-jms-2.0-spec Show documentation

The Java Message Service (JMS) API, version 2.0

The newest version!

/**
 * Copyright 2013 ScalAgent Distributed Technologies
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  ---------------------------------------------------------------------
 *  $Id: XAConnection.java 6347 2013-03-13 08:52:02Z tachker $
 *  ---------------------------------------------------------------------
 */

package javax.jms;

/**
 * The {@code XAConnection} interface extends the ability of {@code Connection}
 * by providing an {@code XASession} (optional).
 * 
 * 
 * @see javax.jms.XAQueueConnection
 * @see javax.jms.XATopicConnection
 * 
 * @version JMS 2.0
 * @since JMS 1.0
 * 
 */

public interface XAConnection extends Connection {

  /**
   * Creates an {@code XASession} object.
   * 
   * @return a newly created {@code XASession}
   * 
   * @exception JMSException
   *              if the {@code XAConnection} object fails to create an
   *              {@code XASession} due to some internal error.
   * 
   * @since JMS 1.1
   * 
   */

  XASession createXASession() throws JMSException;

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