javax.jms.XAConnection Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
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.
*
* @version 1.1 February 2, 2002
* @author Mark Hapner
* @author Rich Burridge
* @author Kate Stout
*
* @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
*/
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
*/
Session
createSession(boolean transacted,
int acknowledgeMode) throws JMSException;
}