01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.jms;
23:
24: /** The <CODE>XAConnection</CODE> interface extends the capability of
25: * <CODE>Connection</CODE> by providing an <CODE>XASession</CODE> (optional).
26: *
27: *<P>The <CODE>XAConnection</CODE> interface is optional. JMS providers
28: * are not required to support this interface. This interface is for
29: * use by JMS providers to support transactional environments.
30: * Client programs are strongly encouraged to use the transactional support
31: * available in their environment, rather than use these XA
32: * interfaces directly.
33: *
34: * @see javax.jms.XAQueueConnection
35: * @see javax.jms.XATopicConnection
36: */
37:
38: public interface XAConnection extends Connection {
39:
40: /** Creates an <CODE>XASession</CODE> object.
41: *
42: * @return a newly created <CODE>XASession</CODE>
43: *
44: * @exception JMSException if the <CODE>XAConnection</CODE> object
45: * fails to create an <CODE>XASession</CODE> due to
46: * some internal error.
47: *
48: * @since 1.1
49: */
50: public XASession createXASession() throws JMSException;
51:
52: /** Creates an <CODE>Session</CODE> object.
53: *
54: * @param transacted usage undefined
55: * @param acknowledgeMode usage undefined
56: *
57: * @return a <CODE>Session</CODE> object
58: *
59: * @exception JMSException if the <CODE>XAConnection</CODE> object
60: * fails to create an <CODE>Session</CODE> due to
61: * some internal error.
62: *
63: * @since 1.1
64: */
65: public Session createSession(boolean transacted, int acknowledgeMode)
66: throws JMSException;
67: }
|